Skip to content

Commit 4a3ea64

Browse files
andoriyaprashantandoriyaprashant
authored
Update TOC and Overview for Consistency (litmuschaos#313)
* Update TOC and Overview Signed-off-by: andoriyaprashant <[email protected]> * Changes Signed-off-by: andoriyaprashant <[email protected]> * Sidebar Signed-off-by: andoriyaprashant <[email protected]> --------- Signed-off-by: andoriyaprashant <[email protected]>
1 parent 5b394ae commit 4a3ea64

14 files changed

+61
-24
lines changed

Diff for: ‎website/docs/concepts/chaos-workflow.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: chaos-workflow
33
title: Chaos experiment
4-
sidebar_label: Chaos experiment
4+
sidebar_label: Chaos Experiment
55
---
66

77
---

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: chaos-infrastructure
33
title: Chaos infrastructure
4-
sidebar_label: Chaos infrastructure
4+
sidebar_label: Chaos Infrastructure
55
---
66

77
Chaos infrastructure is a service that runs in your target environment and aids the Litmus control plane in accessing and injecting chaos at a cloud-native scale. All the chaos infrastructure services adhere to the principle of least privilege, where the services execute with the minimum number of required permissions. A chaos infrastructure can be created under a Chaos Environment.

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

+13-4
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ sidebar_label: Overview
88

99
The Concepts section contains Definitions, Design principles, Terminology and Working technical theory. This section will not have the actual usage instructions or guides those will be made available in the [User Guides](../user-guides/overview.md) section.
1010

11-
### [Probes](probes.md)
11+
### [Chaos Infrastructure](infrastructure.md)
1212

13-
Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Fault.
13+
Chaos infrastructure is a service that runs in your target environment and aids Litmus control plane in accessing and injecting chaos.
1414

1515
### [ChaosHub](chaoshub.md)
1616

@@ -20,9 +20,9 @@ ChaosHub allows you to orchestrate chaos experiments from the Public **[ChaosHub
2020

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

23-
### [Chaos Infrastructure](infrastructure.md)
23+
### [Resilience Probes](probes.md)
2424

25-
Chaos infrastructure is a service that runs in your target environment and aids Litmus control plane in accessing and injecting chaos.
25+
Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Fault.
2626

2727
### [User Management](user-management.md)
2828

@@ -39,3 +39,12 @@ Teaming feature to facilitate collaboration between users using project level ro
3939
### [GitOps](gitops.md)
4040

4141
GitOps feature in Litmus enables you to configure a single source of truth for your chaos experiments and faults.
42+
43+
### [Authentication in ChaosCenter](oauth-dex-concept.md)
44+
45+
Authentication in ChaosCenter supports both local and OAuth-based authentication through the Authentication Server and Dex OIDC Server, offering enhanced flexibility and secure access management.
46+
47+
### [Visualize Chaos Experiment](visualize-experiment.md)
48+
49+
ChaosCenter enables users to visualize the execution of chaos experiments in real-time, displaying key details like step statuses, logs, and results. This visualization helps in analyzing the impact and resiliency of the experiment, with graphs showing the experiment’s progress and individual node information.
50+

Diff for: ‎website/docs/concepts/user-management.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: user-management
33
title: User management
4-
sidebar_label: User management
4+
sidebar_label: User Management
55
---
66

77
---

Diff for: ‎website/docs/concepts/visualize-experiment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: visualize-experiment
33
title: Visualize chaos experiment
4-
sidebar_label: Visualize chaos experiment
4+
sidebar_label: Visualize Chaos Experiment
55
---
66

77
---

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

+12-3
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,18 @@ The User Guides section details Processes, User-flows and How-tos detailing all
1212

1313
Install ChaosCenter and Chaos Infrastructure in various environment configurations.
1414

15+
### [Environments](create-environment.md)
16+
Create, Edit, and Delete Environments used for chaos experiments.
17+
18+
### [Chaos Infrastructure](create-infrastructure.md)
19+
Set up and manage the infrastructure needed for running chaos experiments.
20+
1521
### [Injecting Fault](schedule-experiment.md)
1622

1723
Constructing, Scheduling, Editing and Observing chaos experiments.
1824

19-
### [Event Triggered Chaos using GitOps](gitops-configuration.md)
20-
21-
GitOps in Litmus provides a way of using Event-Driven Chaos Injection, where target resources(stateful sets, deployments, etc.) can be configured to automatically trigger chaos experiment with any changes in the resource spec.
25+
### [Resilience Probes](create-resilience-probe.md)
26+
Define and manage probes that are used to check the resilience of applications during chaos experiments.
2227

2328
### [Account Settings](account-settings.md)
2429

@@ -36,6 +41,10 @@ Probes are pluggable checks that can be defined within the ChaosEngine for any C
3641

3742
Adding members to a project, Editing user-invite and Removing team members from a project.
3843

44+
### [Configuring GitOps](gitops-configuration.md)
45+
46+
GitOps in Litmus provides a way of using Event-Driven Chaos Injection, where target resources(stateful sets, deployments, etc.) can be configured to automatically trigger chaos experiment with any changes in the resource spec.
47+
3948
### [Using different Image Registries in a Chaos Experiment](image-registry.md)
4049

4150
Using different Image Registries like Docker, Red Hat Quay, Google Container Registry in a Chaos Experiment.

Diff for: ‎website/sidebars.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ module.exports = {
3232
'concepts/projects',
3333
'concepts/teaming',
3434
'concepts/gitops',
35-
'concepts/oauth-dex-concept'
35+
'concepts/oauth-dex-concept',
36+
'concepts/visualize-experiment'
3637
]
3738
},
3839
{

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: chaos-workflow
33
title: Chaos experiment
4-
sidebar_label: Chaos experiment
4+
sidebar_label: Chaos Experiment
55
---
66

77
---

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: chaos-infrastructure
33
title: Chaos infrastructure
4-
sidebar_label: Chaos infrastructure
4+
sidebar_label: Chaos Infrastructure
55
---
66

77
Chaos infrastructure is a service that runs in your target environment and aids the Litmus control plane in accessing and injecting chaos at a cloud-native scale. All the chaos infrastructure services adhere to the principle of least privilege, where the services execute with the minimum number of required permissions. A chaos infrastructure can be created under a Chaos Environment.

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

+12-4
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ sidebar_label: Overview
88

99
The Concepts section contains Definitions, Design principles, Terminology and Working technical theory. This section will not have the actual usage instructions or guides those will be made available in the [User Guides](../user-guides/overview.md) section.
1010

11-
### [Probes](probes.md)
11+
### [Chaos Infrastructure](infrastructure.md)
1212

13-
Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Fault.
13+
Chaos infrastructure is a service that runs in your target environment and aids Litmus control plane in accessing and injecting chaos.
1414

1515
### [ChaosHub](chaoshub.md)
1616

@@ -20,9 +20,9 @@ ChaosHub allows you to orchestrate chaos experiments from the Public **[ChaosHub
2020

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

23-
### [Chaos Infrastructure](infrastructure.md)
23+
### [Resilience Probes](probes.md)
2424

25-
Chaos infrastructure is a service that runs in your target environment and aids Litmus control plane in accessing and injecting chaos.
25+
Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Fault.
2626

2727
### [User Management](user-management.md)
2828

@@ -39,3 +39,11 @@ Teaming feature to facilitate collaboration between users using project level ro
3939
### [GitOps](gitops.md)
4040

4141
GitOps feature in Litmus enables you to configure a single source of truth for your chaos experiments and faults.
42+
43+
### [Authentication in ChaosCenter](oauth-dex-concept.md)
44+
45+
Authentication in ChaosCenter supports both local and OAuth-based authentication through the Authentication Server and Dex OIDC Server, offering enhanced flexibility and secure access management.
46+
47+
### [Visualize Chaos Experiment](visualize-experiment.md)
48+
49+
ChaosCenter enables users to visualize the execution of chaos experiments in real-time, displaying key details like step statuses, logs, and results. This visualization helps in analyzing the impact and resiliency of the experiment, with graphs showing the experiment’s progress and individual node information.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: user-management
33
title: User management
4-
sidebar_label: User management
4+
sidebar_label: User Management
55
---
66

77
---

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: visualize-experiment
33
title: Visualize chaos experiment
4-
sidebar_label: Visualize chaos experiment
4+
sidebar_label: Visualize Chaos Experiment
55
---
66

77
---

Diff for: ‎website/versioned_docs/version-3.12.0/user-guides/overview.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,18 @@ The User Guides section details Processes, User-flows and How-tos detailing all
1212

1313
Install ChaosCenter and Chaos Infrastructure in various environment configurations.
1414

15+
### [Environments](create-environment.md)
16+
Create, Edit, and Delete Environments used for chaos experiments.
17+
18+
### [Chaos Infrastructure](create-infrastructure.md)
19+
Set up and manage the infrastructure needed for running chaos experiments.
20+
1521
### [Injecting Fault](schedule-experiment.md)
1622

1723
Constructing, Scheduling, Editing and Observing chaos experiments.
1824

19-
### [Event Triggered Chaos using GitOps](gitops-configuration.md)
20-
21-
GitOps in Litmus provides a way of using Event-Driven Chaos Injection, where target resources(stateful sets, deployments, etc.) can be configured to automatically trigger chaos experiment with any changes in the resource spec.
25+
### [Resilience Probes](create-resilience-probe.md)
26+
Define and manage probes that are used to check the resilience of applications during chaos experiments.
2227

2328
### [Account Settings](account-settings.md)
2429

@@ -36,6 +41,10 @@ Probes are pluggable checks that can be defined within the ChaosEngine for any C
3641

3742
Adding members to a project, Editing user-invite and Removing team members from a project.
3843

44+
### [Configuring GitOps](gitops-configuration.md)
45+
46+
GitOps in Litmus provides a way of using Event-Driven Chaos Injection, where target resources(stateful sets, deployments, etc.) can be configured to automatically trigger chaos experiment with any changes in the resource spec.
47+
3948
### [Using different Image Registries in a Chaos Experiment](image-registry.md)
4049

4150
Using different Image Registries like Docker, Red Hat Quay, Google Container Registry in a Chaos Experiment.

Diff for: ‎website/versioned_sidebars/version-3.12.0-sidebars.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@
3535
"concepts/projects",
3636
"concepts/teaming",
3737
"concepts/gitops",
38-
"concepts/oauth-dex-concept"
38+
"concepts/oauth-dex-concept",
39+
"concepts/visualize-experiment"
3940
]
4041
},
4142
{

0 commit comments

Comments
 (0)