-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Go through contributing docs (#15120)
Co-authored-by: Jeff Hale <[email protected]>
- Loading branch information
Showing
6 changed files
with
109 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: Contribute to documentation | ||
description: Learn how to contribute to the Prefect docs. | ||
--- | ||
|
||
import fork from '/snippets/fork.mdx' | ||
|
||
|
||
We use [Mintlify](https://mintlify.com/) to host and build the Prefect documentation. | ||
|
||
The main branch of the [prefecthq/prefect](https://github.com/PrefectHQ/prefect) GitHub repository is used to build the Prefect 3.0rc docs at [docs-3.prefect.io](https://docs-3.prefect.io). | ||
|
||
The 2.x docs are hosted at [docs-2.prefect.io](https://docs-2.prefect.io) and built from the 2.x branch of the repository. | ||
|
||
## Fork the repository | ||
|
||
<fork /> | ||
|
||
## Setup your local environment | ||
|
||
Make sure you have a recent version of Node.js installed. | ||
We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage Node.js versions. | ||
|
||
1. Clone this repository. | ||
2. Run `cd docs` to navigate to the docs directory. | ||
3. Run `nvm use node` to use the correct Node.js version. | ||
4. Run `npm i -g mintlify` to install Mintlify. | ||
5. Run `mintlify dev` to start the development server. | ||
|
||
Your docs should now be available at `http://localhost:3000`. | ||
|
||
See the [Mintlify documentation](https://mintlify.com/docs/development) for more information on how install Mintlify, build previews, and use Mintlify's features while writing docs. | ||
|
||
<Info>All documentation is written in `.mdx` files, which are Markdown files that can contain JavaScript and React components. </Info> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
All contributions to Prefect need to start on [a fork of the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). | ||
Once you have successfully forked [the Prefect repo](https://github.com/PrefectHQ/prefect), create a branch with an informative name: | ||
``` | ||
git checkout -b fix-for-issue-NUM | ||
``` | ||
After committing your changes to this branch, you can then open a pull request from your fork that we will review with you. |