Repository files navigation

This is the GitHub Pages repository that currently powers rook.io using the Jekyll static site generator.

If you would like to contribute to Rook's documentation, please open a PR on the mainRook repository. Any changes will automatically be mirrored here to be hosted.

You may preview any changes locally by following thetest section below.

The homepage isindex.html in the root.

Docs live in/docs/{ project }/{ version }. Simply copy a directory full of markdown files with front matterand place them in the relevant project / version. After the docs are copied, a build is required for the frontendto pick up the new version for cross linking between versions of the same project.

To run the build you must be running a Docker host. Runmake build which will build a containerwith all required dependencies and then run the script to preprocess the project versions and store them statically.

Simply open a PR and have it merged by a maintainer. The CI will do the rest that is needed to build the changes and push to thegh-pages branch.

To test your changes to the Rook website locally before committing to the Rook repo, you can generate the docs locally and start a local web server.

To generate and view the docs:

# Remove the old master docs and copy your updated docs from your rook reporm -fr docs/rook/mastermkdir docs/rook/mastercp -r ../rook/Documentation/* docs/rook/master/# Start a live-reloading server that serves the docs at [http://0.0.0.0:4000/docs/rook/master](http://0.0.0.0:4000/docs/rook/master). This requires Docker to be installed on your machine.make run

When you are done, revert the changes to this repo:

rm docs/rook/mastergit checkout -- docs/rook/master

To avoid additional pre-processing work, we push a project torook.github.io which recognizes the projectis a Jekyll project and processes the static site after the code is pushed. While this saves us timeprocessing the Jekyll site manually, it does limit our ability to run custom code such as custom Jekyllplugins. Github only allows forpublic popular whitelisted gems.

Improvements in the future may include setting up our own build step to process the static site and test before pushing.

The source code in this repository is licensed under theApache 2.0 license.

The documentation is distributed underCC-BY-4.0.