From 4a3ea6452dee449f0624bdaba9f73b210d41637b Mon Sep 17 00:00:00 2001 From: Prashant Andoriya <121665385+andoriyaprashant@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:51:21 +0530 Subject: [PATCH] Update TOC and Overview for Consistency (#313) * Update TOC and Overview Signed-off-by: andoriyaprashant * Changes Signed-off-by: andoriyaprashant * Sidebar Signed-off-by: andoriyaprashant --------- Signed-off-by: andoriyaprashant --- website/docs/concepts/chaos-workflow.md | 2 +- website/docs/concepts/infrastructure.md | 2 +- website/docs/concepts/overview.md | 17 +++++++++++++---- website/docs/concepts/user-management.md | 2 +- website/docs/concepts/visualize-experiment.md | 2 +- website/docs/user-guides/overview.md | 15 ++++++++++++--- website/sidebars.js | 3 ++- .../version-3.12.0/concepts/chaos-workflow.md | 2 +- .../version-3.12.0/concepts/infrastructure.md | 2 +- .../version-3.12.0/concepts/overview.md | 16 ++++++++++++---- .../version-3.12.0/concepts/user-management.md | 2 +- .../concepts/visualize-experiment.md | 2 +- .../version-3.12.0/user-guides/overview.md | 15 ++++++++++++--- .../version-3.12.0-sidebars.json | 3 ++- 14 files changed, 61 insertions(+), 24 deletions(-) diff --git a/website/docs/concepts/chaos-workflow.md b/website/docs/concepts/chaos-workflow.md index 6b34108..e93901d 100644 --- a/website/docs/concepts/chaos-workflow.md +++ b/website/docs/concepts/chaos-workflow.md @@ -1,7 +1,7 @@ --- id: chaos-workflow title: Chaos experiment -sidebar_label: Chaos experiment +sidebar_label: Chaos Experiment --- --- diff --git a/website/docs/concepts/infrastructure.md b/website/docs/concepts/infrastructure.md index 32f743d..a051b36 100644 --- a/website/docs/concepts/infrastructure.md +++ b/website/docs/concepts/infrastructure.md @@ -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. diff --git a/website/docs/concepts/overview.md b/website/docs/concepts/overview.md index 5f2e213..b7171ec 100644 --- a/website/docs/concepts/overview.md +++ b/website/docs/concepts/overview.md @@ -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) @@ -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) @@ -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. + diff --git a/website/docs/concepts/user-management.md b/website/docs/concepts/user-management.md index f339c17..1d24761 100644 --- a/website/docs/concepts/user-management.md +++ b/website/docs/concepts/user-management.md @@ -1,7 +1,7 @@ --- id: user-management title: User management -sidebar_label: User management +sidebar_label: User Management --- --- diff --git a/website/docs/concepts/visualize-experiment.md b/website/docs/concepts/visualize-experiment.md index be2c02f..69c1e09 100644 --- a/website/docs/concepts/visualize-experiment.md +++ b/website/docs/concepts/visualize-experiment.md @@ -1,7 +1,7 @@ --- id: visualize-experiment title: Visualize chaos experiment -sidebar_label: Visualize chaos experiment +sidebar_label: Visualize Chaos Experiment --- --- diff --git a/website/docs/user-guides/overview.md b/website/docs/user-guides/overview.md index 7c253a2..31a5916 100644 --- a/website/docs/user-guides/overview.md +++ b/website/docs/user-guides/overview.md @@ -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) @@ -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. diff --git a/website/sidebars.js b/website/sidebars.js index 2adb26a..1e8d8db 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -32,7 +32,8 @@ module.exports = { 'concepts/projects', 'concepts/teaming', 'concepts/gitops', - 'concepts/oauth-dex-concept' + 'concepts/oauth-dex-concept', + 'concepts/visualize-experiment' ] }, { diff --git a/website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md b/website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md index 6b34108..e93901d 100644 --- a/website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md +++ b/website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md @@ -1,7 +1,7 @@ --- id: chaos-workflow title: Chaos experiment -sidebar_label: Chaos experiment +sidebar_label: Chaos Experiment --- --- diff --git a/website/versioned_docs/version-3.12.0/concepts/infrastructure.md b/website/versioned_docs/version-3.12.0/concepts/infrastructure.md index 32f743d..a051b36 100644 --- a/website/versioned_docs/version-3.12.0/concepts/infrastructure.md +++ b/website/versioned_docs/version-3.12.0/concepts/infrastructure.md @@ -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. diff --git a/website/versioned_docs/version-3.12.0/concepts/overview.md b/website/versioned_docs/version-3.12.0/concepts/overview.md index 5f2e213..64af20a 100644 --- a/website/versioned_docs/version-3.12.0/concepts/overview.md +++ b/website/versioned_docs/version-3.12.0/concepts/overview.md @@ -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) @@ -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) @@ -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. diff --git a/website/versioned_docs/version-3.12.0/concepts/user-management.md b/website/versioned_docs/version-3.12.0/concepts/user-management.md index f339c17..1d24761 100644 --- a/website/versioned_docs/version-3.12.0/concepts/user-management.md +++ b/website/versioned_docs/version-3.12.0/concepts/user-management.md @@ -1,7 +1,7 @@ --- id: user-management title: User management -sidebar_label: User management +sidebar_label: User Management --- --- diff --git a/website/versioned_docs/version-3.12.0/concepts/visualize-experiment.md b/website/versioned_docs/version-3.12.0/concepts/visualize-experiment.md index be2c02f..69c1e09 100644 --- a/website/versioned_docs/version-3.12.0/concepts/visualize-experiment.md +++ b/website/versioned_docs/version-3.12.0/concepts/visualize-experiment.md @@ -1,7 +1,7 @@ --- id: visualize-experiment title: Visualize chaos experiment -sidebar_label: Visualize chaos experiment +sidebar_label: Visualize Chaos Experiment --- --- diff --git a/website/versioned_docs/version-3.12.0/user-guides/overview.md b/website/versioned_docs/version-3.12.0/user-guides/overview.md index 7c253a2..31a5916 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/overview.md +++ b/website/versioned_docs/version-3.12.0/user-guides/overview.md @@ -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) @@ -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. diff --git a/website/versioned_sidebars/version-3.12.0-sidebars.json b/website/versioned_sidebars/version-3.12.0-sidebars.json index 771f291..62c0862 100644 --- a/website/versioned_sidebars/version-3.12.0-sidebars.json +++ b/website/versioned_sidebars/version-3.12.0-sidebars.json @@ -35,7 +35,8 @@ "concepts/projects", "concepts/teaming", "concepts/gitops", - "concepts/oauth-dex-concept" + "concepts/oauth-dex-concept", + "concepts/visualize-experiment" ] }, {