From 427bbf794f6218a31ad3f3db3fef9d689ebbb870 Mon Sep 17 00:00:00 2001 From: Jennifer Travinski Date: Wed, 14 Sep 2022 15:36:41 -0400 Subject: [PATCH 1/6] Edited GitHub button based on feedback --- .../issue_template/request-a-new-feature.md | 19 +++++++++++++++++++ .github/issue_template/request-an-update.md | 19 +++++++++++++++++++ .../request-to-add-item-to-release-notes.md | 17 +++++++++++++++++ 3 files changed, 55 insertions(+) create mode 100644 .github/issue_template/request-a-new-feature.md create mode 100644 .github/issue_template/request-an-update.md create 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 new file mode 100644 index 00000000000..5ce1764481a --- /dev/null +++ b/.github/issue_template/request-a-new-feature.md @@ -0,0 +1,19 @@ +--- +name: Request a New Feature +about: For requesting new feature(s) to be added to the docs. +title: "[Rancher Manager] " +labels: Rancher Manager +assignees: '' + +--- + +**Summary:** +Briefly describe the new feature. If QA has not yet tested the new feature/process, please also file a ticket with QA for their review. + + +**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 diff --git a/.github/issue_template/request-an-update.md b/.github/issue_template/request-an-update.md new file mode 100644 index 00000000000..3b6f83c8813 --- /dev/null +++ b/.github/issue_template/request-an-update.md @@ -0,0 +1,19 @@ +--- +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 +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. 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 new file mode 100644 index 00000000000..1c3afad3add --- /dev/null +++ b/.github/issue_template/request-to-add-item-to-release-notes.md @@ -0,0 +1,17 @@ +--- +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. +- If issue is to be filed as a known issue and there is a workaround, please describe. \ No newline at end of file From adbe95090c1fb0f921da5721268fa7c76aa63b61 Mon Sep 17 00:00:00 2001 From: Jennifer Travinski Date: Wed, 14 Sep 2022 15:40:06 -0400 Subject: [PATCH 2/6] Edited GitHub button based on feedback --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 559290ddf77..cd6d797252c 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -78,7 +78,7 @@ module.exports = { href: 'https://github.com/rancher/rancher-docs', label: 'GitHub', position: 'right', - className: 'navbar__github btn btn-secondary icon-github', + className: 'navbar__github', }, { type: 'docsVersionDropdown', From 9b4a30e8871f1283594a2aa772aa687e00ce5a8e Mon Sep 17 00:00:00 2001 From: Jennifer Travinski Date: Wed, 14 Sep 2022 15:45:00 -0400 Subject: [PATCH 3/6] Updating template --- .github/issue_template/request-to-add-item-to-release-notes.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) 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 index 1c3afad3add..982aab30a92 100644 --- a/.github/issue_template/request-to-add-item-to-release-notes.md +++ b/.github/issue_template/request-to-add-item-to-release-notes.md @@ -13,5 +13,4 @@ Briefly describe the issue. Please also include any corresponding tracking issue **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. -- If issue is to be filed as a known issue and there is a workaround, please describe. \ No newline at end of file +- Ensure that you have also filed a request for new feature docs if applicable. \ No newline at end of file From 4f76e2b3e4ee214c6fed245ad3d23ff658d95b2f Mon Sep 17 00:00:00 2001 From: Jennifer Travinski Date: Thu, 15 Sep 2022 10:06:05 -0400 Subject: [PATCH 4/6] Added auto-collapse to sidebar categories --- docusaurus.config.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docusaurus.config.js b/docusaurus.config.js index cd6d797252c..20de079d4cc 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -24,6 +24,11 @@ module.exports = { }, }, themeConfig: { + docs: { + sidebar: { + autoCollapseCategories: true, + }, + }, algolia: { // The application ID provided by Algolia appId: '30NEY6C9UY', From e9c107a084e21b205720bf773c9654cbf583838d Mon Sep 17 00:00:00 2001 From: Jennifer Travinski Date: Thu, 15 Sep 2022 10:26:28 -0400 Subject: [PATCH 5/6] 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 From de5f60bb2ebbbb2edb8b11c8062e3431bf5228f6 Mon Sep 17 00:00:00 2001 From: Jennifer Travinski Date: Wed, 28 Sep 2022 13:51:51 -0400 Subject: [PATCH 6/6] Updated templates, removed items to be addressed in a new PR --- .github/issue_template/request-a-new-feature.md | 9 +++------ docusaurus.config.js | 7 +------ 2 files changed, 4 insertions(+), 12 deletions(-) diff --git a/.github/issue_template/request-a-new-feature.md b/.github/issue_template/request-a-new-feature.md index 405f52be17a..23385bdcf31 100644 --- a/.github/issue_template/request-a-new-feature.md +++ b/.github/issue_template/request-a-new-feature.md @@ -8,12 +8,9 @@ assignees: '' --- **Summary:** -Briefly describe the new feature. If QA has not yet tested the new feature/process, please also file a ticket with QA for their review. +Describe the new feature. If QA has not yet tested the new feature/process, please also file a ticket with QA for their review. **Details:** -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 +- Include all pertinent information, e.g., screenshots, resource requirements, workarounds, links, etc. +- List page link(s) in the current docs where the new feature applies, if applicable. \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 20de079d4cc..559290ddf77 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -24,11 +24,6 @@ module.exports = { }, }, themeConfig: { - docs: { - sidebar: { - autoCollapseCategories: true, - }, - }, algolia: { // The application ID provided by Algolia appId: '30NEY6C9UY', @@ -83,7 +78,7 @@ module.exports = { href: 'https://github.com/rancher/rancher-docs', label: 'GitHub', position: 'right', - className: 'navbar__github', + className: 'navbar__github btn btn-secondary icon-github', }, { type: 'docsVersionDropdown',