From ad8e0ead8cf32dd06c4b5b3bae6301a040513bf0 Mon Sep 17 00:00:00 2001 From: Gbadebo Bello Date: Mon, 28 Jun 2021 19:38:23 +0100 Subject: [PATCH 1/8] Signed-off-by: Gbadebo Bello Added new templates for different type of issues that can be created. --- .../create-new-section-template.md | 43 +++++++++++++++++++ .../technical-issues.md} | 15 ++++--- .../update-documentation-template.md | 18 ++++++++ .gitignore | 1 + website/build/.gitkeep | 0 5 files changed, 72 insertions(+), 5 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/create-new-section-template.md rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/technical-issues.md} (58%) create mode 100644 .github/ISSUE_TEMPLATE/update-documentation-template.md delete mode 100644 website/build/.gitkeep diff --git a/.github/ISSUE_TEMPLATE/create-new-section-template.md b/.github/ISSUE_TEMPLATE/create-new-section-template.md new file mode 100644 index 00000000..af976e55 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/create-new-section-template.md @@ -0,0 +1,43 @@ +--- +name: Create a new section +about: For issues requesting for the need of an entirely new section(sidebars) in the documentation +title: Create {section} +labels: sections + +--- + + + + + + +# Create {section} + +## Section Name: {section} + + +### Why do we need to create this section + + +### What will this section contain? + + +### Directory + + +### Sub-sections + + +##### Sub-section one + + +##### Sub-section two + + + + +## Helpful Resources + + + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/technical-issues.md similarity index 58% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/technical-issues.md index 6716fbdb..7e666e59 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/technical-issues.md @@ -1,4 +1,12 @@ - +--- +name: Technical Issue +about: For BUG REPORTS & FEATURE REQUESTS only! +title: {title} +labels: technical + +--- + + ## Is this a BUG REPORT or FEATURE REQUEST? @@ -12,10 +20,7 @@ If this is a BUG REPORT, please: If this is a FEATURE REQUEST, please: - Describe *in detail* the feature/behavior/change you'd like to see. -In both cases, be ready for followup questions, and please respond in a timely -manner. If we can't reproduce a bug or think a feature already exists, we -might close your issue. If we're wrong, PLEASE feel free to reopen it and -explain why. +In both cases, be ready for follow-up questions, and please respond in a timely manner. If we can't reproduce a bug or think a feature already exists, we might close your issue. If we're wrong, PLEASE feel free to reopen it and explain why. --> **What happened**: diff --git a/.github/ISSUE_TEMPLATE/update-documentation-template.md b/.github/ISSUE_TEMPLATE/update-documentation-template.md new file mode 100644 index 00000000..80b3d0fa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/update-documentation-template.md @@ -0,0 +1,18 @@ +--- +name: Update documentation +about: For issues that require an update or improvement to the existing Litmus documentation +title: {title} +labels: updates + +--- + + + +## What error was observed? + + +## What improvement does this issue propose? + + +## Helpful Resources + diff --git a/.gitignore b/.gitignore index a57ed27f..9cb7e13e 100755 --- a/.gitignore +++ b/.gitignore @@ -17,6 +17,7 @@ website/i18n/* # Generated files website/.docusaurus website/.cache-loader +website/build # Misc .DS_Store diff --git a/website/build/.gitkeep b/website/build/.gitkeep deleted file mode 100644 index e69de29b..00000000 From 4f0a54a37b094f7195b99f98ff79c28bc30f0ef8 Mon Sep 17 00:00:00 2001 From: Gbadebo Bello Date: Mon, 28 Jun 2021 19:46:05 +0100 Subject: [PATCH 2/8] Improved PULL REQUEST templates Signed-off-by: Gbadebo Bello --- .github/PULL_REQUEST_TEMPLATE.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0a4e2db3..2ddf484a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,14 @@ -**What this PR does / why we need it**: +### What this PR does / why we need it: + -**Which issue this PR fixes** *(optional, in `fixes #(, fixes #, ...)` format, will close that issue when PR gets merged)*: fixes # +### Which issue this PR fixes *(optional, in `fixes #(, fixes #, ...)` format, will close that issue when PR gets merged)*: fixes # -**Special notes for your reviewer**: +### What changes were made? + + +### Special notes for your reviewer: **Checklist:** - [ ] Fixes # From 077f1689444268727a68e2c6de849e8ad94fc9f3 Mon Sep 17 00:00:00 2001 From: Gbadebo Bello Date: Thu, 1 Jul 2021 13:02:55 +0100 Subject: [PATCH 3/8] Added title to helm installation steps(Cluster Mode) Signed-off-by: Gbadebo Bello --- website/docs/litmus-installation-cluster.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/litmus-installation-cluster.md b/website/docs/litmus-installation-cluster.md index 83864873..3dc87fab 100644 --- a/website/docs/litmus-installation-cluster.md +++ b/website/docs/litmus-installation-cluster.md @@ -23,7 +23,7 @@ Installation of Litmus can be done using either of the below methods - [Helm3](#helm_install) chart or - [Kubectl](#kubectl_install) yaml spec file -### Installation Steps +### Install Litmus using Helm The helm chart will install all the required service account configuration and chaos control plane. From 6a7f3445bfa1ba6dc9dc88f1ad75af83335b1b1f Mon Sep 17 00:00:00 2001 From: Gbadebo Bello Date: Thu, 1 Jul 2021 13:37:47 +0100 Subject: [PATCH 4/8] Included the difference between Cluster and Namespace mode installations' Signed-off-by: Gbadebo Bello --- website/docs/litmus-installation-cluster.md | 4 ++++ website/docs/litmus-installation-namespace.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/website/docs/litmus-installation-cluster.md b/website/docs/litmus-installation-cluster.md index 3dc87fab..c0645042 100644 --- a/website/docs/litmus-installation-cluster.md +++ b/website/docs/litmus-installation-cluster.md @@ -7,6 +7,10 @@ sidebar_label: Control Plane (Cluster Mode) --- +
+
+ +Installing Litmus in cluster mode gives Litmus access to cluster wide resources. Here, the CRDs are installed directly on the cluster. ## Pre-requisites diff --git a/website/docs/litmus-installation-namespace.md b/website/docs/litmus-installation-namespace.md index e4a14954..9d181d7c 100644 --- a/website/docs/litmus-installation-namespace.md +++ b/website/docs/litmus-installation-namespace.md @@ -7,6 +7,10 @@ sidebar_label: Control Plane (Namespace Mode) --- +
+
+ +Installing Litmus in namespace mode limits Litmus access to a particluar namespace. Here, you need to create a namespace where Litmus CRDs would be installed directly. This namespace will be specified during the installation step. ## Pre-requisites From 1ca05de901fa54f4a831ac82c4225bd2e86278cc Mon Sep 17 00:00:00 2001 From: Gbahdeyboh Date: Mon, 19 Jul 2021 18:01:13 +0100 Subject: [PATCH 5/8] Added a question issue template Signed-off-by: Gbahdeyboh --- .github/ISSUE_TEMPLATE/question.md | 15 +++++++++++++++ ...e.md => update-documentation-template copy.md} | 0 2 files changed, 15 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/question.md rename .github/ISSUE_TEMPLATE/{update-documentation-template.md => update-documentation-template copy.md} (100%) diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..c64e0c0d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,15 @@ +--- +name: 🤔 Question +about: For Questions not answered in our community meetings, Docs, Readme or Slack +title: {title} +labels: question + +--- + + + +**Please make sure you have;** + +- Reviewed the [Questions](https://github.com/litmuschaos/litmus-docs-beta/labels/question) asked by our community members and contributers. +- Searched opened and closed [GitHub issues](https://github.com/litmuschaos/litmus-docs-beta/issues) + diff --git a/.github/ISSUE_TEMPLATE/update-documentation-template.md b/.github/ISSUE_TEMPLATE/update-documentation-template copy.md similarity index 100% rename from .github/ISSUE_TEMPLATE/update-documentation-template.md rename to .github/ISSUE_TEMPLATE/update-documentation-template copy.md From e8481dd87e1318fed27d021857983b3382e9af33 Mon Sep 17 00:00:00 2001 From: Gbahdeyboh Date: Mon, 19 Jul 2021 18:03:48 +0100 Subject: [PATCH 6/8] Added a reviewer comments section to issue templates Signed-off-by: Gbahdeyboh --- .github/ISSUE_TEMPLATE/create-new-section-template.md | 6 +++++- .github/ISSUE_TEMPLATE/question.md | 4 ++++ .github/ISSUE_TEMPLATE/technical-issues.md | 5 ++++- .../ISSUE_TEMPLATE/update-documentation-template copy.md | 3 +++ 4 files changed, 16 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/create-new-section-template.md b/.github/ISSUE_TEMPLATE/create-new-section-template.md index af976e55..b4b9bf63 100644 --- a/.github/ISSUE_TEMPLATE/create-new-section-template.md +++ b/.github/ISSUE_TEMPLATE/create-new-section-template.md @@ -40,4 +40,8 @@ If yes, please list the title of each sub-section in this format; --> ## Helpful Resources - \ No newline at end of file + + + +### Comments for the reviewers? + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index c64e0c0d..b8c2c8fe 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -13,3 +13,7 @@ labels: question - Reviewed the [Questions](https://github.com/litmuschaos/litmus-docs-beta/labels/question) asked by our community members and contributers. - Searched opened and closed [GitHub issues](https://github.com/litmuschaos/litmus-docs-beta/issues) + +### Comments for the reviewers? + + diff --git a/.github/ISSUE_TEMPLATE/technical-issues.md b/.github/ISSUE_TEMPLATE/technical-issues.md index 7e666e59..9cb4e572 100644 --- a/.github/ISSUE_TEMPLATE/technical-issues.md +++ b/.github/ISSUE_TEMPLATE/technical-issues.md @@ -29,4 +29,7 @@ In both cases, be ready for follow-up questions, and please respond in a timely **How to reproduce it (as minimally and precisely as possible)**: -**Anything else we need to know?**: \ No newline at end of file +**Anything else we need to know?**: + +### Comments for the reviewers? + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/update-documentation-template copy.md b/.github/ISSUE_TEMPLATE/update-documentation-template copy.md index 80b3d0fa..5f1dece8 100644 --- a/.github/ISSUE_TEMPLATE/update-documentation-template copy.md +++ b/.github/ISSUE_TEMPLATE/update-documentation-template copy.md @@ -16,3 +16,6 @@ labels: updates ## Helpful Resources + +### Comments for the reviewers? + From 5eb5c5c0287c4793f92cd52a1c4010f60a067584 Mon Sep 17 00:00:00 2001 From: Gbahdeyboh Date: Mon, 19 Jul 2021 18:05:56 +0100 Subject: [PATCH 7/8] Modified section titles Signed-off-by: Gbahdeyboh --- .github/ISSUE_TEMPLATE/create-new-section-template.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/create-new-section-template.md b/.github/ISSUE_TEMPLATE/create-new-section-template.md index b4b9bf63..5ffe5c8a 100644 --- a/.github/ISSUE_TEMPLATE/create-new-section-template.md +++ b/.github/ISSUE_TEMPLATE/create-new-section-template.md @@ -1,7 +1,7 @@ --- -name: Create a new section +name: Create a new sidebar section about: For issues requesting for the need of an entirely new section(sidebars) in the documentation -title: Create {section} +title: Create {section-name} - Title labels: sections --- @@ -11,9 +11,9 @@ labels: sections -# Create {section} +# Create {section-name} -## Section Name: {section} +## Section Name: {section-name} ### Why do we need to create this section From 2067dd4b8c25c2ffe45583b5b7fdd72a8cc09e11 Mon Sep 17 00:00:00 2001 From: Gbahdeyboh Date: Mon, 19 Jul 2021 18:10:24 +0100 Subject: [PATCH 8/8] Added Emoji's to section names Signed-off-by: Gbahdeyboh --- .github/ISSUE_TEMPLATE/create-new-section-template.md | 2 +- .github/ISSUE_TEMPLATE/question.md | 2 +- .github/ISSUE_TEMPLATE/technical-issues.md | 2 +- .github/ISSUE_TEMPLATE/update-documentation-template copy.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/create-new-section-template.md b/.github/ISSUE_TEMPLATE/create-new-section-template.md index 5ffe5c8a..d7f8eab0 100644 --- a/.github/ISSUE_TEMPLATE/create-new-section-template.md +++ b/.github/ISSUE_TEMPLATE/create-new-section-template.md @@ -1,5 +1,5 @@ --- -name: Create a new sidebar section +name: 📖 Create a new sidebar section about: For issues requesting for the need of an entirely new section(sidebars) in the documentation title: Create {section-name} - Title labels: sections diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index b8c2c8fe..6b904771 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,5 +1,5 @@ --- -name: 🤔 Question +name: 🤔 Questions about: For Questions not answered in our community meetings, Docs, Readme or Slack title: {title} labels: question diff --git a/.github/ISSUE_TEMPLATE/technical-issues.md b/.github/ISSUE_TEMPLATE/technical-issues.md index 9cb4e572..d91e30bf 100644 --- a/.github/ISSUE_TEMPLATE/technical-issues.md +++ b/.github/ISSUE_TEMPLATE/technical-issues.md @@ -1,5 +1,5 @@ --- -name: Technical Issue +name: 🛠️ Technical Issue about: For BUG REPORTS & FEATURE REQUESTS only! title: {title} labels: technical diff --git a/.github/ISSUE_TEMPLATE/update-documentation-template copy.md b/.github/ISSUE_TEMPLATE/update-documentation-template copy.md index 5f1dece8..6053b486 100644 --- a/.github/ISSUE_TEMPLATE/update-documentation-template copy.md +++ b/.github/ISSUE_TEMPLATE/update-documentation-template copy.md @@ -1,5 +1,5 @@ --- -name: Update documentation +name: ⬆️ Update documentation about: For issues that require an update or improvement to the existing Litmus documentation title: {title} labels: updates