-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(docs): add links to CLI, API, Terraform, and Helm docs #17142
Merged
Merged
Changes from 8 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
0a3a414
Add snippets for CLI, UI, Helm, Terraform
mitchnielsen 3865496
Use snippets for Terraform and Helm references
mitchnielsen ee474a0
Replace more references to API docs
mitchnielsen a2fabec
Add references under Automate
mitchnielsen eb8d044
Add concurrency, use plurals for vars
mitchnielsen 24b8628
Update work pools with resource options
mitchnielsen 1fe3100
Add infra-as-code page
mitchnielsen 444215a
Adjust helm snippet
mitchnielsen fe67c4d
Fix order of imports
mitchnielsen 8c79e64
Fix link to contribution docs
mitchnielsen 0e0e9d2
Remove unused UI template
mitchnielsen 17be0ce
Add contributing guide on references
mitchnielsen 220aed6
Merge branch 'main' of github.com:PrefectHQ/prefect into add-links-to…
mitchnielsen 4ef21b1
Drop /index suffix, use oxford comma
mitchnielsen 881b04c
Move infra-as-code page to Manage section
mitchnielsen 46938c7
Add 'combined' template for all 3 resource options.
mitchnielsen cd29fec
Merge branch 'main' into add-links-to-api-docs
mitchnielsen 35c502e
Use full link to contributing docs
mitchnielsen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,3 @@ | ||
export const API = ({ name, href }) => ( | ||
<p>You can manage {name} with the <a href={href}>Prefect API</a>.</p> | ||
); |
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,3 @@ | ||
export const CLI = ({ name, href }) => ( | ||
<p>You can manage {name} with the <a href={href}>Prefect CLI</a>.</p> | ||
); |
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,3 @@ | ||
export const HELM = ({ name, href }) => ( | ||
<p>You can manage {name} with the <a href={href}>Prefect Helm charts</a>.</p> | ||
); |
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,3 @@ | ||
export const TF = ({ name, href }) => ( | ||
<p>You can manage {name} with the <a href={href}>Terraform provider for Prefect</a>.</p> | ||
); |
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 @@ | ||
- In the Prefect UI. |
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,63 @@ | ||
export const home = { | ||
tf: "https://registry.terraform.io/providers/PrefectHQ/prefect/latest/docs/guides/getting-started", | ||
cli: "https://docs.prefect.io/v3/api-ref/cli/index", | ||
api: "https://app.prefect.cloud/api/docs", | ||
helm: "https://github.com/PrefectHQ/prefect-helm/tree/main/charts", | ||
} | ||
|
||
export const deployments = { | ||
cli: "https://docs.prefect.io/v3/api-ref/cli/deployment", | ||
api: "https://app.prefect.cloud/api/docs#tag/Deployments", | ||
tf: "https://registry.terraform.io/providers/PrefectHQ/prefect/latest/docs/resources/deployment", | ||
} | ||
|
||
export const work_pools = { | ||
cli: "https://docs.prefect.io/v3/api-ref/cli/work-pool", | ||
api: "https://app.prefect.cloud/api/docs#tag/Work-Pools", | ||
tf: "https://registry.terraform.io/providers/PrefectHQ/prefect/latest/docs/resources/work_pool", | ||
} | ||
|
||
export const variables = { | ||
cli: "https://docs.prefect.io/v3/api-ref/cli/variable", | ||
api: "https://app.prefect.cloud/api/docs#tag/Variables", | ||
tf: "https://registry.terraform.io/providers/PrefectHQ/prefect/latest/docs/resources/variable", | ||
} | ||
|
||
export const automations = { | ||
cli: "https://docs.prefect.io/v3/api-ref/cli/automation", | ||
api: "https://app.prefect.cloud/api/docs#tag/Automations", | ||
tf: "https://registry.terraform.io/providers/PrefectHQ/prefect/latest/docs/resources/automation", | ||
} | ||
|
||
export const events = { | ||
cli: "https://docs.prefect.io/v3/api-ref/cli/event", | ||
api: "https://app.prefect.cloud/api/docs#tag/Events", | ||
tf: "https://registry.terraform.io/providers/PrefectHQ/prefect/latest/docs/resources/automation", | ||
} | ||
|
||
export const webhooks = { | ||
api: "https://app.prefect.cloud/api/docs#tag/Webhooks", | ||
tf: "https://registry.terraform.io/providers/PrefectHQ/prefect/latest/docs/resources/webhook", | ||
} | ||
|
||
export const blocks = { | ||
cli: "https://docs.prefect.io/v3/api-ref/cli/block", | ||
api: "https://app.prefect.cloud/api/docs#tag/Blocks", | ||
tf: "https://registry.terraform.io/providers/PrefectHQ/prefect/latest/docs/resources/block", | ||
} | ||
|
||
export const global_concurrency = { | ||
cli: "https://docs.prefect.io/v3/api-ref/cli/global-concurrency-limit", | ||
api: "https://app.prefect.cloud/api/docs#tag/Concurrency-Limits-V2", | ||
tf: "https://registry.terraform.io/providers/PrefectHQ/prefect/latest/docs/resources/global_concurrency_limit", | ||
} | ||
|
||
export const task_run_concurrency = { | ||
cli: "https://docs.prefect.io/v3/api-ref/cli/concurrency-limit", | ||
api: "https://app.prefect.cloud/api/docs#tag/Concurrency-Limits", | ||
tf: "https://registry.terraform.io/providers/PrefectHQ/prefect/latest/docs/resources/task_run_concurrency_limit", | ||
} | ||
|
||
export const workers = { | ||
helm: "https://github.com/PrefectHQ/prefect-helm/tree/main/charts/prefect-server", | ||
} |
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.