Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved the pull request and added more issues templates. Fixes #47 #54

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from
Draft
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/create-new-section-template.md
Original file line number Diff line number Diff line change
@@ -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

---

<!-- This template is used for requesting for the addition of an entirely new section/sub-section in the current documentation. -->


<!-- Thanks for filing an issue! Before hitting the button, please answer these questions.-->

# Create {section-name}

## Section Name: {section-name}
<!-- What is this section called? -->

### Why do we need to create this section
<!-- Tell us why it is important that this section is added to the documentation. -->

### What will this section contain?
<!-- Tell us what will be included in this section that isn't already added to existing sections. -->

### Directory
<!-- Will this be a section on it's own or it is going to be a sub-section? Can you provide a link to where this section will be added to? -->

### Sub-sections
<!-- Does this section have sub-sections?
If yes, please list the title of each sub-section in this format; -->

##### Sub-section one
<!-- Sub-section one does Lorem ipsum dolor sit amet, consectetur... -->

##### Sub-section two
<!-- Sub-section two does Lorem ipsum dolor sit amet, consectetur... -->

<!-- {Optional: add any further explanation if the above does not give room for enough context?} -->

## Helpful Resources
<!-- {Optional: Add links to anything that might be helpful in understanding the need of this particular section} -->

<!-- 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. -->


### Comments for the reviewers?
<!-- Leave a comment for the reviewers of this issue -->
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: 🤔 Questions
about: For Questions not answered in our community meetings, Docs, Readme or Slack
title: {title}
labels: question

---

<!-- This template is used to ask questions that you might have and have not been previously answered on any of our communication or help channels. Questions asked here should be questions that might likely lead to a new issue being created. -->

**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?
<!-- Leave a comment for the reviewers of this issue -->

Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
<!-- This form is for bug reports and feature requests ONLY! -->
---
name: 🛠️ Technical Issue
about: For BUG REPORTS & FEATURE REQUESTS only!
title: {title}
labels: technical

---
<!-- This template is for bug reports and feature requests ONLY! -->

<!-- Thanks for filing an issue! Before hitting the button, please answer these questions.-->

## Is this a BUG REPORT or FEATURE REQUEST?
Expand All @@ -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**:
Expand All @@ -24,4 +29,7 @@ explain why.

**How to reproduce it (as minimally and precisely as possible)**:

**Anything else we need to know?**:
**Anything else we need to know?**:

### Comments for the reviewers?
<!-- Leave a comment for the reviewers of this issue -->
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/update-documentation-template copy.md
Original file line number Diff line number Diff line change
@@ -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

---

<!-- This template is used to report any type of errors(punctuations, grammatical, spelling, etc) found in the litmus documentation. More broadly speaking, it is used to request for fixes, updates, changes, or general improvements to the current Litmus documetation. -->

## What error was observed?
<!-- This can be anything, a typo, spelling error, lack of clarity in specific places, etc. -->

## What improvement does this issue propose?
<!-- Tell us what the improvement is and why it is better. Provide clarity in your explanation, give as much context as you can. Include links, screenshots(if necessary), and references. -->

## Helpful Resources
<!-- {Optional: Add links to anything that might be helpful in understanding the need of this particular section} -->

### Comments for the reviewers?
<!-- Leave a comment for the reviewers of this issue -->
10 changes: 7 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
<!-- Thanks for sending a pull request! Here are some tips for you -->

**What this PR does / why we need it**:
### What this PR does / why we need it:
<!-- Be detailed, tell us how this PR solves an existing problem(or issue) -->

**Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes #
### Which issue this PR fixes *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes #

**Special notes for your reviewer**:
### What changes were made?
<!-- What were the updates made and why do they matter? You can link am issue if one already explains it -->

### Special notes for your reviewer:

**Checklist:**
- [ ] Fixes #<issue number>
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ website/i18n/*
# Generated files
website/.docusaurus
website/.cache-loader
website/build

# Misc
.DS_Store
Expand Down
Empty file removed website/build/.gitkeep
Empty file.
6 changes: 5 additions & 1 deletion website/docs/litmus-installation-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ sidebar_label: Control Plane (Cluster Mode)
---

<iframe width="560" height="315" src="https://www.youtube.com/embed/rOrKegj5ePI" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
<br />
<br />

Installing Litmus in cluster mode gives Litmus access to cluster wide resources. Here, the CRDs are installed directly on the cluster.

## Pre-requisites

Expand All @@ -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.

Expand Down
4 changes: 4 additions & 0 deletions website/docs/litmus-installation-namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ sidebar_label: Control Plane (Namespace Mode)
---

<iframe width="560" height="315" src="https://www.youtube.com/embed/rOrKegj5ePI" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
<br />
<br />

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

Expand Down