https://github.com/andriisoldatenko/docs-1
Astronomer documentation site
https://github.com/andriisoldatenko/docs-1
Last synced: about 2 months ago
JSON representation
Astronomer documentation site
- Host: GitHub
- URL: https://github.com/andriisoldatenko/docs-1
- Owner: andriisoldatenko
- License: other
- Created: 2019-02-11T12:52:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-06T15:38:58.000Z (over 6 years ago)
- Last Synced: 2025-03-26T22:36:13.142Z (2 months ago)
- Language: Python
- Homepage:
- Size: 205 KB
- Stars: 0
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: docs/security-model.md
- Support: docs/support.md
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
README
# Astronomer Platform Docs
To contribute to our documentation, follow the steps below.
1. Clone this repository on your machine.
`git clone https://github.com/astronomer/docs.git`
2. 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).
2. If you wish to change the structure or add content to the nav, head over to our [Website repo](https://github.com/astronomer/website) and clone it on your machine. **Be sure that you have the latest version of the website on your machine before continuing.**
3. Add markdown files for docs and rearrange the `nav.json` file in this repository to adjust the side nav arrangement.
4. From your terminal, run `python3 nav.py`. This will cause that the `docs_nav.json` file in your website directory is up to date with the latest `nav.json` file in your docs directory.
5. Push all docs changes up to Github.
6. 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.
## Building Nav Meta
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`.