GithubHelp home page GithubHelp logo

justm0rph3u5 / atlas-docs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from netflix/atlas-docs

0.0 1.0 0.0 63.71 MB

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

License: Apache License 2.0

Shell 0.88% Python 99.12%

atlas-docs's Introduction

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.

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.

atlas-docs's People

Contributors

brharrington avatar copperlight avatar dependabot[bot] avatar manolama avatar dinomite avatar jimmycasey avatar josephharrington avatar kchristidis avatar lorin avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.