diff --git a/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md index 86c13f25ec..bc8d068d75 100644 --- a/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/nomad_pull_request_template.md @@ -11,6 +11,7 @@ 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 @@ -18,37 +19,61 @@ If your content is an update to: 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 - ## Links +Nomad Code PR: +Jira: +GitHub Issue: +Deploy Previews: + ## Contributor checklists Review urgency: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a892276cd8..a23179b8b7 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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