chore(docs): add links to CLI, API, Terraform, and Helm docs #17142
Conversation
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
Adds snippets to reference the options for managing resources. Related to https://linear.app/prefect/project/strengthen-the-connection-between-prefect-terraform-and-api-docs-1da6564ce040/overview
mitchnielsen
commented
Feb 14, 2025
| @@ -0,0 +1,63 @@ | |||
| export const home = { | |||
There was a problem hiding this comment.
Here, we define the links in one place and reuse them when we import the snippets. There may be a way to DRY this file up as well, but I haven't found something that works yet with mdx + URLs.
mitchnielsen
commented
Feb 14, 2025
docs/contribute/docs-contribute.mdx
Outdated
Comment on lines
36
to
56
| ## Considerations | ||
|
|
||
| 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. | ||
|
|
||
| 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: | ||
|
|
||
| ```javascript | ||
| import { TF } from "/snippets/resource-management/terraform.mdx" | ||
| import { deployments } from "/snippets/resource-management/vars.mdx" | ||
|
|
||
| <TF name="deployments" href={deployments.tf} /> | ||
| ``` | ||
|
|
||
| For more information on how to use snippets, see the [Mintlify documentation](https://mintlify.com/docs/reusable-snippets). |
There was a problem hiding this comment.
I added a section here to discuss how to use these snippets. Hopefully this will be a good reminder for future docs so we can keep using these references consistently.
mitchnielsen
commented
Feb 14, 2025
mitchnielsen
commented
Feb 14, 2025
.github/CONTRIBUTING.md
Outdated
| @@ -2,4 +2,4 @@ | |||
|
|
|||
| Thanks for considering contributing to Prefect! | |||
|
|
|||
| To navigate our codebase with confidence, see our [contribution guidelines](https://docs.prefect.io/latest/contributing/overview/). | |||
| To navigate our codebase with confidence, see our [contribution guidelines](/contribute/index). | |||
There was a problem hiding this comment.
Looks like this link was broken.
|
Alrighty, opening up for review. |
mitchnielsen
requested review from
aaazzam,
kevingrismore,
daniel-prefect and
seanpwlms
as code owners
mitchnielsen
requested review from
cicdw,
desertaxle and
zzstoatzz
as code owners
daniel-prefect
requested changes
Feb 14, 2025
Co-authored-by: daniel-prefect <[email protected]>
daniel-prefect
approved these changes
Feb 15, 2025
|
@cicdw @desertaxle @zzstoatzz - looks like I need a review from one of y'all to proceed, thanks in advance 🤝 |
zzstoatzz
approved these changes
Feb 19, 2025
desertaxle
reviewed
Feb 19, 2025
This file is hosted in GitHub, not the docs, so we need the full URL. Co-authored-by: Alex Streed <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to https://linear.app/prefect/project/strengthen-the-connection-between-prefect-terraform-and-api-docs-1da6564ce040/overview
Provides references to the CLI, API, Terraform, and Helm docs where applicable to increase awareness of the options available for managing resources.
Adds snippets for references to each resource to keep things DRY.
Checklist
<link to issue>"mint.json.