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/.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/assets/create-workflow-button.png b/website/docs/assets/create-workflow-button.png new file mode 100644 index 00000000..9033d761 Binary files /dev/null and b/website/docs/assets/create-workflow-button.png differ diff --git a/website/docs/assets/reliability.png b/website/docs/assets/reliability.png new file mode 100644 index 00000000..7a7d8a38 Binary files /dev/null and b/website/docs/assets/reliability.png differ diff --git a/website/docs/assets/select-workflow.png b/website/docs/assets/select-workflow.png new file mode 100644 index 00000000..9897fdc8 Binary files /dev/null and b/website/docs/assets/select-workflow.png differ diff --git a/website/docs/assets/tune-workflow.png b/website/docs/assets/tune-workflow.png new file mode 100644 index 00000000..cef2ac1a Binary files /dev/null and b/website/docs/assets/tune-workflow.png differ diff --git a/website/docs/assets/workflow-summary.png b/website/docs/assets/workflow-summary.png new file mode 100644 index 00000000..848c3572 Binary files /dev/null and b/website/docs/assets/workflow-summary.png differ diff --git a/website/docs/create-workflow.md b/website/docs/create-workflow.md index 1a816880..a1cd69f5 100644 --- a/website/docs/create-workflow.md +++ b/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: + +
+ +Fig 1 : Click on the "Schedule Workflow" button to create a new workflow. +
### 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. +
+ +Fig 2 : Choose a workflow. +
+ ### 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 +
+ +Fig 3 : Tune a workflow. +
+ +### 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. + +
+ +Fig 3 : Reliability score +
-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. + + +
+ +Fig 3 : Verify and commit. +
diff --git a/website/docs/glossary.md b/website/docs/glossary.md new file mode 100644 index 00000000..4d563903 --- /dev/null +++ b/website/docs/glossary.md @@ -0,0 +1,9 @@ +--- +id: create +title: How to Create a Workflow +sidebar_label: Create +--- + +## Glossary + +--- 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