Skip to content

Commit 67cee92

Browse files
Reorganize Getting Started and concepts Sections in Docs
Signed-off-by: andoriyaprashant <[email protected]>
1 parent 36cf0c8 commit 67cee92

19 files changed

+38
-34
lines changed

website/docs/getting-started/resources.md renamed to website/docs/concepts/chaos-center.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
id: resources
3-
title: Resources
4-
sidebar_label: Resources
2+
id: chaos-center
3+
title: ChaosCenter
4+
sidebar_label: ChaosCenter
55
---
66

77
---
@@ -36,4 +36,4 @@ In Litmus, chaos infrastructures can be classified into two types:
3636

3737
- **Self Chaos Infrastructures:** A Chaos Infrastructure that is connected to the same cluster and namespace where the ChaosCenter is deployed. It can be used to target the workloads executing on that cluster only.
3838

39-
- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures.
39+
- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures.

website/docs/concepts/chaos-workflow.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ The term **Chaos Scenario/Workflow** has been changed to **Chaos Experiment**.
2424

2525
The following are required before creating a Chaos Experiment:
2626

27-
- [ChaosCenter](../getting-started/resources.md#chaoscenter)
28-
- [Chaos Infrastructure](../getting-started/resources.md#chaosagents)
27+
- [ChaosCenter](../concepts/chaos-center.md#chaoscenter)
28+
- [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures)
2929
- [Probes](probes.md)
3030

3131
## Defining and executing a chaos experiment

website/docs/concepts/overview.md

+4
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ Probes are pluggable checks that can be defined within the ChaosEngine for any C
1616

1717
ChaosHub allows you to orchestrate chaos experiments from the Public **[ChaosHub](http://hub.litmuschaos.io/)** or an alternate source for the Faults.
1818

19+
### [ChaosCenter](chaos-center.md)
20+
21+
Learn about the core concepts of ChaosCenter, including its architecture, components, and how it integrates with Chaos Infrastructure.
22+
1923
### [Chaos Experiment](chaos-workflow.md)
2024

2125
Chaos Experiment is a set of different operations coupled together to achieve desired chaos impact on a Kubernetes Cluster.

website/docs/user-guides/chaos-infrastructure-installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_label: Chaos Infrastructure Installation
88

99
## Prerequisites
1010

11-
- Before connecting a Chaos Infrastructure to the [ChaosCenter](../getting-started/resources.md#chaoscenter), learn about what is a [Chaos Infrastructure](../getting-started/resources.md#chaosagents) in Litmus.
11+
- Before connecting a Chaos Infrastructure to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), learn about what is a [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) in Litmus.
1212
- Make sure [litmusctl](../litmusctl/installation.md) is installed.
1313

1414
## Connecting Chaos Infrastructure

website/docs/user-guides/image-registry.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ Now, when scheduling a chaos experiment, the image registry changes will be visi
6161
## Learn More
6262
6363
- [What is a Chaos experiment](../concepts/chaos-workflow.md)
64-
- [What is ChaosCenter](../getting-started/resources.md#chaoscenter)
64+
- [What is ChaosCenter](../concepts/chaos-center.md#chaoscenter)

website/docs/user-guides/setup-with-ingress.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_label: Setup with Ingress
88

99
## Prerequisites
1010

11-
Before setting up endpoint with Ingress make sure the [Litmus ChaosCenter](../getting-started/resources.md#chaoscenter) is installed:
11+
Before setting up endpoint with Ingress make sure the [ChaosCenter](../concepts/chaos-center.md#chaoscenter) is installed:
1212

1313
- [Install ChaosCenter with HTTP](../getting-started/installation.md)
1414
- [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)

website/docs/user-guides/setup-without-ingress.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ sidebar_label: Setup without ingress
88

99
## Prerequisites
1010

11-
Before setting up endpoint without Ingress, make sure [ChaosCenter](../getting-started/resources.md#chaoscenter) is installed in either one of these scopes:
11+
Before setting up endpoint without Ingress, make sure [ChaosCenter](../concepts/chaos-center.md#chaoscenter) is installed in either one of these scopes:
1212

13-
- [Install ChaosCenter with HTTP](../getting-started/installation.md))
13+
- [Install ChaosCenter with HTTP](../getting-started/installation.md)
1414
- [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)
1515

1616
## NodePort service setup
@@ -81,5 +81,5 @@ By default you are assigned with a default project with Owner permissions.
8181
## Learn more
8282
8383
- [Setup Endpoints and Access ChaosCenter with Ingress](setup-with-ingress.md)
84-
- [Install ChaosCenter with HTTP](../getting-started/installation.md))
84+
- [Install ChaosCenter with HTTP](../getting-started/installation.md)
8585
- [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)

website/docs/user-guides/uninstall-litmus.md

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

99
## Chaos Infrastructure
1010

11-
To disconnect the [Chaos Infrastructure](../getting-started/resources.md#chaosagents) connected to the [ChaosCenter](../getting-started/resources.md#chaoscenter), follow these steps -
11+
To disconnect the [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) connected to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), follow these steps:
1212

1313
1. Remove the ChaosEngines of the respective Chaos Infrastructure
1414

website/sidebars.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ module.exports = {
1111
]
1212
},
1313
{
14-
'Getting Started': ['getting-started/resources', 'getting-started/installation']
14+
"Getting Started": ["getting-started/installation"]
1515
},
1616
{
1717
Architecture: [
@@ -27,6 +27,7 @@ module.exports = {
2727
'concepts/overview',
2828
'concepts/chaos-infrastructure',
2929
'concepts/chaoshub',
30+
'concepts/chaos-center',
3031
'concepts/chaos-workflow',
3132
'concepts/probes',
3233
'concepts/user-management',

website/src/components/section/Home/Header.jsx

-5
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,6 @@ const Header = () => {
1818
native SREs, QA teams and developers use Litmus to design, orchestrate and analyse chaos in their
1919
environments.
2020
</Paragraph>
21-
<Row>
22-
<Link to="/docs/getting-started/installation">
23-
<ButtonFilled>Get Started</ButtonFilled>
24-
</Link>
25-
</Row>
2621
</div>
2722
<img className="headerImage" src={useBaseUrl('/img/header.png')} alt="Header Image" />
2823
</ResponsiveRow>

website/versioned_docs/version-3.12.0/getting-started/resources.md renamed to website/versioned_docs/version-3.12.0/concepts/chaos-center.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
id: resources
3-
title: Resources
4-
sidebar_label: Resources
2+
id: chaos-center
3+
title: ChaosCenter
4+
sidebar_label: ChaosCenter
55
---
66

77
---
@@ -36,4 +36,4 @@ In Litmus, chaos infrastructures can be classified into two types:
3636

3737
- **Self Chaos Infrastructures:** A Chaos Infrastructure that is connected to the same cluster and namespace where the ChaosCenter is deployed. It can be used to target the workloads executing on that cluster only.
3838

39-
- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures.
39+
- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures.

website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ The term **Chaos Scenario/Workflow** has been changed to **Chaos Experiment**.
2424

2525
The following are required before creating a Chaos Experiment:
2626

27-
- [ChaosCenter](../getting-started/resources.md#chaoscenter)
28-
- [Chaos Infrastructure](../getting-started/resources.md#chaosagents)
27+
- [ChaosCenter](../concepts/chaos-center.md#chaoscenter)
28+
- [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures)
2929
- [Probes](probes.md)
3030

3131
## Defining and executing a chaos experiment

website/versioned_docs/version-3.12.0/concepts/overview.md

+4
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ Probes are pluggable checks that can be defined within the ChaosEngine for any C
1616

1717
ChaosHub allows you to orchestrate chaos experiments from the Public **[ChaosHub](http://hub.litmuschaos.io/)** or an alternate source for the Faults.
1818

19+
### [ChaosCenter](chaos-center.md)
20+
21+
Learn about the core concepts of ChaosCenter, including its architecture, components, and how it integrates with Chaos Infrastructure.
22+
1923
### [Chaos Experiment](chaos-workflow.md)
2024

2125
Chaos Experiment is a set of different operations coupled together to achieve desired chaos impact on a Kubernetes Cluster.

website/versioned_docs/version-3.12.0/user-guides/chaos-infrastructure-installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_label: Chaos Infrastructure Installation
88

99
## Prerequisites
1010

11-
- Before connecting a Chaos Infrastructure to the [ChaosCenter](../getting-started/resources.md#chaoscenter), learn about what is a [Chaos Infrastructure](../getting-started/resources.md#chaosagents) in Litmus.
11+
- Before connecting a Chaos Infrastructure to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), learn about what is a [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) in Litmus.
1212
- Make sure [litmusctl](../litmusctl/installation.md) is installed.
1313

1414
## Connecting Chaos Infrastructure

website/versioned_docs/version-3.12.0/user-guides/image-registry.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ Now, when scheduling a chaos experiment, the image registry changes will be visi
6161
## Learn More
6262
6363
- [What is a Chaos experiment](../concepts/chaos-workflow.md)
64-
- [What is ChaosCenter](../getting-started/resources.md#chaoscenter)
64+
- [What is ChaosCenter](../concepts/chaos-center.md#chaoscenter)

website/versioned_docs/version-3.12.0/user-guides/setup-with-ingress.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_label: Setup with Ingress
88

99
## Prerequisites
1010

11-
Before setting up endpoint with Ingress make sure the [Litmus ChaosCenter](../getting-started/resources.md#chaoscenter) is installed:
11+
Before setting up endpoint with Ingress make sure the [ChaosCenter](../concepts/chaos-center.md#chaoscenter) is installed:
1212

1313
- [Install ChaosCenter with HTTP](../getting-started/installation.md)
1414
- [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)
@@ -104,7 +104,7 @@ spec:
104104
name: letsencrypt
105105
solvers:
106106
- http01:
107-
ingress:
107+
ingress:
108108
class: nginx
109109
```
110110

website/versioned_docs/version-3.12.0/user-guides/setup-without-ingress.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ sidebar_label: Setup without ingress
88

99
## Prerequisites
1010

11-
Before setting up endpoint without Ingress, make sure [ChaosCenter](../getting-started/resources.md#chaoscenter) is installed in either one of these scopes:
11+
Before setting up endpoint without Ingress, make sure [ChaosCenter](../concepts/chaos-center.md#chaoscenter) is installed in either one of these scopes:
1212

13-
- [Install ChaosCenter with HTTP](../getting-started/installation.md))
13+
- [Install ChaosCenter with HTTP](../getting-started/installation.md)
1414
- [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)
1515

1616
## NodePort service setup
@@ -81,5 +81,5 @@ By default you are assigned with a default project with Owner permissions.
8181
## Learn more
8282
8383
- [Setup Endpoints and Access ChaosCenter with Ingress](setup-with-ingress.md)
84-
- [Install ChaosCenter with HTTP](../getting-started/installation.md))
84+
- [Install ChaosCenter with HTTP](../getting-started/installation.md)
8585
- [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)

website/versioned_docs/version-3.12.0/user-guides/uninstall-litmus.md

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

99
## Chaos Infrastructure
1010

11-
To disconnect the [Chaos Infrastructure](../getting-started/resources.md#chaosagents) connected to the [ChaosCenter](../getting-started/resources.md#chaoscenter), follow these steps -
11+
To disconnect the [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) connected to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), follow these steps:
1212

1313
1. Remove the ChaosEngines of the respective Chaos Infrastructure
1414

website/versioned_sidebars/version-3.12.0-sidebars.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
},
1313
{
1414
"Getting Started": [
15-
"getting-started/resources",
1615
"getting-started/installation"
1716
]
1817
},
@@ -30,6 +29,7 @@
3029
"concepts/overview",
3130
"concepts/chaos-infrastructure",
3231
"concepts/chaoshub",
32+
"concepts/chaos-center",
3333
"concepts/chaos-workflow",
3434
"concepts/probes",
3535
"concepts/user-management",

0 commit comments

Comments
 (0)