From ac5b84da49d674c32ea9e410acc48b1c993465f0 Mon Sep 17 00:00:00 2001 From: Brendan O'Leary Date: Thu, 27 Feb 2025 14:23:47 -0500 Subject: [PATCH 1/2] Update docs-contribute.mdx The docs contribute page was originally a .md file in the repo itself and references "this repository" so this makes that clear now. --- docs/contribute/docs-contribute.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contribute/docs-contribute.mdx b/docs/contribute/docs-contribute.mdx index df081fd0da7b..320d0073fa47 100644 --- a/docs/contribute/docs-contribute.mdx +++ b/docs/contribute/docs-contribute.mdx @@ -8,7 +8,7 @@ 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.0 docs at [docs-3.prefect.io](https://docs-3.prefect.io). +The main branch of the [prefecthq/prefect](https://github.com/PrefectHQ/prefect) GitHub repository is used to build the Prefect docs at [docs.prefect.io](https://docs.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. @@ -21,7 +21,7 @@ The 2.x docs are hosted at [docs-2.prefect.io](https://docs-2.prefect.io) and bu 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. +1. Clone your fork of the Prefect 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. @@ -53,4 +53,4 @@ import { deployments } from "/snippets/resource-management/vars.mdx" ``` -For more information on how to use snippets, see the [Mintlify documentation](https://mintlify.com/docs/reusable-snippets). \ No newline at end of file +For more information on how to use snippets, see the [Mintlify documentation](https://mintlify.com/docs/reusable-snippets). From 5fca980d8a3975dd6fc51afe8d4462124a296e49 Mon Sep 17 00:00:00 2001 From: Brendan O'Leary Date: Fri, 28 Feb 2025 13:51:40 -0500 Subject: [PATCH 2/2] Update docs/contribute/docs-contribute.mdx Co-authored-by: daniel-prefect --- docs/contribute/docs-contribute.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contribute/docs-contribute.mdx b/docs/contribute/docs-contribute.mdx index 320d0073fa47..5858890b0317 100644 --- a/docs/contribute/docs-contribute.mdx +++ b/docs/contribute/docs-contribute.mdx @@ -21,7 +21,7 @@ The 2.x docs are hosted at [docs-2.prefect.io](https://docs-2.prefect.io) and bu 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 your fork of the Prefect repository. +1. Clone the Prefect 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.