contributing.md

Contributing to GitOps Docs

Pre-requisites

• Fork and clone the operate-first/community repo
• Install JupyterBook cli

Adding markdown docs

All markdown files are found within this repository. Add your markdown as needed.

Update _toc.yml by adding the location of your new markdown document to the appropriate chapter/section. Read more about how to structure a _toc.yml here

Follow Build the Docs section below to ensure your markdown appears in the rendered JupyterBook.

Once confirmed, commit your changes, and submit a PR to the community repo.

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

pipenv shell

Now build the Jupyter book

cd docs
jupyter-book build .

The compiled book can be found in the _build folder.