From 4ef21b1b2cc5a5e031aebe76a9750629e026b09c Mon Sep 17 00:00:00 2001 From: Mitchell Nielsen Date: Fri, 14 Feb 2025 13:50:08 -0600 Subject: [PATCH] Drop /index suffix, use oxford comma Co-authored-by: daniel-prefect --- .github/CONTRIBUTING.md | 2 +- docs/contribute/docs-contribute.mdx | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 008e57934279..c0895b2a659a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,4 +2,4 @@ Thanks for considering contributing to Prefect! -To navigate our codebase with confidence, see our [contribution guidelines](/contribute/index). +To navigate our codebase with confidence, see our [contribution guidelines](/contribute). diff --git a/docs/contribute/docs-contribute.mdx b/docs/contribute/docs-contribute.mdx index a83dd7f79faa..df081fd0da7b 100644 --- a/docs/contribute/docs-contribute.mdx +++ b/docs/contribute/docs-contribute.mdx @@ -39,12 +39,12 @@ Keep in mind the following when writing documentation. ### External references -Prefect resources can be managed in several ways, including through the CLI, UI, Terraform, Helm and API. +Prefect resources can be managed in several ways, including through the CLI, UI, Terraform, Helm, and API. When documenting a resource, consider including external references that describe how to manage the resource in other ways. Snippets are available to provide these references in a consistent format. -For example, the [Deployment documentation](/v3/deploy/index) includes a snippet for the Terraform provider: +For example, the [Deployment documentation](/v3/deploy) includes a snippet for the Terraform provider: ```javascript import { TF } from "/snippets/resource-management/terraform.mdx"