Infra: Update Nomad PR template and link #1446
Open
Conversation
This file contains hidden or 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
Contributor
aimeeu
commented
Dec 3, 2025
aimeeu
commented
- Include Runtime label query parm in link to Nomad PR template
- Update Nomad PR template with additional instructions
Contributor
Vercel Previews Deployed
|
boruszak
approved these changes
Dec 3, 2025
Contributor
boruszak
left a comment
boruszak
left a comment
There was a problem hiding this comment.
All style suggestions. Fabulous. Splendid. Approved.
| should be aware of. | ||
| <!-- | ||
| Please describe why you're making this change and point out any important details the reviewers | ||
| should be aware of. A robust description helps the tech writer create a fabulous release note. |
Contributor
There was a problem hiding this comment.
I love "fabulous" here! As in its Latin root: A release note to be celebrated in fable.
| <!-- | ||
| Please describe why you're making this change and point out any important details the reviewers | ||
| should be aware of. A robust description helps the tech writer create a fabulous release note. | ||
| If your code PR has a splendid description, link to the code PR in the links section so that |
Contributor
There was a problem hiding this comment.
Suggested change
| If your code PR has a splendid description, link to the code PR in the links section so that | |
| If your PR updates code in the `hashicorp/nomad` repo, link to the code PR in the links section so that |
Contributor
Author
There was a problem hiding this comment.
I'm seeing engineers creating robust descriptions in the code PR and then no description in the docs PR. In those cases, I've been copying the relevant parts of the code PR description into the docs PR description so that I don't have to constantly switch repos to see that the docs PR covers.
Comment on lines
+55
to
+56
| **Please link to the related Nomad repo code PR!** if there is one. | ||
| The tech writer does look at the code PR description, Jira ticket, and/or GH issue before reviewing docs content. |
Contributor
There was a problem hiding this comment.
Suggested change
| **Please link to the related Nomad repo code PR!** if there is one. | |
| The tech writer does look at the code PR description, Jira ticket, and/or GH issue before reviewing docs content. | |
| **Please link to related code PRs in the `hashicorp/nomad` repo!** | |
| The tech writer looks at related descriptions, Jira tickets, and GH issues so | |
| that they have the full context for the documentationupdates. |
Comment on lines
+58
to
+59
| Include links to GitHub issues, documentation, or similar which is relevant to this PR. If | ||
| this is a docs bug fix, please ensure related issues are linked so they will close when this PR is |
Contributor
There was a problem hiding this comment.
Suggested change
| Include links to GitHub issues, documentation, or similar which is relevant to this PR. If | |
| this is a docs bug fix, please ensure related issues are linked so they will close when this PR is | |
| Include links to GitHub issues, existing documentation, and other content relevant to this PR. If | |
| this PR implements a docs bug fix, please ensure related JIRA issues are linked so they will close when this PR is |
Contributor
Author
There was a problem hiding this comment.
Only GH issues close when the PR is merged. Jira issues do not.
Co-authored-by: Jeff Boruszak <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.