Skip to content

Infra: Update Nomad PR template and link #1446

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.

Sign up for GitHub

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

Open
aimeeu wants to merge 2 commits into
base: main
Choose a base branch
from
+34 −9
Open

Infra: Update Nomad PR template and link #1446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e3271c
Update Nomad PR template and link
aimeeu Dec 3, 2025
5ad43c4
Apply suggestions from code review
aimeeu Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 33 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,44 +11,69 @@ If your content is an update to:
Choose **base: main** when you are updating published documentation, and you
want your changes published when the PR is merged. We publish Nomad content
from the `main` branch.

- Upcoming Nomad release

Choose the branch for the Nomad release that your content is for. Nomad
release branches use the `nomad/<exact-release-number>` format. If you are not
able to find the upcoming Nomad release branch that you are looking for,
contact the tech writer that works with the Nomad team.

- Upcoming Nomad release but not sure which one

- Choose the `main` branch.
- Add the "do not merge" label.
- Convert the PR to a DRAFT.
- Put an explanation in the **Description** section.

The tech writer coordinates with Nomad engineering and updates
the docs PR base branch when the code is slotted into an upcoming release.

**Backports**

This repo stores previous version docs in folders instead of branches. There are
no backport labels. If you backported your code PR to previous branches, update
the docs content in the corresponding folders. For example, if the current
release is 1.10.x and you backported your code to 1.9.x and 1.8.x, update the docs content
in the v1.10.x, v1.9.x, and v1.8.x folders.
in the v1.10.x, v1.9.x, and v1.8.x folders. If you can't find the relevant files in previous versions,
add a note to your PR description. The tech writer will help ensure that the previous versions
receive the correct updates.
-->

## Description

<!-- Please describe why you're making this change and point out any important details the reviewers
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.
Copy link
Contributor

@boruszak boruszak Dec 3, 2025

Choose a reason for hiding this comment

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

I love "fabulous" here! As in its Latin root: A release note to be celebrated in fable.

If your code PR has a splendid description, link to the code PR in the links section so that
Copy link
Contributor

@boruszak boruszak Dec 3, 2025

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

@aimeeu aimeeu Dec 4, 2025

Choose a reason for hiding this comment

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

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.

the tech writer can update this PR's description.

Include the target release as well as prior versions if applicable.
-->

## Links
<!--
Please include links to GitHub issues, documentation, or similar which is relevant to this PR. If
this is a bug fix, please ensure related issues are linked so they will close when this PR is
**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.
Comment on lines +56 to +57
Copy link
Contributor

@boruszak boruszak Dec 3, 2025

Choose a reason for hiding this comment

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

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.


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
Comment on lines +59 to +60
Copy link
Contributor

@boruszak boruszak Dec 3, 2025

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

@aimeeu aimeeu Dec 4, 2025

Choose a reason for hiding this comment

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

Only GH issues close when the PR is merged. Jira issues do not.

merged.

Jira: [<jira-ticket-number>] // for example, Jira: [CE-1001] GH-Jira integration generates the link and updates the Jira ticket.
// GH-Jira integration generates the link and updates the Jira ticket.
Jira: [<jira-ticket-number>] // for example, Jira: [NMD-1234]

GitHub Issue: <issue-link>
Deploy previews:

The bot does publish a root-level link to the deploy preview,
Deploy previews: The bot does publish a root-level link to the deploy preview,
but it's nice to include a direct link to your content so the reviewers don't have to navigate to your pages.
-->

Nomad Code PR:
Jira:
GitHub Issue:
Deploy Previews:

## Contributor checklists

Review urgency:
Expand Down
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Please go to the `Preview` tab and select the appropriate template:

* [Consul](?expand=1&labels=Consul&title=Consul+Docs&template=consul_pull_request_template.md)
* [HCP services](?expand=1&template=hcp_pull_request_template.md)
* [Nomad](?expand=1&labels=Nomad&title=Nomad+Docs&template=nomad_pull_request_template.md)
* [Nomad](?expand=1&labels=Nomad,Runtime&title=Nomad+Docs&template=nomad_pull_request_template.md)

### Terraform

Expand Down
Loading