From e9c107a084e21b205720bf773c9654cbf583838d Mon Sep 17 00:00:00 2001 From: Jennifer Travinski Date: Thu, 15 Sep 2022 10:26:28 -0400 Subject: [PATCH] Updating templates per feedback --- .github/issue_template/request-a-new-feature.md | 14 +++++++------- .github/issue_template/request-an-update.md | 14 +++----------- .../request-to-add-item-to-release-notes.md | 16 ---------------- 3 files changed, 10 insertions(+), 34 deletions(-) delete mode 100644 .github/issue_template/request-to-add-item-to-release-notes.md diff --git a/.github/issue_template/request-a-new-feature.md b/.github/issue_template/request-a-new-feature.md index 5ce1764481a..405f52be17a 100644 --- a/.github/issue_template/request-a-new-feature.md +++ b/.github/issue_template/request-a-new-feature.md @@ -1,8 +1,8 @@ --- name: Request a New Feature about: For requesting new feature(s) to be added to the docs. -title: "[Rancher Manager] " -labels: Rancher Manager +title: '' +labels: '' assignees: '' --- @@ -12,8 +12,8 @@ Briefly describe the new feature. If QA has not yet tested the new feature/proce **Details:** -- What page(s) in the current docs does request apply to? Please include link(s). -- What does the new process/feature do and how does it work? -- What are the steps involved in installing/running feature? Please describe. -- What version(s) of Rancher does the feature affect? -- List/attach all pertinent information, e.g., screenshots, resource requirements, code blocks, workarounds, links, etc. \ No newline at end of file +1. Include all pertinent information, e.g., screenshots, resource requirements, workarounds, links, etc. +1. Tag issue with appropriate release milestone. +1. List page link(s) in the current docs where the new feature applies, if applicable. +1. Explain the new process/feature and how it works. +1. List the steps involved in installing/running/uninstalling feature. \ No newline at end of file diff --git a/.github/issue_template/request-an-update.md b/.github/issue_template/request-an-update.md index 3b6f83c8813..1a36aedfe53 100644 --- a/.github/issue_template/request-an-update.md +++ b/.github/issue_template/request-an-update.md @@ -1,19 +1,11 @@ --- name: Request an Update about: For fixing docs errors/typos, adding needed/missing information, updating verbiage, deleting outdated info, etc. -title: "[Rancher Manager] " -labels: Rancher Manager +title: '' +labels: '' assignees: '' --- **Summary:** -Briefly describe the requested update. Please also file a ticket with QA for their review if requesting an existing process or feature be added. - - -**Details:** -- What page(s) in the current docs does request apply to? Please include link(s). -- What does the new process/feature do and why is it important to add? -- What are the steps involved in installing/running feature? Please describe. -- What version(s) of Rancher does the feature affect? -- List/attach all pertinent information, e.g., screenshots, resource requirements, code blocks, workarounds, links, etc. +Describe the requested update giving as much detail as possible. Please also list page link(s) in the current docs where the update applies. \ No newline at end of file diff --git a/.github/issue_template/request-to-add-item-to-release-notes.md b/.github/issue_template/request-to-add-item-to-release-notes.md deleted file mode 100644 index 982aab30a92..00000000000 --- a/.github/issue_template/request-to-add-item-to-release-notes.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Request a Release Note -about: For requesting items be added to the release notes. -title: "[Rancher Manager] " -labels: Rancher Manager -assignees: '' - ---- - -**Summary:** -Briefly describe the issue. Please also include any corresponding tracking issues from other repos such as [rancher/rancher](https://github.com/rancher/rancher/issues) and [rancher/dashboard](https://github.com/rancher/dashboard/issues). - - -**Details:** -- Tag issue with appropriate release milestone and `release-note` label. -- Ensure that you have also filed a request for new feature docs if applicable. \ No newline at end of file