This repo contains Markdown files and scripts used to build Astronomer docs. We are currently on v0.8 of our docs and all changes should be made in the v0.8
folder.
- Run
pip install -r requirements.txt
to install Python dependencies inrequirements.txt
. - Clone the website to your machine to a directory next to this one.
- Run
python scripts/build_nav.py
. This script parses front matter in the markdown files, and the navigation structure defined innav.json
to generatedocs_nav.json
in the website project. - Push
docs
changes up to Github. - Push
website
changes to thepreview
branch, which will trigger a rebuild to the preview site. - Ensure changes look good, then merge
preview
intomaster
to rebuild the production site.