docs: add comprehensive base job template examples for Kubernetes#20670
Conversation
desertaxle
left a comment
There was a problem hiding this comment.
Thanks for the fantastic examples, @kingsley-123!
Since this guide is already pretty long, could you split these out into their own page under Advanced > Workflow Infrastructure? Something like "Customizing Base Job Templates." They're great and deserve to be easy to find.
|
Thanks for the feedback! That makes sense a dedicated page will make these examples easier to find. I'll create a new page under Advanced > Workflow Infrastructure as you suggested. Should I title it "Customizing Base Job Templates" or would you prefer something more specific like "Customizing Kubernetes Base Job Templates"? I'll have the update ready soon. |
|
@desertaxle The Kubernetes guide now includes a link to this new page, making the examples easier to find while keeping the main guide focused. Ready for another review. Thanks for the feedback! |
desertaxle
left a comment
There was a problem hiding this comment.
@kingsley-123 you'll need to add an entry to this list in docs/docs.json to make sure this new page shows up in the docs.
|
@desertaxle, I've added the entry to |
desertaxle
left a comment
There was a problem hiding this comment.
LGTM! Thanks @kingsley-123!
Summary
This PR adds a new section with comprehensive examples for customizing the Kubernetes base job template, addressing common configuration patterns that users frequently need.
Related to the Helm chart documentation improvements in PrefectHQ/prefect-helm#566.
Changes
Motivation
While working on Helm chart documentation, I identified that users needed more concrete examples of base job template customization. The existing documentation mentioned the advanced tab but didn't provide comprehensive patterns for common use cases.
These examples are based on production Kubernetes deployment patterns and will help users configure their work pools more effectively.
Testing
Validated JSON syntax for all examples.