Skip to content

Commit f631caa

Browse files
andoriyaprashantandoriyaprashant
committed
Refactor documentation
1 parent 379de51 commit f631caa

22 files changed

+216
-168
lines changed

Diff for: ‎website/docs/concepts/chaoshub.md

+2-78
Original file line numberDiff line numberDiff line change
@@ -12,87 +12,11 @@ A ChaosHub is a collection of experiment templates and faults that you can use t
1212

1313
- 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.
1414

15-
## Prerequisites
16-
17-
The following are the prerequisites for creating a Chaos Experiment:
18-
19-
- Fork of [Chaos-Charts](https://github.com/litmuschaos/chaos-charts) repository
20-
21-
:::note
22-
An active internet connection is required to clone the git repository for the first time installation.
23-
:::
24-
25-
## Connecting to a Git repository using ChaosHub
26-
27-
With ChaosHub, you can construct chaos experiments by selecting, tuning and sequencing different faults together from their connected ChaosHubs.
28-
29-
You can make changes in your forked repositories and sync it with the Portal to get the latest changes from the fork.
30-
31-
By default, a public ChaosHub is provided when the ChaosCenter is installed for the first time.
32-
33-
<img src={require('../assets/concepts/chaoshub/chaoshub-default.png').default} width="800" />
34-
35-
### 1. Connect a public Git repository
36-
37-
You can connect to a public Git repository by simply providing the following details:
38-
39-
- Hub name
40-
- Git URL of the forked repository
41-
- Branch name
42-
43-
<img src={require('../assets/concepts/chaoshub/chaoshub-add-public.png').default} width="800" />
44-
45-
### 2. Connect a private Git repository
46-
47-
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:
48-
49-
<img src={require('../assets/concepts/chaoshub/chaoshub-add-private.png').default} width="800" />
50-
51-
#### a. Access token
52-
53-
Personal Access Tokens are used as an alternative to the password for authentication to Git services.
54-
55-
#### b. SSH key
56-
57-
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.
58-
SSH link of the repository should be provided if you select this method.
59-
60-
<img src={require('../assets/concepts/chaoshub/chaoshub-after-add.png').default} width="800" />
61-
62-
## Syncing a ChaosHub
63-
64-
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.
65-
66-
## Editing a ChaosHub
67-
68-
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.
69-
7015
## Chaos experiments and experiments in a ChaosHub
7116

72-
### 1. View the PreDefined Chaos Experiments
73-
74-
After connecting a ChaosHub, you can view the different pre-defined chaos experiments present in the ChaosHub.
75-
76-
<img src={require('../assets/concepts/chaoshub/chaoshub-predefined-experiments.png').default} width="800" />
77-
78-
### 2. View the Chaos Faults
79-
80-
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.
81-
82-
<img src={require('../assets/concepts/chaoshub/chaoshub-chaos-charts.png').default} width="800" />
83-
84-
### 3. View the fault details
85-
86-
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.
87-
88-
You can also find the Experiment manifest URL, RBAC URL, and the ChaosEngine URLs of the fault.
89-
These URLs are required for the creation of custom chaos experiments.
90-
91-
<img src={require('../assets/concepts/chaoshub/chaoshub-exp-details.png').default} width="800" />
92-
93-
## Disconnect a ChaosHub
17+
For information on viewing predefined chaos experiments, refer to [Viewing Predefined Chaos Experiments](../user-guides/viewing-predefined-experiments.md).
9418

95-
To remove a ChaosHub from a project, you can select the **Disconnect Hub** option from the ChaosHub card.
19+
For information on viewing chaos faults and their details, refer to [Viewing Chaos Faults](../user-guides/viewing-chaos-faults.md).
9620

9721
## Summary
9822

Diff for: ‎website/docs/concepts/gitops.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: GitOps
66

77
---
88

9-
## Prerequisites
9+
## Related concepts
1010

1111
- Chaos Infrastructure
1212
- [Chaos Experiment](chaos-workflow.md)

Diff for: ‎website/docs/concepts/oauth-dex-concept.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: Authentication in ChaosCenter
66

77
---
88

9-
## Prerequisites
9+
## Related concepts
1010

1111
- [OAuth](https://oauth.net/specs/)
1212

Diff for: ‎website/docs/concepts/probes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_label: Resilience Probes
88

99
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).
1010

11-
## Prerequisites
11+
## Related concepts
1212

1313
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)
1414

Diff for: ‎website/docs/concepts/projects.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_label: Projects
88

99
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.
1010

11-
## Prerequisites
11+
## Related concepts
1212

1313
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.
1414

Diff for: ‎website/docs/concepts/teaming.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: teaming
3-
title: Collaborate with teams
3+
title: Team Collaboration
44
sidebar_label: Teaming
55
---
66

Diff for: ‎website/docs/user-guides/connecting-git-repo.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
id: connecting-git-repo
3+
title: Connecting to a Git Repository
4+
sidebar_label: Connecting Git Repo
5+
---
6+
7+
## Prerequisites
8+
9+
The following are the prerequisites for creating a Chaos Experiment:
10+
11+
- Fork of [Chaos-Charts](https://github.com/litmuschaos/chaos-charts) repository
12+
13+
:::note
14+
An active internet connection is required to clone the git repository for the first time installation.
15+
:::
16+
17+
## Connecting to a Git repository using ChaosHub
18+
19+
With ChaosHub, you can construct chaos experiments by selecting, tuning and sequencing different faults together from their connected ChaosHubs.
20+
21+
You can make changes in your forked repositories and sync it with the Portal to get the latest changes from the fork.
22+
23+
By default, a public ChaosHub is provided when the ChaosCenter is installed for the first time.
24+
25+
<img src={require('../assets/concepts/chaoshub/chaoshub-default.png').default} width="800" />
26+
27+
### 1. Connect a public Git repository
28+
29+
You can connect to a public Git repository by simply providing the following details:
30+
31+
- Hub name
32+
- Git URL of the forked repository
33+
- Branch name
34+
35+
<img src={require('../assets/concepts/chaoshub/chaoshub-add-public.png').default} width="800" />
36+
37+
### 2. Connect a private Git repository
38+
39+
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:
40+
41+
<img src={require('../assets/concepts/chaoshub/chaoshub-add-private.png').default} width="800" />
42+
43+
#### a. Access token
44+
45+
Personal Access Tokens are used as an alternative to the password for authentication to Git services.
46+
47+
#### b. SSH key
48+
49+
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.
50+
SSH link of the repository should be provided if you select this method.
51+
52+
<img src={require('../assets/concepts/chaoshub/chaoshub-after-add.png').default} width="800" />
53+
54+
## Syncing a ChaosHub
55+
56+
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.
57+
58+
## Editing a ChaosHub
59+
60+
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.

Diff for: ‎website/docs/user-guides/removing-chaoshub.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
id: removing-chaoshub
3+
title: Removing a ChaosHub
4+
sidebar_label: Removing a ChaosHUb
5+
---
6+
7+
To remove a ChaosHub from a project, you can select the **Disconnect Hub** option from the ChaosHub card.

Diff for: ‎website/docs/user-guides/viewing-chaos-faults.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
id: viewing-chaos-faults
3+
title: Viewing Chaos Faults
4+
sidebar_label: Viewing Chaos Faults
5+
---
6+
7+
### Viewing Chaos Faults
8+
9+
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.
10+
11+
<img src={require('../assets/concepts/chaoshub/chaoshub-chaos-charts.png').default} width="800" />
12+
13+
### View the fault details
14+
15+
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.
16+
17+
You can also find the Experiment manifest URL, RBAC URL, and the ChaosEngine URLs of the fault.
18+
These URLs are required for the creation of custom chaos experiments.
19+
20+
<img src={require('../assets/concepts/chaoshub/chaoshub-exp-details.png').default} width="800" />

Diff for: ‎website/docs/user-guides/viewing-predefined-experiments.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
id: viewing-predefined-experiments
3+
title: Viewing Predefined Chaos Experiments
4+
sidebar_label: Viewing Predefined Experiments
5+
---
6+
7+
8+
After connecting a ChaosHub, you can view the different pre-defined chaos experiments present in the ChaosHub.
9+
10+
<img src={require('../assets/concepts/chaoshub/chaoshub-predefined-experiments.png').default} width="800" />

Diff for: ‎website/sidebars.js

+5-1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ module.exports = {
3939
{
4040
'User Guides': [
4141
'user-guides/overview',
42+
'user-guides/connecting-git-repo',
4243
{
4344
'Advanced Installation': [
4445
{
@@ -93,6 +94,7 @@ module.exports = {
9394
{
9495
'Managing Projects': ['user-guides/change-project-name', 'user-guides/leave-project']
9596
},
97+
'user-guides/removing-chaoshub',
9698
{
9799
Teaming: [
98100
'user-guides/invite-team-member',
@@ -103,7 +105,9 @@ module.exports = {
103105
},
104106
'user-guides/gitops-configuration',
105107
'user-guides/image-registry',
106-
'user-guides/uninstall-litmus'
108+
'user-guides/uninstall-litmus',
109+
'user-guides/viewing-predefined-experiments',
110+
'user-guides/viewing-chaos-faults',
107111
]
108112
},
109113
{

Diff for: ‎website/versioned_docs/version-3.12.0/concepts/chaoshub.md

+2-78
Original file line numberDiff line numberDiff line change
@@ -12,87 +12,11 @@ A ChaosHub is a collection of experiment templates and faults that you can use t
1212

1313
- 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.
1414

15-
## Prerequisites
16-
17-
The following are the prerequisites for creating a Chaos Experiment:
18-
19-
- Fork of [Chaos-Charts](https://github.com/litmuschaos/chaos-charts) repository
20-
21-
:::note
22-
An active internet connection is required to clone the git repository for the first time installation.
23-
:::
24-
25-
## Connecting to a Git repository using ChaosHub
26-
27-
With ChaosHub, you can construct chaos experiments by selecting, tuning and sequencing different faults together from their connected ChaosHubs.
28-
29-
You can make changes in your forked repositories and sync it with the Portal to get the latest changes from the fork.
30-
31-
By default, a public ChaosHub is provided when the ChaosCenter is installed for the first time.
32-
33-
<img src={require('../assets/concepts/chaoshub/chaoshub-default.png').default} width="800" />
34-
35-
### 1. Connect a public Git repository
36-
37-
You can connect to a public Git repository by simply providing the following details:
38-
39-
- Hub name
40-
- Git URL of the forked repository
41-
- Branch name
42-
43-
<img src={require('../assets/concepts/chaoshub/chaoshub-add-public.png').default} width="800" />
44-
45-
### 2. Connect a private Git repository
46-
47-
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:
48-
49-
<img src={require('../assets/concepts/chaoshub/chaoshub-add-private.png').default} width="800" />
50-
51-
#### a. Access token
52-
53-
Personal Access Tokens are used as an alternative to the password for authentication to Git services.
54-
55-
#### b. SSH key
56-
57-
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.
58-
SSH link of the repository should be provided if you select this method.
59-
60-
<img src={require('../assets/concepts/chaoshub/chaoshub-after-add.png').default} width="800" />
61-
62-
## Syncing a ChaosHub
63-
64-
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.
65-
66-
## Editing a ChaosHub
67-
68-
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.
69-
7015
## Chaos experiments and experiments in a ChaosHub
7116

72-
### 1. View the PreDefined Chaos Experiments
73-
74-
After connecting a ChaosHub, you can view the different pre-defined chaos experiments present in the ChaosHub.
75-
76-
<img src={require('../assets/concepts/chaoshub/chaoshub-predefined-experiments.png').default} width="800" />
77-
78-
### 2. View the Chaos Faults
79-
80-
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.
81-
82-
<img src={require('../assets/concepts/chaoshub/chaoshub-chaos-charts.png').default} width="800" />
83-
84-
### 3. View the fault details
85-
86-
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.
87-
88-
You can also find the Experiment manifest URL, RBAC URL, and the ChaosEngine URLs of the fault.
89-
These URLs are required for the creation of custom chaos experiments.
90-
91-
<img src={require('../assets/concepts/chaoshub/chaoshub-exp-details.png').default} width="800" />
92-
93-
## Disconnect a ChaosHub
17+
For information on viewing predefined chaos experiments, refer to [Viewing Predefined Chaos Experiments](../user-guides/viewing-predefined-experiments.md).
9418

95-
To remove a ChaosHub from a project, you can select the **Disconnect Hub** option from the ChaosHub card.
19+
For information on viewing chaos faults and their details, refer to [Viewing Chaos Faults](../user-guides/viewing-chaos-faults.md).
9620

9721
## Summary
9822

Diff for: ‎website/versioned_docs/version-3.12.0/concepts/gitops.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: GitOps
66

77
---
88

9-
## Prerequisites
9+
## Related concepts
1010

1111
- Chaos Infrastructure
1212
- [Chaos Experiment](chaos-workflow.md)

Diff for: ‎website/versioned_docs/version-3.12.0/concepts/oauth-dex-concept.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: Authentication in ChaosCenter
66

77
---
88

9-
## Prerequisites
9+
## Related concepts
1010

1111
- [OAuth](https://oauth.net/specs/)
1212

Diff for: ‎website/versioned_docs/version-3.12.0/concepts/probes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_label: Resilience Probes
88

99
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).
1010

11-
## Prerequisites
11+
## Related concepts
1212

1313
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)
1414

Diff for: ‎website/versioned_docs/version-3.12.0/concepts/projects.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_label: Projects
88

99
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.
1010

11-
## Prerequisites
11+
## Related concepts
1212

1313
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.
1414

Diff for: ‎website/versioned_docs/version-3.12.0/concepts/teaming.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: teaming
3-
title: Collaborate with teams
3+
title: Team Collaboration
44
sidebar_label: Teaming
55
---
66

0 commit comments

Comments
 (0)