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

[docs] add deep dive on overriding job variables #12033

Merged
merged 23 commits into from
Feb 21, 2024

Conversation

zzstoatzz
Copy link
Contributor

@zzstoatzz zzstoatzz commented Feb 21, 2024

image

Checklist

  • This pull request includes tests or only affects documentation.
  • This pull request includes a label categorizing the change e.g. maintenance, fix, feature, enhancement, docs.

For documentation changes:

  • This pull request includes redirect settings in netlify.toml for files that are removed or renamed.

@zzstoatzz zzstoatzz self-assigned this Feb 21, 2024
@zzstoatzz zzstoatzz requested a review from a team as a code owner February 21, 2024 14:21
@zzstoatzz zzstoatzz added the docs label Feb 21, 2024
Copy link

netlify bot commented Feb 21, 2024

Deploy Preview for prefect-docs-preview ready!

Name Link
🔨 Latest commit a30fce3
🔍 Latest deploy log https://app.netlify.com/sites/prefect-docs-preview/deploys/65d625504430e200082e751f
😎 Deploy Preview https://deploy-preview-12033--prefect-docs-preview.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 configuration.

Copy link
Contributor

@discdiver discdiver 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 info, Nate! Thank you!

I'm wondering whether we should include this in the Work pool and Workers Guide. That guide is already lengthy, but this is pretty short and fewer guides to navigate is nice. However this guide would be discoverable quickly with search. What do you think?

Separating the .deploy and prefect.yaml sections into tabs is probably a good idea. Given the length, that's less of an issue if we keep it as a stand alone guide.

Please add a <div class="terminal> wrapper around the bash code and output for consitency with other pages.

@zzstoatzz
Copy link
Contributor Author

I'm wondering whether we should include this in the Work pool and Workers Guide. That guide is already lengthy, but this is pretty short and fewer guides to navigate is nice. However this guide would be discoverable quickly with search. What do you think?

I intentionally broke this one out because I think the "Deploying Flows to Workers and Work Pools" is already too long.

Please add a <div class="terminal> wrapper around the bash code and output for consitency with other pages.

Will do!

Copy link
Contributor

@billpalombi billpalombi left a comment

Choose a reason for hiding this comment

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

Thank you for adding this! This will address a large set of common questions.

I proposed a few edits for brevity, none of which I feel strongly about.

docs/guides/deployment/overriding-job-variables.md Outdated Show resolved Hide resolved
docs/guides/deployment/overriding-job-variables.md Outdated Show resolved Hide resolved
docs/guides/deployment/overriding-job-variables.md Outdated Show resolved Hide resolved
zzstoatzz and others added 3 commits February 21, 2024 08:51
Co-authored-by: Bill Palombi <bill@prefect.io>
Co-authored-by: Bill Palombi <bill@prefect.io>
Co-authored-by: Bill Palombi <bill@prefect.io>
Copy link
Contributor

@kevingrismore kevingrismore left a comment

Choose a reason for hiding this comment

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

I'll let you keep working and come back for another review later

docs/guides/deployment/overriding-job-variables.md Outdated Show resolved Hide resolved
docs/guides/deployment/overriding-job-variables.md Outdated Show resolved Hide resolved
docs/guides/deployment/overriding-job-variables.md Outdated Show resolved Hide resolved
docs/guides/deployment/overriding-job-variables.md Outdated Show resolved Hide resolved
docs/guides/deployment/overriding-job-variables.md Outdated Show resolved Hide resolved
zzstoatzz and others added 3 commits February 21, 2024 08:56
Co-authored-by: Kevin Grismore <146098880+kevingrismore@users.noreply.github.com>
Co-authored-by: Kevin Grismore <146098880+kevingrismore@users.noreply.github.com>
Co-authored-by: Kevin Grismore <146098880+kevingrismore@users.noreply.github.com>
Co-authored-by: Kevin Grismore <146098880+kevingrismore@users.noreply.github.com>
@@ -0,0 +1,177 @@
# Deeper Dive: Overriding Work Pool Job Variables
Copy link
Contributor

Choose a reason for hiding this comment

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

thoughts on renaming this to "2 Dive 2 Deep"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

😂

@zzstoatzz
Copy link
Contributor Author

@discdiver @billpalombi any other changes you want to see here?

@discdiver
Copy link
Contributor

Thinking about the title on the side bar. What do you think of Job Variable Overrides ? or "Work Pool Job Variable Overrides" to keep it shorter and easier to scan in the side nav?

At the top of the page, can you please add the metadata that looks like this?


description: Installing Prefect and configuring your environment
tags:
- installation
- pip install
- development
- Linux
- Windows
- SQLite
- upgrading
search:
boost: 2

@zzstoatzz
Copy link
Contributor Author

👍🏼

@discdiver updated in 7d7a155

Copy link
Contributor

@discdiver discdiver left a comment

Choose a reason for hiding this comment

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

Sweet!

@zzstoatzz zzstoatzz merged commit ffa2096 into main Feb 21, 2024
7 of 8 checks passed
@zzstoatzz zzstoatzz deleted the docs-override-job-variables branch February 21, 2024 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants