brharrington / atlas-docs

Atlas Documentation Site (https://netflix.github.io/atlas-docs/)

Atlas Docs

Experiment for moving Atlas documentation off of GitHub wiki and unifying with the Spectator documentation. Goals:

• Avoid duplication and confusion about what information should go in Atlas wiki or Spectator docs.
• Provide unified search across both docs.
• Support for extensions to render Atlas graphs and format expressions. Currently this is done by atlas-wiki subproject.
• Fix some of the limitations of GitHub wiki such as page naming and ability to simply link to operators by substituting in the name.
• Make it easier for others to contribute to the docs.

Operations

Development

Setup a virtual environment with the appropriate Python libraries:

./setup-venv.sh
source venv/bin/activate

The following command will build and serve the docs locally on port 8000:

mkdocs serve

See the Atlas Formatting Plugin README for details on using directives in Markdown source.

See the Atlas Link Checker README for details on validating links in MkDocs site output.