From 922cac9915b02d677bb137a494dd4cf6d2b8d7a9 Mon Sep 17 00:00:00 2001 From: andoriyaprashant Date: Fri, 27 Dec 2024 20:15:30 +0530 Subject: [PATCH] Refactor documentation Signed-off-by: andoriyaprashant --- website/docs/concepts/chaoshub.md | 80 +------------------ website/docs/concepts/gitops.md | 2 +- website/docs/concepts/oauth-dex-concept.md | 2 +- website/docs/concepts/probes.md | 2 +- website/docs/concepts/projects.md | 2 +- website/docs/concepts/teaming.md | 2 +- .../docs/user-guides/connecting-git-repo.md | 60 ++++++++++++++ website/docs/user-guides/removing-chaoshub.md | 7 ++ .../docs/user-guides/viewing-chaos-faults.md | 20 +++++ .../viewing-predefined-experiments.md | 10 +++ website/sidebars.js | 6 +- .../version-3.12.0/concepts/chaoshub.md | 80 +------------------ .../version-3.12.0/concepts/gitops.md | 2 +- .../concepts/oauth-dex-concept.md | 2 +- .../version-3.12.0/concepts/probes.md | 2 +- .../version-3.12.0/concepts/projects.md | 2 +- .../version-3.12.0/concepts/teaming.md | 2 +- .../user-guides/connecting-git-repo.md | 60 ++++++++++++++ .../user-guides/removing-chaoshub.md | 7 ++ .../user-guides/viewing-chaos-faults.md | 18 +++++ .../viewing-predefined-experiments.md | 10 +++ .../version-3.12.0-sidebars.json | 6 +- 22 files changed, 216 insertions(+), 168 deletions(-) create mode 100644 website/docs/user-guides/connecting-git-repo.md create mode 100644 website/docs/user-guides/removing-chaoshub.md create mode 100644 website/docs/user-guides/viewing-chaos-faults.md create mode 100644 website/docs/user-guides/viewing-predefined-experiments.md create mode 100644 website/versioned_docs/version-3.12.0/user-guides/connecting-git-repo.md create mode 100644 website/versioned_docs/version-3.12.0/user-guides/removing-chaoshub.md create mode 100644 website/versioned_docs/version-3.12.0/user-guides/viewing-chaos-faults.md create mode 100644 website/versioned_docs/version-3.12.0/user-guides/viewing-predefined-experiments.md diff --git a/website/docs/concepts/chaoshub.md b/website/docs/concepts/chaoshub.md index 15ccac93..64af71ae 100644 --- a/website/docs/concepts/chaoshub.md +++ b/website/docs/concepts/chaoshub.md @@ -12,87 +12,11 @@ A ChaosHub is a collection of experiment templates and faults that you can use t - Chaos experiments can be created from the public [ChaosHub](http://hub.litmuschaos.io/) which is already connected to your ChaosCenter, or a custom ChaosHub which is a [fork](https://github.com/litmuschaos/chaos-charts) of the public ChaosHub where custom faults can be stored. -## Prerequisites - -The following are the prerequisites for creating a Chaos Experiment: - -- Fork of [Chaos-Charts](https://github.com/litmuschaos/chaos-charts) repository - -:::note -An active internet connection is required to clone the git repository for the first time installation. -::: - -## Connecting to a Git repository using ChaosHub - -With ChaosHub, you can construct chaos experiments by selecting, tuning and sequencing different faults together from their connected ChaosHubs. - -You can make changes in your forked repositories and sync it with the Portal to get the latest changes from the fork. - -By default, a public ChaosHub is provided when the ChaosCenter is installed for the first time. - - - -### 1. Connect a public Git repository - -You can connect to a public Git repository by simply providing the following details: - -- Hub name -- Git URL of the forked repository -- Branch name - - - -### 2. Connect a private Git repository - -To add a private ChaosHub, you need provide the hub name, Git URL of the forked repository and the branch name similar to that of public hub and the repository can be connected in two ways: - - - -#### a. Access token - -Personal Access Tokens are used as an alternative to the password for authentication to Git services. - -#### b. SSH key - -Just like the Access Token , SSH keys are used for the authentication. These keys come in pairs, a public key that is shared with the Git Services and a private key that is stored with you. -SSH link of the repository should be provided if you select this method. - - - -## Syncing a ChaosHub - -If some changes are made into the Git repository, you can reflect these changes in the hub by selecting the **Refresh Hub** option from the ChaosHub card. - -## Editing a ChaosHub - -To make changes in a hub like changing the name, branch, access token etc, you can select the **Edit Hub** option from the ChaosHub card. - ## Chaos experiments and experiments in a ChaosHub -### 1. View the PreDefined Chaos Experiments - -After connecting a ChaosHub, you can view the different pre-defined chaos experiments present in the ChaosHub. - - - -### 2. View the Chaos Faults - -Similarly, you can view the different charts and the fault. These charts are sorted according to different categories like generic, AWS, Azure, Kube-Components etc. - - - -### 3. View the fault details - -You can select one of the chaos faults and can examine the fault details. The fault page consists of all the important details like the description of the fault, a tutorial video, the maintainer of the fault, etc. - -You can also find the Experiment manifest URL, RBAC URL, and the ChaosEngine URLs of the fault. -These URLs are required for the creation of custom chaos experiments. - - - -## Disconnect a ChaosHub +For information on viewing predefined chaos experiments, refer to [Viewing Predefined Chaos Experiments](../user-guides/viewing-predefined-experiments.md). -To remove a ChaosHub from a project, you can select the **Disconnect Hub** option from the ChaosHub card. +For information on viewing chaos faults and their details, refer to [Viewing Chaos Faults](../user-guides/viewing-chaos-faults.md). ## Summary diff --git a/website/docs/concepts/gitops.md b/website/docs/concepts/gitops.md index 05c725ab..6e38dbcc 100644 --- a/website/docs/concepts/gitops.md +++ b/website/docs/concepts/gitops.md @@ -6,7 +6,7 @@ sidebar_label: GitOps --- -## Prerequisites +## Related concepts - Chaos Infrastructure - [Chaos Experiment](chaos-workflow.md) diff --git a/website/docs/concepts/oauth-dex-concept.md b/website/docs/concepts/oauth-dex-concept.md index 0ac2cd33..e8417660 100644 --- a/website/docs/concepts/oauth-dex-concept.md +++ b/website/docs/concepts/oauth-dex-concept.md @@ -6,7 +6,7 @@ sidebar_label: Authentication in ChaosCenter --- -## Prerequisites +## Related concepts - [OAuth](https://oauth.net/specs/) diff --git a/website/docs/concepts/probes.md b/website/docs/concepts/probes.md index 4547c756..6ca97310 100644 --- a/website/docs/concepts/probes.md +++ b/website/docs/concepts/probes.md @@ -8,7 +8,7 @@ sidebar_label: Resilience Probes Resilience Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Experiment. The fault pods execute these checks based on the mode they are defined in & factor their success as necessary conditions in determining the verdict of the fault (along with the standard `in-built` checks). -## Prerequisites +## Related concepts To understand the concepts of Probes better make sure you are aware of the [ChaosEngine](glossary.md) Custom Resources and promql queries (for Prometheus Probes) diff --git a/website/docs/concepts/projects.md b/website/docs/concepts/projects.md index 548cb9b7..49b4a78f 100644 --- a/website/docs/concepts/projects.md +++ b/website/docs/concepts/projects.md @@ -8,7 +8,7 @@ sidebar_label: Projects The ChaosCenter comes with a project management system that can be used for working on chaos experiments with multiple different projects across different chaos infrastructures. -## Prerequisites +## Related concepts Before learning about the concept of projects, it is important to note that a project signifies a separation between Chaos infrastructures, Schedules, [Visualization](visualize-experiment.md), and Teams (discussed in the next section) configurations, and prior knowledge of these will prove fruitful in understanding the concept of projects in-depth. diff --git a/website/docs/concepts/teaming.md b/website/docs/concepts/teaming.md index 9515905f..ebbf2669 100644 --- a/website/docs/concepts/teaming.md +++ b/website/docs/concepts/teaming.md @@ -1,6 +1,6 @@ --- id: teaming -title: Collaborate with teams +title: Team Collaboration sidebar_label: Teaming --- diff --git a/website/docs/user-guides/connecting-git-repo.md b/website/docs/user-guides/connecting-git-repo.md new file mode 100644 index 00000000..c958aadd --- /dev/null +++ b/website/docs/user-guides/connecting-git-repo.md @@ -0,0 +1,60 @@ +--- +id: connecting-git-repo +title: Connecting to a Git Repository +sidebar_label: Connecting Git Repo +--- + +## Prerequisites + +The following are the prerequisites for creating a Chaos Experiment: + +- Fork of [Chaos-Charts](https://github.com/litmuschaos/chaos-charts) repository + +:::note +An active internet connection is required to clone the git repository for the first time installation. +::: + +## Connecting to a Git repository using ChaosHub + +With ChaosHub, you can construct chaos experiments by selecting, tuning and sequencing different faults together from their connected ChaosHubs. + +You can make changes in your forked repositories and sync it with the Portal to get the latest changes from the fork. + +By default, a public ChaosHub is provided when the ChaosCenter is installed for the first time. + + + +### 1. Connect a public Git repository + +You can connect to a public Git repository by simply providing the following details: + +- Hub name +- Git URL of the forked repository +- Branch name + + + +### 2. Connect a private Git repository + +To add a private ChaosHub, you need provide the hub name, Git URL of the forked repository and the branch name similar to that of public hub and the repository can be connected in two ways: + + + +#### a. Access token + +Personal Access Tokens are used as an alternative to the password for authentication to Git services. + +#### b. SSH key + +Just like the Access Token , SSH keys are used for the authentication. These keys come in pairs, a public key that is shared with the Git Services and a private key that is stored with you. +SSH link of the repository should be provided if you select this method. + + + +## Syncing a ChaosHub + +If some changes are made into the Git repository, you can reflect these changes in the hub by selecting the **Refresh Hub** option from the ChaosHub card. + +## Editing a ChaosHub + +To make changes in a hub like changing the name, branch, access token etc, you can select the **Edit Hub** option from the ChaosHub card. \ No newline at end of file diff --git a/website/docs/user-guides/removing-chaoshub.md b/website/docs/user-guides/removing-chaoshub.md new file mode 100644 index 00000000..3ba19726 --- /dev/null +++ b/website/docs/user-guides/removing-chaoshub.md @@ -0,0 +1,7 @@ +--- +id: removing-chaoshub +title: Removing a ChaosHub +sidebar_label: Removing a ChaosHUb +--- + +To remove a ChaosHub from a project, you can select the **Disconnect Hub** option from the ChaosHub card. diff --git a/website/docs/user-guides/viewing-chaos-faults.md b/website/docs/user-guides/viewing-chaos-faults.md new file mode 100644 index 00000000..e868a516 --- /dev/null +++ b/website/docs/user-guides/viewing-chaos-faults.md @@ -0,0 +1,20 @@ +--- +id: viewing-chaos-faults +title: Viewing Chaos Faults +sidebar_label: Viewing Chaos Faults +--- + +### Viewing Chaos Faults + +After connecting a ChaosHub, you can view the different chaos charts and faults. These charts are categorized into different sections such as generic, AWS, Azure, Kube-Components, etc. + + + +### View the fault details + +You can select one of the chaos faults and can examine the fault details. The fault page consists of all the important details like the description of the fault, a tutorial video, the maintainer of the fault, etc. + +You can also find the Experiment manifest URL, RBAC URL, and the ChaosEngine URLs of the fault. +These URLs are required for the creation of custom chaos experiments. + + \ No newline at end of file diff --git a/website/docs/user-guides/viewing-predefined-experiments.md b/website/docs/user-guides/viewing-predefined-experiments.md new file mode 100644 index 00000000..e815c44c --- /dev/null +++ b/website/docs/user-guides/viewing-predefined-experiments.md @@ -0,0 +1,10 @@ +--- +id: viewing-predefined-experiments +title: Viewing Predefined Chaos Experiments +sidebar_label: Viewing Predefined Experiments +--- + + +After connecting a ChaosHub, you can view the different pre-defined chaos experiments present in the ChaosHub. + + \ No newline at end of file diff --git a/website/sidebars.js b/website/sidebars.js index 6b5cdc39..4c5976d8 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -39,6 +39,7 @@ module.exports = { { 'User Guides': [ 'user-guides/overview', + 'user-guides/connecting-git-repo', { 'Advanced Installation': [ { @@ -93,6 +94,7 @@ module.exports = { { 'Managing Projects': ['user-guides/change-project-name', 'user-guides/leave-project'] }, + 'user-guides/removing-chaoshub', { Teaming: [ 'user-guides/invite-team-member', @@ -103,7 +105,9 @@ module.exports = { }, 'user-guides/gitops-configuration', 'user-guides/image-registry', - 'user-guides/uninstall-litmus' + 'user-guides/uninstall-litmus', + 'user-guides/viewing-predefined-experiments', + 'user-guides/viewing-chaos-faults', ] }, { diff --git a/website/versioned_docs/version-3.12.0/concepts/chaoshub.md b/website/versioned_docs/version-3.12.0/concepts/chaoshub.md index 15ccac93..64af71ae 100644 --- a/website/versioned_docs/version-3.12.0/concepts/chaoshub.md +++ b/website/versioned_docs/version-3.12.0/concepts/chaoshub.md @@ -12,87 +12,11 @@ A ChaosHub is a collection of experiment templates and faults that you can use t - Chaos experiments can be created from the public [ChaosHub](http://hub.litmuschaos.io/) which is already connected to your ChaosCenter, or a custom ChaosHub which is a [fork](https://github.com/litmuschaos/chaos-charts) of the public ChaosHub where custom faults can be stored. -## Prerequisites - -The following are the prerequisites for creating a Chaos Experiment: - -- Fork of [Chaos-Charts](https://github.com/litmuschaos/chaos-charts) repository - -:::note -An active internet connection is required to clone the git repository for the first time installation. -::: - -## Connecting to a Git repository using ChaosHub - -With ChaosHub, you can construct chaos experiments by selecting, tuning and sequencing different faults together from their connected ChaosHubs. - -You can make changes in your forked repositories and sync it with the Portal to get the latest changes from the fork. - -By default, a public ChaosHub is provided when the ChaosCenter is installed for the first time. - - - -### 1. Connect a public Git repository - -You can connect to a public Git repository by simply providing the following details: - -- Hub name -- Git URL of the forked repository -- Branch name - - - -### 2. Connect a private Git repository - -To add a private ChaosHub, you need provide the hub name, Git URL of the forked repository and the branch name similar to that of public hub and the repository can be connected in two ways: - - - -#### a. Access token - -Personal Access Tokens are used as an alternative to the password for authentication to Git services. - -#### b. SSH key - -Just like the Access Token , SSH keys are used for the authentication. These keys come in pairs, a public key that is shared with the Git Services and a private key that is stored with you. -SSH link of the repository should be provided if you select this method. - - - -## Syncing a ChaosHub - -If some changes are made into the Git repository, you can reflect these changes in the hub by selecting the **Refresh Hub** option from the ChaosHub card. - -## Editing a ChaosHub - -To make changes in a hub like changing the name, branch, access token etc, you can select the **Edit Hub** option from the ChaosHub card. - ## Chaos experiments and experiments in a ChaosHub -### 1. View the PreDefined Chaos Experiments - -After connecting a ChaosHub, you can view the different pre-defined chaos experiments present in the ChaosHub. - - - -### 2. View the Chaos Faults - -Similarly, you can view the different charts and the fault. These charts are sorted according to different categories like generic, AWS, Azure, Kube-Components etc. - - - -### 3. View the fault details - -You can select one of the chaos faults and can examine the fault details. The fault page consists of all the important details like the description of the fault, a tutorial video, the maintainer of the fault, etc. - -You can also find the Experiment manifest URL, RBAC URL, and the ChaosEngine URLs of the fault. -These URLs are required for the creation of custom chaos experiments. - - - -## Disconnect a ChaosHub +For information on viewing predefined chaos experiments, refer to [Viewing Predefined Chaos Experiments](../user-guides/viewing-predefined-experiments.md). -To remove a ChaosHub from a project, you can select the **Disconnect Hub** option from the ChaosHub card. +For information on viewing chaos faults and their details, refer to [Viewing Chaos Faults](../user-guides/viewing-chaos-faults.md). ## Summary diff --git a/website/versioned_docs/version-3.12.0/concepts/gitops.md b/website/versioned_docs/version-3.12.0/concepts/gitops.md index 05c725ab..6e38dbcc 100644 --- a/website/versioned_docs/version-3.12.0/concepts/gitops.md +++ b/website/versioned_docs/version-3.12.0/concepts/gitops.md @@ -6,7 +6,7 @@ sidebar_label: GitOps --- -## Prerequisites +## Related concepts - Chaos Infrastructure - [Chaos Experiment](chaos-workflow.md) diff --git a/website/versioned_docs/version-3.12.0/concepts/oauth-dex-concept.md b/website/versioned_docs/version-3.12.0/concepts/oauth-dex-concept.md index 0ac2cd33..e8417660 100644 --- a/website/versioned_docs/version-3.12.0/concepts/oauth-dex-concept.md +++ b/website/versioned_docs/version-3.12.0/concepts/oauth-dex-concept.md @@ -6,7 +6,7 @@ sidebar_label: Authentication in ChaosCenter --- -## Prerequisites +## Related concepts - [OAuth](https://oauth.net/specs/) diff --git a/website/versioned_docs/version-3.12.0/concepts/probes.md b/website/versioned_docs/version-3.12.0/concepts/probes.md index 4547c756..6ca97310 100644 --- a/website/versioned_docs/version-3.12.0/concepts/probes.md +++ b/website/versioned_docs/version-3.12.0/concepts/probes.md @@ -8,7 +8,7 @@ sidebar_label: Resilience Probes Resilience Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Experiment. The fault pods execute these checks based on the mode they are defined in & factor their success as necessary conditions in determining the verdict of the fault (along with the standard `in-built` checks). -## Prerequisites +## Related concepts To understand the concepts of Probes better make sure you are aware of the [ChaosEngine](glossary.md) Custom Resources and promql queries (for Prometheus Probes) diff --git a/website/versioned_docs/version-3.12.0/concepts/projects.md b/website/versioned_docs/version-3.12.0/concepts/projects.md index 548cb9b7..49b4a78f 100644 --- a/website/versioned_docs/version-3.12.0/concepts/projects.md +++ b/website/versioned_docs/version-3.12.0/concepts/projects.md @@ -8,7 +8,7 @@ sidebar_label: Projects The ChaosCenter comes with a project management system that can be used for working on chaos experiments with multiple different projects across different chaos infrastructures. -## Prerequisites +## Related concepts Before learning about the concept of projects, it is important to note that a project signifies a separation between Chaos infrastructures, Schedules, [Visualization](visualize-experiment.md), and Teams (discussed in the next section) configurations, and prior knowledge of these will prove fruitful in understanding the concept of projects in-depth. diff --git a/website/versioned_docs/version-3.12.0/concepts/teaming.md b/website/versioned_docs/version-3.12.0/concepts/teaming.md index 9515905f..ebbf2669 100644 --- a/website/versioned_docs/version-3.12.0/concepts/teaming.md +++ b/website/versioned_docs/version-3.12.0/concepts/teaming.md @@ -1,6 +1,6 @@ --- id: teaming -title: Collaborate with teams +title: Team Collaboration sidebar_label: Teaming --- diff --git a/website/versioned_docs/version-3.12.0/user-guides/connecting-git-repo.md b/website/versioned_docs/version-3.12.0/user-guides/connecting-git-repo.md new file mode 100644 index 00000000..c958aadd --- /dev/null +++ b/website/versioned_docs/version-3.12.0/user-guides/connecting-git-repo.md @@ -0,0 +1,60 @@ +--- +id: connecting-git-repo +title: Connecting to a Git Repository +sidebar_label: Connecting Git Repo +--- + +## Prerequisites + +The following are the prerequisites for creating a Chaos Experiment: + +- Fork of [Chaos-Charts](https://github.com/litmuschaos/chaos-charts) repository + +:::note +An active internet connection is required to clone the git repository for the first time installation. +::: + +## Connecting to a Git repository using ChaosHub + +With ChaosHub, you can construct chaos experiments by selecting, tuning and sequencing different faults together from their connected ChaosHubs. + +You can make changes in your forked repositories and sync it with the Portal to get the latest changes from the fork. + +By default, a public ChaosHub is provided when the ChaosCenter is installed for the first time. + + + +### 1. Connect a public Git repository + +You can connect to a public Git repository by simply providing the following details: + +- Hub name +- Git URL of the forked repository +- Branch name + + + +### 2. Connect a private Git repository + +To add a private ChaosHub, you need provide the hub name, Git URL of the forked repository and the branch name similar to that of public hub and the repository can be connected in two ways: + + + +#### a. Access token + +Personal Access Tokens are used as an alternative to the password for authentication to Git services. + +#### b. SSH key + +Just like the Access Token , SSH keys are used for the authentication. These keys come in pairs, a public key that is shared with the Git Services and a private key that is stored with you. +SSH link of the repository should be provided if you select this method. + + + +## Syncing a ChaosHub + +If some changes are made into the Git repository, you can reflect these changes in the hub by selecting the **Refresh Hub** option from the ChaosHub card. + +## Editing a ChaosHub + +To make changes in a hub like changing the name, branch, access token etc, you can select the **Edit Hub** option from the ChaosHub card. \ No newline at end of file diff --git a/website/versioned_docs/version-3.12.0/user-guides/removing-chaoshub.md b/website/versioned_docs/version-3.12.0/user-guides/removing-chaoshub.md new file mode 100644 index 00000000..3ba19726 --- /dev/null +++ b/website/versioned_docs/version-3.12.0/user-guides/removing-chaoshub.md @@ -0,0 +1,7 @@ +--- +id: removing-chaoshub +title: Removing a ChaosHub +sidebar_label: Removing a ChaosHUb +--- + +To remove a ChaosHub from a project, you can select the **Disconnect Hub** option from the ChaosHub card. diff --git a/website/versioned_docs/version-3.12.0/user-guides/viewing-chaos-faults.md b/website/versioned_docs/version-3.12.0/user-guides/viewing-chaos-faults.md new file mode 100644 index 00000000..c69bdb1b --- /dev/null +++ b/website/versioned_docs/version-3.12.0/user-guides/viewing-chaos-faults.md @@ -0,0 +1,18 @@ +--- +id: viewing-chaos-faults +title: Viewing Chaos Faults +sidebar_label: Viewing Chaos Faults +--- + +After connecting a ChaosHub, you can view the different chaos charts and faults. These charts are categorized into different sections such as generic, AWS, Azure, Kube-Components, etc. + + + +### View the fault details + +You can select one of the chaos faults and can examine the fault details. The fault page consists of all the important details like the description of the fault, a tutorial video, the maintainer of the fault, etc. + +You can also find the Experiment manifest URL, RBAC URL, and the ChaosEngine URLs of the fault. +These URLs are required for the creation of custom chaos experiments. + + \ No newline at end of file diff --git a/website/versioned_docs/version-3.12.0/user-guides/viewing-predefined-experiments.md b/website/versioned_docs/version-3.12.0/user-guides/viewing-predefined-experiments.md new file mode 100644 index 00000000..e815c44c --- /dev/null +++ b/website/versioned_docs/version-3.12.0/user-guides/viewing-predefined-experiments.md @@ -0,0 +1,10 @@ +--- +id: viewing-predefined-experiments +title: Viewing Predefined Chaos Experiments +sidebar_label: Viewing Predefined Experiments +--- + + +After connecting a ChaosHub, you can view the different pre-defined chaos experiments present in the ChaosHub. + + \ No newline at end of file diff --git a/website/versioned_sidebars/version-3.12.0-sidebars.json b/website/versioned_sidebars/version-3.12.0-sidebars.json index 9c12b115..3bf839e1 100644 --- a/website/versioned_sidebars/version-3.12.0-sidebars.json +++ b/website/versioned_sidebars/version-3.12.0-sidebars.json @@ -42,6 +42,7 @@ { "User Guides": [ "user-guides/overview", + "user-guides/connecting-git-repo", { "Advanced Installation": [ { @@ -102,6 +103,7 @@ "user-guides/leave-project" ] }, + "user-guides/removing-chaoshub", { "Teaming": [ "user-guides/invite-team-member", @@ -112,7 +114,9 @@ }, "user-guides/gitops-configuration", "user-guides/image-registry", - "user-guides/uninstall-litmus" + "user-guides/uninstall-litmus", + "user-guides/viewing-predefined-experiments", + "user-guides/viewing-chaos-faults" ] }, {