Reorganize Getting Started and concepts Sections in Docs

litmuschaos · Nov 22, 2024 · d60e356 · d60e356
1 parent 36cf0c8
commit d60e356
Show file tree

Hide file tree

Showing 19 changed files with 38 additions and 34 deletions.
diff --git a/website/docs/getting-started/resources.md → website/docs/concepts/chaos-center.md b/website/docs/getting-started/resources.md → website/docs/concepts/chaos-center.md
@@ -1,7 +1,7 @@
 ---
-id: resources
-title: Resources
-sidebar_label: Resources
+id: chaos-center
+title: ChaosCenter
+sidebar_label: ChaosCenter
 ---
 
 ---
@@ -36,4 +36,4 @@ In Litmus, chaos infrastructures can be classified into two types:
 
 - **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.
 
-- **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.
+- **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.
diff --git a/website/docs/concepts/chaos-workflow.md b/website/docs/concepts/chaos-workflow.md
@@ -24,8 +24,8 @@ The term **Chaos Scenario/Workflow** has been changed to **Chaos Experiment**.
 
 The following are required before creating a Chaos Experiment:
 
-- [ChaosCenter](../getting-started/resources.md#chaoscenter)
-- [Chaos Infrastructure](../getting-started/resources.md#chaosagents)
+- [ChaosCenter](../concepts/chaos-center.md#chaoscenter)
+- [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures)
 - [Probes](probes.md)
 
 ## Defining and executing a chaos experiment

diff --git a/website/docs/concepts/overview.md b/website/docs/concepts/overview.md
@@ -16,6 +16,10 @@ Probes are pluggable checks that can be defined within the ChaosEngine for any C
 
 ChaosHub allows you to orchestrate chaos experiments from the Public **[ChaosHub](http://hub.litmuschaos.io/)** or an alternate source for the Faults.
 
+### [ChaosCenter](chaos-center.md)
+
+Learn about the core concepts of ChaosCenter, including its architecture, components, and how it integrates with Chaos Infrastructure.
+
 ### [Chaos Experiment](chaos-workflow.md)
 
 Chaos Experiment is a set of different operations coupled together to achieve desired chaos impact on a Kubernetes Cluster.

diff --git a/website/docs/user-guides/chaos-infrastructure-installation.md b/website/docs/user-guides/chaos-infrastructure-installation.md
@@ -8,7 +8,7 @@ sidebar_label: Chaos Infrastructure Installation
 
 ## Prerequisites
 
-- 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.
+- 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.
 - Make sure [litmusctl](../litmusctl/installation.md) is installed.
 
 ## Connecting Chaos Infrastructure

diff --git a/website/docs/user-guides/image-registry.md b/website/docs/user-guides/image-registry.md
@@ -61,4 +61,4 @@ Now, when scheduling a chaos experiment, the image registry changes will be visi
 ## Learn More
 
 - [What is a Chaos experiment](../concepts/chaos-workflow.md)
-- [What is ChaosCenter](../getting-started/resources.md#chaoscenter)
+- [What is ChaosCenter](../concepts/chaos-center.md#chaoscenter)
diff --git a/website/docs/user-guides/setup-with-ingress.md b/website/docs/user-guides/setup-with-ingress.md
@@ -8,7 +8,7 @@ sidebar_label: Setup with Ingress
 
 ## Prerequisites
 
-Before setting up endpoint with Ingress make sure the [Litmus ChaosCenter](../getting-started/resources.md#chaoscenter) is installed:
+Before setting up endpoint with Ingress make sure the [ChaosCenter](../concepts/chaos-center.md#chaoscenter) is installed:
 
 - [Install ChaosCenter with HTTP](../getting-started/installation.md)
 - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)

diff --git a/website/docs/user-guides/setup-without-ingress.md b/website/docs/user-guides/setup-without-ingress.md
@@ -8,9 +8,9 @@ sidebar_label: Setup without ingress
 
 ## Prerequisites
 
-Before setting up endpoint without Ingress, make sure [ChaosCenter](../getting-started/resources.md#chaoscenter) is installed in either one of these scopes:
+Before setting up endpoint without Ingress, make sure [ChaosCenter](../concepts/chaos-center.md#chaoscenter) is installed in either one of these scopes:
 
-- [Install ChaosCenter with HTTP](../getting-started/installation.md))
+- [Install ChaosCenter with HTTP](../getting-started/installation.md)
 - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)
 
 ## NodePort service setup
@@ -81,5 +81,5 @@ By default you are assigned with a default project with Owner permissions.
 ## Learn more
 
 - [Setup Endpoints and Access ChaosCenter with Ingress](setup-with-ingress.md)
-- [Install ChaosCenter with HTTP](../getting-started/installation.md))
+- [Install ChaosCenter with HTTP](../getting-started/installation.md)
 - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)
diff --git a/website/docs/user-guides/uninstall-litmus.md b/website/docs/user-guides/uninstall-litmus.md
@@ -8,7 +8,7 @@ sidebar_label: Uninstall Litmus
 
 ## Chaos Infrastructure
 
-To disconnect the [Chaos Infrastructure](../getting-started/resources.md#chaosagents) connected to the [ChaosCenter](../getting-started/resources.md#chaoscenter), follow these steps -
+To disconnect the [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) connected to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), follow these steps:
 
 1. Remove the ChaosEngines of the respective Chaos Infrastructure
 

diff --git a/website/sidebars.js b/website/sidebars.js
@@ -11,7 +11,7 @@ module.exports = {
       ]
     },
     {
-      'Getting Started': ['getting-started/resources', 'getting-started/installation']
+      "Getting Started": ["getting-started/installation"]
     },
     {
       Architecture: [
@@ -27,6 +27,7 @@ module.exports = {
         'concepts/overview',
         'concepts/chaos-infrastructure',
         'concepts/chaoshub',
+        'concepts/chaos-center',
         'concepts/chaos-workflow',
         'concepts/probes',
         'concepts/user-management',

diff --git a/website/src/components/section/Home/Header.jsx b/website/src/components/section/Home/Header.jsx
@@ -18,11 +18,6 @@ const Header = () => {
           native SREs, QA teams and developers use Litmus to design, orchestrate and analyse chaos in their
           environments.
         </Paragraph>
-        <Row>
-          <Link to="/docs/getting-started/installation">
-            <ButtonFilled>Get Started</ButtonFilled>
-          </Link>
-        </Row>
       </div>
       <img className="headerImage" src={useBaseUrl('/img/header.png')} alt="Header Image" />
     </ResponsiveRow>

diff --git a/...rsion-3.12.0/getting-started/resources.md → ...s/version-3.12.0/concepts/chaos-center.md b/...rsion-3.12.0/getting-started/resources.md → ...s/version-3.12.0/concepts/chaos-center.md
@@ -1,7 +1,7 @@
 ---
-id: resources
-title: Resources
-sidebar_label: Resources
+id: chaos-center
+title: ChaosCenter
+sidebar_label: ChaosCenter
 ---
 
 ---
@@ -36,4 +36,4 @@ In Litmus, chaos infrastructures can be classified into two types:
 
 - **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.
 
-- **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.
+- **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.
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
@@ -24,8 +24,8 @@ The term **Chaos Scenario/Workflow** has been changed to **Chaos Experiment**.
 
 The following are required before creating a Chaos Experiment:
 
-- [ChaosCenter](../getting-started/resources.md#chaoscenter)
-- [Chaos Infrastructure](../getting-started/resources.md#chaosagents)
+- [ChaosCenter](../concepts/chaos-center.md#chaoscenter)
+- [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures)
 - [Probes](probes.md)
 
 ## Defining and executing a chaos experiment

diff --git a/website/versioned_docs/version-3.12.0/concepts/overview.md b/website/versioned_docs/version-3.12.0/concepts/overview.md
@@ -16,6 +16,10 @@ Probes are pluggable checks that can be defined within the ChaosEngine for any C
 
 ChaosHub allows you to orchestrate chaos experiments from the Public **[ChaosHub](http://hub.litmuschaos.io/)** or an alternate source for the Faults.
 
+### [ChaosCenter](chaos-center.md)
+
+Learn about the core concepts of ChaosCenter, including its architecture, components, and how it integrates with Chaos Infrastructure.
+
 ### [Chaos Experiment](chaos-workflow.md)
 
 Chaos Experiment is a set of different operations coupled together to achieve desired chaos impact on a Kubernetes Cluster.

diff --git a/.../versioned_docs/version-3.12.0/user-guides/chaos-infrastructure-installation.md b/.../versioned_docs/version-3.12.0/user-guides/chaos-infrastructure-installation.md
@@ -8,7 +8,7 @@ sidebar_label: Chaos Infrastructure Installation
 
 ## Prerequisites
 
-- 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.
+- 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.
 - Make sure [litmusctl](../litmusctl/installation.md) is installed.
 
 ## Connecting Chaos Infrastructure

diff --git a/website/versioned_docs/version-3.12.0/user-guides/image-registry.md b/website/versioned_docs/version-3.12.0/user-guides/image-registry.md
@@ -61,4 +61,4 @@ Now, when scheduling a chaos experiment, the image registry changes will be visi
 ## Learn More
 
 - [What is a Chaos experiment](../concepts/chaos-workflow.md)
-- [What is ChaosCenter](../getting-started/resources.md#chaoscenter)
+- [What is ChaosCenter](../concepts/chaos-center.md#chaoscenter)
diff --git a/website/versioned_docs/version-3.12.0/user-guides/setup-with-ingress.md b/website/versioned_docs/version-3.12.0/user-guides/setup-with-ingress.md
@@ -8,7 +8,7 @@ sidebar_label: Setup with Ingress
 
 ## Prerequisites
 
-Before setting up endpoint with Ingress make sure the [Litmus ChaosCenter](../getting-started/resources.md#chaoscenter) is installed:
+Before setting up endpoint with Ingress make sure the [ChaosCenter](../concepts/chaos-center.md#chaoscenter) is installed:
 
 - [Install ChaosCenter with HTTP](../getting-started/installation.md)
 - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)
@@ -104,7 +104,7 @@ spec:
       name: letsencrypt
     solvers:
     - http01:
-     	ingress:
+      ingress:
         class: nginx
 ```
 

diff --git a/website/versioned_docs/version-3.12.0/user-guides/setup-without-ingress.md b/website/versioned_docs/version-3.12.0/user-guides/setup-without-ingress.md
@@ -8,9 +8,9 @@ sidebar_label: Setup without ingress
 
 ## Prerequisites
 
-Before setting up endpoint without Ingress, make sure [ChaosCenter](../getting-started/resources.md#chaoscenter) is installed in either one of these scopes:
+Before setting up endpoint without Ingress, make sure [ChaosCenter](../concepts/chaos-center.md#chaoscenter) is installed in either one of these scopes:
 
-- [Install ChaosCenter with HTTP](../getting-started/installation.md))
+- [Install ChaosCenter with HTTP](../getting-started/installation.md)
 - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)
 
 ## NodePort service setup
@@ -81,5 +81,5 @@ By default you are assigned with a default project with Owner permissions.
 ## Learn more
 
 - [Setup Endpoints and Access ChaosCenter with Ingress](setup-with-ingress.md)
-- [Install ChaosCenter with HTTP](../getting-started/installation.md))
+- [Install ChaosCenter with HTTP](../getting-started/installation.md)
 - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)
diff --git a/website/versioned_docs/version-3.12.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.12.0/user-guides/uninstall-litmus.md
@@ -8,7 +8,7 @@ sidebar_label: Uninstall Litmus
 
 ## Chaos Infrastructure
 
-To disconnect the [Chaos Infrastructure](../getting-started/resources.md#chaosagents) connected to the [ChaosCenter](../getting-started/resources.md#chaoscenter), follow these steps -
+To disconnect the [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) connected to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), follow these steps:
 
 1. Remove the ChaosEngines of the respective Chaos Infrastructure
 

diff --git a/website/versioned_sidebars/version-3.12.0-sidebars.json b/website/versioned_sidebars/version-3.12.0-sidebars.json
@@ -12,7 +12,6 @@
     },
     {
       "Getting Started": [
-        "getting-started/resources",
         "getting-started/installation"
       ]
     },
@@ -30,6 +29,7 @@
         "concepts/overview",
         "concepts/chaos-infrastructure",
         "concepts/chaoshub",
+        "concepts/chaos-center",
         "concepts/chaos-workflow",
         "concepts/probes",
         "concepts/user-management",