Skip to content

Netflix/atlas-docs

Repository files navigation

Release

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.

Development

Environment Setup

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

MkDocs Custom Plugins

Updating Python Dependencies

./update-dependencies.sh

Updating Atlas Jar

In general, this version should be kept at a release candidate, such as 1.8.0-rc.2, which is updated with new features regularly. Remember to delete locally cached copies of atlas-standalone.jar to force a re-download of the latest release of this snapshot.

  • Produce a new atlas-standalone-$VERSION.jar binary from the Atlas project on your machine.

    git checkout v1.7.5
    make clean
    make one-jar
  • Attach the binary to a defined Atlas release.

  • Update the version specified in config.py.