From 77832a344e8b31ec369a2c98a42683e5a5436b8b Mon Sep 17 00:00:00 2001 From: Aimee Ukasick Date: Mon, 27 Oct 2025 12:08:37 -0500 Subject: [PATCH 1/4] Docs infra: Add PR template for Nomad --- .../nomad_pull_request_template.md | 78 +++++++++++++++++++ .github/pull_request_template.md | 1 + 2 files changed, 79 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md new file mode 100644 index 0000000000..ecd95ed65d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md @@ -0,0 +1,78 @@ +## Imporant Information + +### Merge branch + +Make sure you create your PR against the correct **base** branch. Refer to +GitHub's [Change the branch range and destination repository guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#changing-the-branch-range-and-destination-repository) for how to +select the base branch when creating a pull request. + +If your content is an update to: + +- Currently published content + + 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/` 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. + +### 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. + +## Description + + + +## Links + + +## Contributor + +Review urgency: + +- [ ] ASAP (bug fixes, broken content, imminent releases) +- [ ] 3 days (small changes, easy reviews) +- [ ] 1 week (default) +- [ ] Best effort (very non-urgent) + +Pull request: + +- [ ] Verify that all status checks have passed +- [ ] Verify that preview environment has successfully deployed +- [ ] Add all required reviewers + +Content: + +- [ ] Add redirects for any moved or removed pages +- [ ] Follow the [Education style guide](https://github.com/hashicorp/web-unified-docs/tree/main/docs/style-guide) +- [ ] Look at the local or Vercel build to make sure the content renders + correctly + +## Reviewers + +Technical reviewers should verify that the content is technically correct. + +Education reviewers should ensure the following: + +- Content adheres to the Education style and content guides +- Guides work as written diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9983da36c9..cad4d55742 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,5 @@ Please go to the `Preview` tab and select the appropriate template: * [HCP services](?expand=1&template=hcp_pull_request_template.md) +* [Nomad](?expand=1&template=nomad_pull_request_template.md) * [Terraform Enterprise](?expand=1&template=ptfe_release_pull_request_template.md) From 81068f720f31162e5d7325a5a8e4fc7595e071f1 Mon Sep 17 00:00:00 2001 From: Aimee Ukasick Date: Fri, 31 Oct 2025 13:09:49 -0500 Subject: [PATCH 2/4] Update Reviewer responsiblities --- .../nomad_pull_request_template.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md index ecd95ed65d..ad660700b2 100644 --- a/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md @@ -59,20 +59,17 @@ Pull request: - [ ] Verify that all status checks have passed - [ ] Verify that preview environment has successfully deployed -- [ ] Add all required reviewers +- [ ] Add all required reviewers if they are not part of assigned groups Content: - [ ] Add redirects for any moved or removed pages - [ ] Follow the [Education style guide](https://github.com/hashicorp/web-unified-docs/tree/main/docs/style-guide) -- [ ] Look at the local or Vercel build to make sure the content renders - correctly +- [ ] Look at the local or Vercel build to make sure the content renders correctly ## Reviewers -Technical reviewers should verify that the content is technically correct. - -Education reviewers should ensure the following: - -- Content adheres to the Education style and content guides -- Guides work as written +- [ ] PR is against the correct base branch +- [ ] Content is technically correct +- [ ] Guides work and step order makes sense +- [ ] Content follows the Education content and style guides From d68bb9c029578a509e29fc11952a1cf437464eb0 Mon Sep 17 00:00:00 2001 From: Aimee Ukasick Date: Mon, 10 Nov 2025 15:14:29 -0600 Subject: [PATCH 3/4] Jeff feedback --- .../nomad_pull_request_template.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md index ad660700b2..4fcc2b0b09 100644 --- a/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md @@ -1,6 +1,7 @@ + ## Description ## Links @@ -46,7 +49,7 @@ GitHub Issue: 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. --> -## Contributor +## Contributor checklists Review urgency: @@ -57,6 +60,7 @@ Review urgency: Pull request: +- [ ] Opened against the correct base branch - [ ] Verify that all status checks have passed - [ ] Verify that preview environment has successfully deployed - [ ] Add all required reviewers if they are not part of assigned groups @@ -67,7 +71,7 @@ Content: - [ ] Follow the [Education style guide](https://github.com/hashicorp/web-unified-docs/tree/main/docs/style-guide) - [ ] Look at the local or Vercel build to make sure the content renders correctly -## Reviewers +## Reviewer checklist - [ ] PR is against the correct base branch - [ ] Content is technically correct From 6619e28d5e1ea79162a30a1886242f3de9ff1dd9 Mon Sep 17 00:00:00 2001 From: Aimee Ukasick Date: Tue, 11 Nov 2025 12:06:41 -0600 Subject: [PATCH 4/4] jeff feedback; add label and title to nomad template link --- .../nomad_pull_request_template.md | 46 +++++++++---------- .github/pull_request_template.md | 2 +- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md index 4fcc2b0b09..86c13f25ec 100644 --- a/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md @@ -1,11 +1,8 @@ ## Links @@ -43,37 +40,40 @@ Include the target release and prior versions if applicable. 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 merged. -Jira: [] + +Jira: [] // for example, Jira: [CE-1001] GH-Jira integration generates the link and updates the Jira ticket. GitHub Issue: +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. +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. --> ## Contributor checklists Review urgency: -- [ ] ASAP (bug fixes, broken content, imminent releases) -- [ ] 3 days (small changes, easy reviews) -- [ ] 1 week (default) -- [ ] Best effort (very non-urgent) +- [ ] ASAP: Bug fixes, broken content, imminent releases +- [ ] 3 days: Small changes, easy reviews +- [ ] 1 week: Default expectation +- [ ] Best effort: No urgency Pull request: -- [ ] Opened against the correct base branch -- [ ] Verify that all status checks have passed -- [ ] Verify that preview environment has successfully deployed -- [ ] Add all required reviewers if they are not part of assigned groups +- [ ] Verify that the PR is set to merge into the correct base branch +- [ ] Verify that all status checks passed +- [ ] Verify that the preview environment deployed successfully +- [ ] Add additional reviewers if they are not part of assigned groups Content: -- [ ] Add redirects for any moved or removed pages -- [ ] Follow the [Education style guide](https://github.com/hashicorp/web-unified-docs/tree/main/docs/style-guide) -- [ ] Look at the local or Vercel build to make sure the content renders correctly +- [ ] I added redirects for any moved or removed pages +- [ ] I followed the [Education style guide](https://github.com/hashicorp/web-unified-docs/tree/main/docs/style-guide) +- [ ] I looked at the local or Vercel build to make sure the content rendered correctly ## Reviewer checklist -- [ ] PR is against the correct base branch -- [ ] Content is technically correct -- [ ] Guides work and step order makes sense -- [ ] Content follows the Education content and style guides +- [ ] This PR is set to merge into the correct base branch. +- [ ] The content does not contain technical inaccuracies. +- [ ] The content follows the Education content and style guides. +- [ ] I have verified and tested changes to instructions for end users. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index cad4d55742..bde6fe16ad 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,5 @@ Please go to the `Preview` tab and select the appropriate template: * [HCP services](?expand=1&template=hcp_pull_request_template.md) -* [Nomad](?expand=1&template=nomad_pull_request_template.md) +* [Nomad](?expand=1&labels=Nomad&title=Nomad+Docs&template=nomad_pull_request_template.md) * [Terraform Enterprise](?expand=1&template=ptfe_release_pull_request_template.md)