# metaflow-docs

**Repository Path**: mirrors_netflix/metaflow-docs

## Basic Information

- **Project Name**: metaflow-docs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2025-09-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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

<img width="174" alt="Screen Shot 2022-03-08 at 12 17 00 PM" src="https://user-images.githubusercontent.com/93726128/157309404-2bf342ff-8149-4155-9ec2-9ae9d6cb9301.png">

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

<img width="940" alt="Screen Shot 2022-03-17 at 11 00 23 AM" src="https://user-images.githubusercontent.com/93726128/158854270-4e30dbc5-77b5-4a46-bc92-a73bef44f927.png">

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`.