Improv/create workflow

.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
+
+---
+
+<!-- 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}
+
+## Section Name: {section}
+<!-- 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. -->

.github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/technical-issues.md

@@ -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?
@@ -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**:

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

.github/PULL_REQUEST_TEMPLATE.md

@@ -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>

.gitignore

@@ -17,6 +17,7 @@ website/i18n/*
 # Generated files
 website/.docusaurus
 website/.cache-loader
+website/build
 
 # Misc
 .DS_Store

website/docs/create-workflow.md

@@ -5,8 +5,16 @@ sidebar_label: Create Workflow
 ---
 
 ---
+Once you have litmus setup, and you are logged in on the litmus portal, you can then proceed to create a workflow on the portal.
 
-Click on the **Schedule your first workflow** button on the home page to get started. It will take you to the workflow page where you can choose or design your own workflow by doing the following steps:
+## Create a workflow
+
+To create a workflow, click on the **Schedule your first workflow** button on the homepage. It will take you to the workflow page where you can choose or design your own workflow by going through the following steps:
+
+<figure>
+<img src={require('./assets/create-workflow-button.png').default} width="800" />
+<i>Fig 1 : Click on the "Schedule Workflow" button to create a new workflow.</i>
+</figure>
 
 ### 1. Choose Target Agent
 
@@ -29,6 +37,11 @@ In this step, you can create a workflow from different methods, these include:
 
 - **Import workflow using YAML** : With this option, you can import a hand-crafted chaos workflow manifest and tune it according to the use-case.
 
+<figure>
+<img src={require('./assets/select-workflow.png').default} width="800" />
+<i>Fig 2 : Choose a workflow.</i>
+</figure>
+
 ### 3. Workflow Settings
 
 In this section, you can change the name of the workflow and also provide a description to the workflow. This section also consists information regarding the namespace where the workflow will be scheduled.
@@ -53,9 +66,20 @@ Some of the other features that are included with Litmus Portal 2.0 are :
 
 2. **Defining the steady state for the application** : With this step, you can add probes to your experiments. Probes are some additional checks that you can provide in your experiments. To know more about probes, you can visit [here](https://docs.litmuschaos.io/docs/litmus-probe/).
 
-### 5. Reliability score
+<figure>
+<img src={require('./assets/tune-workflow.png').default} width="800" />
+<i>Fig 3 : Tune a workflow.</i>
+</figure>
+
+### 5. Reliability Score (Optional)
+
+In this step, you can assign weights to the experiments present in the workflow. These weights will be then used for the calculation of the resilience score after the workflow completion. By default, 10 points are assigned to each experiment. This can be altered as per your use-case. After selecting weights click on the Next Button.
+
+<figure>
+<img src={require('./assets/reliability.png').default} width="800" />
+<i>Fig 3 : Reliability score</i>
+</figure>
 
-In this step, you can assign weights to the experiments present in the workflow. These weights will be then used for the calculation of the resilience score after the workflow completion. By default, 10 points are assigned to each experiment. This can be altered as per your use-case.
 
 ### 6. Schedule
 
@@ -71,3 +95,9 @@ In this step, you can schedule the workflow in 2 ways:
 ### 7. Verify and Commit
 
 This is the final step in workflow creation process. In this step, you can validate all the changes related to the workflow like the workflow name, the experiment weights, workflow description, workflow manifest etc. Once you have verified all the changes, you can click the **Finish** button to start the schedule.
+
+
+<figure>
+<img src={require('./assets/workflow-summary.png').default} width="800" />
+<i>Fig 3 : Verify and commit.</i>
+</figure>

website/docs/glossary.md

@@ -0,0 +1,9 @@
+---
+id: create
+title: How to Create a Workflow
+sidebar_label: Create
+---
+
+## Glossary
+
+---

website/docs/litmus-installation-cluster.md

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

website/docs/litmus-installation-namespace.md

@@ -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