Skip to content
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

Updated "deployment build options" in Deployment Concepts to include --param and --params #8411

Merged
merged 2 commits into from
Feb 6, 2023

Conversation

NodeJSmith
Copy link
Contributor

@NodeJSmith NodeJSmith commented Feb 5, 2023

The Deployment page of the Concepts docs do not describe the options for including parameter overrides in the prefect deployment build command. I've added --param and --params to the table, with the descriptions copied from the prefect.cli.deployment docs, with minor changes for formatting.

Screenshot of the rendered markdown in the proposed change:
image

This closes #7510

Checklist

  • This pull request references any related issue by including "closes <link to issue>"
    • If no issue exists and your change is not a small fix, please create an issue first.
  • This pull request includes tests or only affects documentation.
  • This pull request includes a label categorizing the change e.g. fix, feature, enhancement

Copied descriptions from prefect.cli.deployment, with minor changes for formatting
@NodeJSmith NodeJSmith requested a review from tpdorsey as a code owner February 5, 2023 17:55
@netlify
Copy link

netlify bot commented Feb 5, 2023

Deploy Preview for prefect-orion ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 8b1ed98
🔍 Latest deploy log https://app.netlify.com/sites/prefect-orion/deploys/63e06786fb6a6000094533eb
😎 Deploy Preview https://deploy-preview-8411--prefect-orion.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Member

@cicdw cicdw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - thank you for taking the time to fix this @NodeJSmith!

Copy link
Contributor

@tpdorsey tpdorsey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great. Thank you. A few minor suggested edits.

docs/concepts/deployments.md Outdated Show resolved Hide resolved
docs/concepts/deployments.md Outdated Show resolved Hide resolved
@tpdorsey tpdorsey merged commit fae890e into PrefectHQ:main Feb 6, 2023
zanieb pushed a commit that referenced this pull request Feb 6, 2023
…--param and --params (#8411)

Co-authored-by: Terrence Dorsey <terrend@mishu.com>
zanieb pushed a commit that referenced this pull request Feb 6, 2023
…--param and --params (#8411)

Co-authored-by: Terrence Dorsey <terrend@mishu.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs missing section on params in prefect deployment build
3 participants