Contributing to GitOps Docs
Contributing to GitOps Docs#
Adding markdown docs#
markdown files are found in the
docs/content folder. Add your markdown in the appropriate subfolder.
docs/_toc.yml by adding the location of your new markdown document to the appropriate chapter/section.
Follow Build the Docs section below ensure your markdown appears in the rendered JupyterBook.
Once confirmed, commit your changes, and submit a PR to the
Build the docs#
In the repository you can create a virtual environment with pipenv
pipenv install --dev
After that you can enter the virtual environment
Now build the Jupyter book
cd docs jupyter-book build .
The compiled book can be found in the