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..d7f8eab0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/create-new-section-template.md @@ -0,0 +1,47 @@ +--- +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 + +--- + + + + + + +# Create {section-name} + +## Section Name: {section-name} + + +### Why do we need to create this section + + +### What will this section contain? + + +### Directory + + +### Sub-sections + + +##### Sub-section one + + +##### Sub-section two + + + + +## Helpful Resources + + + + + +### Comments for the reviewers? + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..6b904771 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,19 @@ +--- +name: 🤔 Questions +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) + + +### Comments for the reviewers? + + diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/technical-issues.md similarity index 50% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/technical-issues.md index 6716fbdb..d91e30bf 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**: @@ -24,4 +29,7 @@ explain why. **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 new file mode 100644 index 00000000..6053b486 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/update-documentation-template copy.md @@ -0,0 +1,21 @@ +--- +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 + + +### Comments for the reviewers? + 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 # 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 diff --git a/website/docs/litmus-installation-cluster.md b/website/docs/litmus-installation-cluster.md index 83864873..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 @@ -23,7 +27,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. 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