Skip to content

Commit

Permalink
chore: Add additional reference redirects (#16993)
Browse files Browse the repository at this point in the history
  • Loading branch information
jimid27 authored Feb 5, 2025
1 parent 6bc8e73 commit c1befe0
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
24 changes: 20 additions & 4 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -742,12 +742,20 @@
],
"redirects": [
{
"source": "/reference",
"destination": "https://reference.prefect.io"
"destination": "/v3/api-ref/index",
"source": "/reference"
},
{
"source": "/reference/:slug*",
"destination": "https://reference.prefect.io/:slug*"
"destination": "/v3/api-ref/index/:slug*",
"source": "/reference/:slug*"
},
{
"destination": "/v3/api-ref/index",
"source": "/v3/reference"
},
{
"destination": "/v3/api-ref/index/:slug*",
"source": "/v3/reference/:slug*"
},
{
"destination": "/v3/getting-started/:slug*",
Expand Down Expand Up @@ -809,6 +817,14 @@
"destination": "/v3/develop/settings-and-profiles",
"source": "/v3/manage/settings-and-profiles"
},
{
"destination": "/v3/api-ref/index",
"source": "/latest/reference"
},
{
"destination": "/v3/api-ref/index/:slug*",
"source": "/latest/reference/:slug*"
},
{
"destination": "/v3",
"source": "/latest/guides"
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/api-ref/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Explore Prefect's auto-generated API & SDK reference documentation.

Prefect auto-generates reference documentation for the following components:

- **[Prefect Python SDK](https://prefect-python-sdk-docs.netlify.app/)**: used to build, test, and execute workflows.
- **[Prefect Python SDK](https://reference.prefect.io)**: used to build, test, and execute workflows.
- **[Prefect REST API](/v3/api-ref/rest-api)**: used by workflow clients and the Prefect UI for orchestration and data retrieval.
- Prefect Cloud REST API documentation: <a href="https://app.prefect.cloud/api/docs" target="_blank">https://app.prefect.cloud/api/docs</a>.
- Self-hosted Prefect server [REST API documentation](/v3/api-ref/rest-api/server/). Additionally, if self-hosting a Prefect server instance, you can access REST API documentation at the `/docs` endpoint of your [`PREFECT_API_URL`](/v3/develop/settings-and-profiles/). For example, if you run `prefect server start` with no additional configuration you can find this reference at <a href="http://localhost:4200/docs" target="_blank">http://localhost:4200/docs</a>.

0 comments on commit c1befe0

Please sign in to comment.