https://github.com/Netflix/metaflow-docs

https://github.com/Netflix/metaflow-docs

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/Netflix/metaflow-docs
• Owner: Netflix
• Created: 2020-03-12T21:43:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-25T18:43:57.000Z (about 2 months ago)
• Last Synced: 2024-07-25T21:03:43.330Z (about 2 months ago)
• Language: JavaScript
• Homepage: metaflow-docs.vercel.app
• Size: 72 MB
• Stars: 27
• Watchers: 188
• Forks: 42
• Open Issues: 19
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Metaflow Documentation

This repository houses the documentation for metaflow, both for Python and R.

## Static documentation

These documents are published using the [docusaurus framework](https://docusaurus.io/).

Updating the documentation is very simple and there are a couple of options on how to do it, depending on what sort of change you are making.

### Easy changes in the browser



Navigate to the page that you want to edit and click on `Edit this Page` which appears at the bottom of the content. An in-browser IDE will appear in your browser where you can edit the `.md` file. Then push those changes to a new branch and create a pull request.

See [Using GitHub in VSCode](https://code.visualstudio.com/docs/editor/github) for more information on how to create branches in the IDE.

### Running the documentation locally for more complex changes

- Clone this repo

- `cd docs`

- `yarn`

- `yarn start`

Any saved changes that you make to the `.md` files in the `docs` directory will automatically be reflected at [the local preview page](http://localhost:3000/docs/).

### PR Previews



If you create a PR, a preview domain will be created where you can view your changes. The link to that preview domain will be shown in the `Conversation` tab of your PR. The preview is published using Vercel.

### Automatic publishing

Any pushes to the `master` branch will automatically publish to [the live documentation pages](https://metaflow.org). The publishing uses GitHub Actions and GitHub pages. You can see the progress of the publish action by going to the `Actions` tab of this repository.

If you forget the site URL, you can go to `Environments` on the right hand side, click on `github-pages` and then click on `View Deployment`.