Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update TOC and Overview for Consistency #313

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/docs/concepts/chaos-workflow.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: chaos-workflow
title: Chaos experiment
sidebar_label: Chaos experiment
sidebar_label: Chaos Experiment
---

---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/concepts/infrastructure.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: chaos-infrastructure
title: Chaos infrastructure
sidebar_label: Chaos infrastructure
sidebar_label: Chaos Infrastructure
---

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.
Expand Down
17 changes: 13 additions & 4 deletions website/docs/concepts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ sidebar_label: Overview

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.

### [Probes](probes.md)
### [Chaos Infrastructure](infrastructure.md)

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

### [ChaosHub](chaoshub.md)

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

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

### [Chaos Infrastructure](infrastructure.md)
### [Resilience Probes](probes.md)

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

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

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

GitOps feature in Litmus enables you to configure a single source of truth for your chaos experiments and faults.

### [Authentication in ChaosCenter](oauth-dex-concept.md)

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.

### [Visualize Chaos Experiment](visualize-experiment.md)

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.

2 changes: 1 addition & 1 deletion website/docs/concepts/user-management.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: user-management
title: User management
sidebar_label: User management
sidebar_label: User Management
---

---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/concepts/visualize-experiment.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: visualize-experiment
title: Visualize chaos experiment
sidebar_label: Visualize chaos experiment
sidebar_label: Visualize Chaos Experiment
---

---
Expand Down
15 changes: 12 additions & 3 deletions website/docs/user-guides/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,18 @@ The User Guides section details Processes, User-flows and How-tos detailing all

Install ChaosCenter and Chaos Infrastructure in various environment configurations.

### [Environments](create-environment.md)
Create, Edit, and Delete Environments used for chaos experiments.

### [Chaos Infrastructure](create-infrastructure.md)
Set up and manage the infrastructure needed for running chaos experiments.

### [Injecting Fault](schedule-experiment.md)

Constructing, Scheduling, Editing and Observing chaos experiments.

### [Event Triggered Chaos using GitOps](gitops-configuration.md)

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.
### [Resilience Probes](create-resilience-probe.md)
Define and manage probes that are used to check the resilience of applications during chaos experiments.

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

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

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

### [Configuring GitOps](gitops-configuration.md)

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.

### [Using different Image Registries in a Chaos Experiment](image-registry.md)

Using different Image Registries like Docker, Red Hat Quay, Google Container Registry in a Chaos Experiment.
Expand Down
3 changes: 2 additions & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ module.exports = {
'concepts/projects',
'concepts/teaming',
'concepts/gitops',
'concepts/oauth-dex-concept'
'concepts/oauth-dex-concept',
'concepts/visualize-experiment'
]
},
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: chaos-workflow
title: Chaos experiment
sidebar_label: Chaos experiment
sidebar_label: Chaos Experiment
---

---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: chaos-infrastructure
title: Chaos infrastructure
sidebar_label: Chaos infrastructure
sidebar_label: Chaos Infrastructure
---

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.
Expand Down
16 changes: 12 additions & 4 deletions website/versioned_docs/version-3.12.0/concepts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ sidebar_label: Overview

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.

### [Probes](probes.md)
### [Chaos Infrastructure](infrastructure.md)

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

### [ChaosHub](chaoshub.md)

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

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

### [Chaos Infrastructure](infrastructure.md)
### [Resilience Probes](probes.md)

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

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

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

GitOps feature in Litmus enables you to configure a single source of truth for your chaos experiments and faults.

### [Authentication in ChaosCenter](oauth-dex-concept.md)

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.

### [Visualize Chaos Experiment](visualize-experiment.md)

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.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: user-management
title: User management
sidebar_label: User management
sidebar_label: User Management
---

---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: visualize-experiment
title: Visualize chaos experiment
sidebar_label: Visualize chaos experiment
sidebar_label: Visualize Chaos Experiment
---

---
Expand Down
15 changes: 12 additions & 3 deletions website/versioned_docs/version-3.12.0/user-guides/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,18 @@ The User Guides section details Processes, User-flows and How-tos detailing all

Install ChaosCenter and Chaos Infrastructure in various environment configurations.

### [Environments](create-environment.md)
Create, Edit, and Delete Environments used for chaos experiments.

### [Chaos Infrastructure](create-infrastructure.md)
Set up and manage the infrastructure needed for running chaos experiments.

### [Injecting Fault](schedule-experiment.md)

Constructing, Scheduling, Editing and Observing chaos experiments.

### [Event Triggered Chaos using GitOps](gitops-configuration.md)

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.
### [Resilience Probes](create-resilience-probe.md)
Define and manage probes that are used to check the resilience of applications during chaos experiments.

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

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

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

### [Configuring GitOps](gitops-configuration.md)

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.

### [Using different Image Registries in a Chaos Experiment](image-registry.md)

Using different Image Registries like Docker, Red Hat Quay, Google Container Registry in a Chaos Experiment.
Expand Down
3 changes: 2 additions & 1 deletion website/versioned_sidebars/version-3.12.0-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@
"concepts/projects",
"concepts/teaming",
"concepts/gitops",
"concepts/oauth-dex-concept"
"concepts/oauth-dex-concept",
"concepts/visualize-experiment"
]
},
{
Expand Down
Loading