Code Monkey home page Code Monkey logo

docs's Introduction

Astronomer Docs

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.

Building docs

  1. Run pip install -r requirements.txt to install Python dependencies in requirements.txt.
  2. Clone the website to your machine to a directory next to this one.
  3. Run python scripts/build_nav.py. This script parses front matter in the markdown files, and the navigation structure defined in nav.json to generate docs_nav.json in the website project.
  4. Push docs changes up to Github.
  5. Push website changes to the preview branch, which will trigger a rebuild to the preview site.
  6. Ensure changes look good, then merge preview into master to rebuild the production site.

docs's People

Contributors

virajmparekh avatar petedejoy avatar paolaperaza avatar ryw avatar ianstanton avatar andrewhharmon avatar benjamingregory avatar kylebebak avatar schnie avatar andriisoldatenko 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.