Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 2.3 KB

README.md

File metadata and controls

61 lines (43 loc) · 2.3 KB
Raw

Petals ESB's web site

Build Status License Web site

This repository contains the sources for the web site of Petals ESB, the the open-source Enterprise Service Bus. On every commit, a routine is executed. It generates static HTML files and hosts them on GitHub pages.

Building the Web Site

To build the web site locally, you can use Docker...

cd petalslink.github.io/
docker run --rm \
	--label=jekyll \
	--name=petals-website \
	--volume=$(pwd):/srv/jekyll \
	-it -p 4000:4000 \
	jekyll/jekyll:3.8 jekyll serve

... or you can install Jekyll directly on your machine.
Then, use...

  • bundle exec jekyll serve -w to run a web server locally.
  • bundle exec jekyll build to simply generate static HTML files.
  • sudo bundle install to resolve problems about missing gems or dependencies.

Then, open http://localhost:4000
You will find more information on Github's web site.

Testing the Web Site

Beyond manual tests, we have a program that can verify the correctness of the HTML pages, as well as the validity of all the links (both internal and external). This process is part of the continuous integration.

It is also possible to run it on your local machine.
Make sure to have Jekyll installed or started as a Docker container, as described above. If you run it as a Docker container, open a new terminal and type in...

# Connect into the Jekyll container that runs the web site
docker exec -ti petals-website bash

# Execute the validation program
bundle exec htmlproofer ./_site --only-4xx --check-favicon --check-html --allow-hash-href

If you installed Jekyll directly on your machine, just go to the root of the project, open a terminal and type in...

bundle exec htmlproofer ./_site --only-4xx --check-favicon --check-html --allow-hash-href