To contribute to our documentation, follow the steps below.
- Clone this repository on your machine.
git clone https://github.com/astronomer/docs.git
-
If you wish to update the docs themselves, edit/add markdown files and push them back up to this repository. Then, rebuild our website via Netlify to view changes on staging/production sites (creds are in 1password).
-
If you wish to change the structure or add content to the nav, head over to our Website repo and clone it on your machine. Be sure that you have the latest version of the website on your machine before continuing.
-
Add markdown files for docs and rearrange the
nav.jsonfile in this repository to adjust the side nav arrangement. -
From your terminal, run
python3 nav.py. This will cause that thedocs_nav.jsonfile in your website directory is up to date with the latestnav.jsonfile in your docs directory. -
Push all docs changes up to Github.
-
Change into your website directory and push all changes up to rebuild preview. Ensure changes look good then merge preview branch into master to rebuild our production site.
Metadata for navigation is built by nav.py. This script parses front matter in the markdown files in the docs directory, and the navigation structure defined in nav.json.
It depends on Python packages in requirements.txt. Run pip install -r requirements.txt to install these deps. Then run python nav.py > ../website/src/layouts/docs_nav.json to build docs_nav.json.