Skip to content

Commit

Permalink
Corrected Minor Spelling Errors in Documentation (#278)
Browse files Browse the repository at this point in the history
Signed-off-by: andoriyaprashant <[email protected]>
  • Loading branch information
andoriyaprashant authored Jul 20, 2024
1 parent 6858ae9 commit d943443
Show file tree
Hide file tree
Showing 71 changed files with 83 additions and 83 deletions.
2 changes: 1 addition & 1 deletion website/docs/architecture/chaos-control-plane.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Chaos control plane consists of micro-services responsible for the functioning o

- **Web UI:** A React.js based frontend application micro-service with built-in system observability capabilities and an analytics dashboard. It also facilitates teams of users to collaborate over chaos experiments using role-based user accounts.

- **Litmusctl:** A command-line tool that allows management of Litmus Chaos Infrastructure Infrastructure components. It can be used to create chaos infrastructures, project, and manage multiple Litmus accounts.
- **Litmusctl:** A command-line tool that allows management of Litmus Chaos Infrastructure components. It can be used to create chaos infrastructures, project, and manage multiple Litmus accounts.

- **Litmus API:** Refers to two different Litmus APIs, namely Litmus Authentication API and Litmus Portal API:

Expand Down
4 changes: 2 additions & 2 deletions website/docs/architecture/chaos-execution-plane.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ sidebar_label: Chaos execution plane

<img src={require("../assets/chaos-execution-plane.png").default} alt="Chaos Execution Plane" />

Chaos Execution Plane contains the components responsible for orchestrating the chaos injection in the target resources. They get installed in either an external target cluster if an external chaos infrastructure is being used or in the host cluster containing the control plane if a self chaos infrastructure is being used. It can be further segregated into Litmus Chaos Infrastructure Infrastructure components and Litmus Backend Execution Infrastructure components.
Chaos Execution Plane contains the components responsible for orchestrating the chaos injection in the target resources. They get installed in either an external target cluster if an external chaos infrastructure is being used or in the host cluster containing the control plane if a self chaos infrastructure is being used. It can be further segregated into Litmus Chaos Infrastructure components and Litmus Backend Execution Infrastructure components.

## Litmus Execution Plane Components

Litmus Chaos Infrastructure Infrastructure components help facilitate the chaos injection, manage chaos observability, and enable chaos automation for target resources. These components include:
Litmus Chaos Infrastructure components help facilitate the chaos injection, manage chaos observability, and enable chaos automation for target resources. These components include:

1. **Workflow Controller:** The Argo Workflow Controller responsible for the creation of Chaos Experiments using the Chaos Experiment CR.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the

### Does Litmusctl support actions that are currently performed from the portal dashboard?

Yes, Chaos Infrastructure connection, creation and chaos experiment executiom are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md).
Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md).

### How to solve `invalid token` issue in litmusctl?

Expand Down
2 changes: 1 addition & 1 deletion website/docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Glossary
---

:::note
Pleas note that Litmus 3.0 is not backward compatible and will require a fresh installation for users looking to migrate from previous versions
Please note that Litmus 3.0 is not backward compatible and will require a fresh installation for users looking to migrate from previous versions
:::

## Chaos Resources
Expand Down
2 changes: 1 addition & 1 deletion website/docs/integrations/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The following should be required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md)

## Grafana setup with provisioned data source amd dashboards using Prometheus deployment with scrape jobs
## Grafana setup with provisioned data source and dashboards using Prometheus deployment with scrape jobs

The following steps can be followed to set up Grafana with Prometheus for accessing the integrated and interleaved dashboards

Expand Down
2 changes: 1 addition & 1 deletion website/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In GKE you have to setup a firewall rule to allow TCP traffic on the node port.

If this firewall rule is set up, It may be accessible on nodeIp:port where nodeIp is the external IP address of your node.

### While uninstalling Chaoscenter using helm, some components like subscriber, exporter, event, chaos scenatios, etc are not removed.
### While uninstalling Chaoscenter using helm, some components like subscriber, exporter, event, chaos scenarios, etc are not removed.

These are chaos infrastructure components, which are launched by the control plane server, so first disconnect the chaos infrastructure from the portal then uninstall the portal using helm.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Chaos control plane consists of micro-services responsible for the functioning o

- **Web UI:** A React.js based frontend application micro-service with built-in system observability capabilities and an analytics dashboard. It also facilitates teams of users to collaborate over chaos experiments using role-based user accounts.

- **Litmusctl:** A command-line tool that allows management of Litmus Chaos Infrastructure Infrastructure components. It can be used to create chaos infrastructures, project, and manage multiple Litmus accounts.
- **Litmusctl:** A command-line tool that allows management of Litmus Chaos Infrastructure components. It can be used to create chaos infrastructures, project, and manage multiple Litmus accounts.

- **Litmus API:** Refers to two different Litmus APIs, namely Litmus Authentication API and Litmus Portal API:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ sidebar_label: Chaos execution plane

<img src={require("../assets/chaos-execution-plane.png").default} alt="Chaos Execution Plane" />

Chaos Execution Plane contains the components responsible for orchestrating the chaos injection in the target resources. They get installed in either an external target cluster if an external chaos infrastructure is being used or in the host cluster containing the control plane if a self chaos infrastructure is being used. It can be further segregated into Litmus Chaos Infrastructure Infrastructure components and Litmus Backend Execution Infrastructure components.
Chaos Execution Plane contains the components responsible for orchestrating the chaos injection in the target resources. They get installed in either an external target cluster if an external chaos infrastructure is being used or in the host cluster containing the control plane if a self chaos infrastructure is being used. It can be further segregated into Litmus Chaos Infrastructure components and Litmus Backend Execution Infrastructure components.

## Litmus Execution Plane Components

Litmus Chaos Infrastructure Infrastructure components help facilitate the chaos injection, manage chaos observability, and enable chaos automation for target resources. These components include:
Litmus Chaos Infrastructure components help facilitate the chaos injection, manage chaos observability, and enable chaos automation for target resources. These components include:

1. **Workflow Controller:** The Argo Workflow Controller responsible for the creation of Chaos Experiments using the Chaos Experiment CR.

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-3.0.0/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the

### Does Litmusctl support actions that are currently performed from the portal dashboard?

Yes, Chaos Infrastructure connection, creation and chaos experiment executiom are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md).
Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md).

### How to solve `invalid token` issue in litmusctl?

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-3.0.0/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Glossary
---

:::note
Pleas note that Litmus 3.0 is not backward compatible and will require a fresh installation for users looking to migrate from previous versions
Please note that Litmus 3.0 is not backward compatible and will require a fresh installation for users looking to migrate from previous versions
:::

## Chaos Resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The following should be required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md)

## Grafana setup with provisioned data source amd dashboards using Prometheus deployment with scrape jobs
## Grafana setup with provisioned data source and dashboards using Prometheus deployment with scrape jobs

The following steps can be followed to set up Grafana with Prometheus for accessing the integrated and interleaved dashboards

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-3.0.0/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In GKE you have to setup a firewall rule to allow TCP traffic on the node port.

If this firewall rule is set up, It may be accessible on nodeIp:port where nodeIp is the external IP address of your node.

### While uninstalling Chaoscenter using helm, some components like subscriber, exporter, event, chaos scenatios, etc are not removed.
### While uninstalling Chaoscenter using helm, some components like subscriber, exporter, event, chaos scenarios, etc are not removed.

These are chaos infrastructure components, which are launched by the control plane server, so first disconnect the chaos infrastructure from the portal then uninstall the portal using helm.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Chaos Control Plane consists of micro-services responsible for the functioning o

- **Web UI:** A React.js based frontend application micro-service with built-in system observability capabilities and an analytics dashboard. It also facilitates teams of users to collaborate over chaos experiments using role-based user accounts.

- **Litmusctl:** A command-line tool that allows management of Litmus Chaos Infrastructure Infrastructure components. It can be used to create chaos infrastructures, project, and manage multiple Litmus accounts.
- **Litmusctl:** A command-line tool that allows management of Litmus Chaos Infrastructure components. It can be used to create chaos infrastructures, project, and manage multiple Litmus accounts.

- **Litmus API:** Refers to two different Litmus APIs, namely Litmus Authentication API and Litmus Portal API:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ sidebar_label: Chaos Execution Plane

<img src={require("../assets/chaos-execution-plane.png").default} alt="Chaos Execution Plane" />

Chaos Execution Plane contains the components responsible for orchestrating the chaos injection in the target resources. They get installed in either an external target cluster if an external chaos infrastructure is being used or in the host cluster containing the control plane if a self chaos infrastructure is being used. It can be further segregated into Litmus Chaos Infrastructure Infrastructure components and Litmus Backend Execution Infrastructure components.
Chaos Execution Plane contains the components responsible for orchestrating the chaos injection in the target resources. They get installed in either an external target cluster if an external chaos infrastructure is being used or in the host cluster containing the control plane if a self chaos infrastructure is being used. It can be further segregated into Litmus Chaos Infrastructure components and Litmus Backend Execution Infrastructure components.

## Litmus Execution Plane Components

Litmus Chaos Infrastructure Infrastructure components help facilitate the chaos injection, manage chaos observability, and enable chaos automation for target resources. These components include:
Litmus Chaos Infrastructure components help facilitate the chaos injection, manage chaos observability, and enable chaos automation for target resources. These components include:

1. **Workflow Controller:** The Argo Workflow Controller responsible for the creation of Chaos Experiments using the Chaos Experiment CR.

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-3.1.0/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the

### Does Litmusctl support actions that are currently performed from the portal dashboard?

Yes, Chaos Infrastructure connection, creation and chaos experiment executiom are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md).
Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md).

### How to solve `invalid token` issue in litmusctl?

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-3.1.0/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Glossary
---

:::note
Pleas note that Litmus 3.0 is not backward compatible and will require a fresh installation for users looking to migrate from previous versions
Please note that Litmus 3.0 is not backward compatible and will require a fresh installation for users looking to migrate from previous versions
:::

## Chaos Resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The following should be required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md)

## Grafana setup with provisioned data source amd dashboards using Prometheus deployment with scrape jobs
## Grafana setup with provisioned data source and dashboards using Prometheus deployment with scrape jobs

The following steps can be followed to set up Grafana with Prometheus for accessing the integrated and interleaved dashboards

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-3.1.0/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In GKE you have to setup a firewall rule to allow TCP traffic on the node port.

If this firewall rule is set up, It may be accessible on nodeIp:port where nodeIp is the external IP address of your node.

### While uninstalling Chaoscenter using helm, some components like subscriber, exporter, event, chaos scenatios, etc are not removed.
### While uninstalling Chaoscenter using helm, some components like subscriber, exporter, event, chaos scenarios, etc are not removed.

These are chaos infrastructure components, which are launched by the control plane server, so first disconnect the chaos infrastructure from the portal then uninstall the portal using helm.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Chaos Control Plane consists of micro-services responsible for the functioning o

- **Web UI:** A React.js based frontend application micro-service with built-in system observability capabilities and an analytics dashboard. It also facilitates teams of users to collaborate over chaos experiments using role-based user accounts.

- **Litmusctl:** A command-line tool that allows management of Litmus Chaos Infrastructure Infrastructure components. It can be used to create chaos infrastructures, project, and manage multiple Litmus accounts.
- **Litmusctl:** A command-line tool that allows management of Litmus Chaos Infrastructure components. It can be used to create chaos infrastructures, project, and manage multiple Litmus accounts.

- **Litmus API:** Refers to two different Litmus APIs, namely Litmus Authentication API and Litmus Portal API:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ sidebar_label: Chaos Execution Plane

<img src={require("../assets/chaos-execution-plane.png").default} alt="Chaos Execution Plane" />

Chaos Execution Plane contains the components responsible for orchestrating the chaos injection in the target resources. They get installed in either an external target cluster if an external chaos infrastructure is being used or in the host cluster containing the control plane if a self chaos infrastructure is being used. It can be further segregated into Litmus Chaos Infrastructure Infrastructure components and Litmus Backend Execution Infrastructure components.
Chaos Execution Plane contains the components responsible for orchestrating the chaos injection in the target resources. They get installed in either an external target cluster if an external chaos infrastructure is being used or in the host cluster containing the control plane if a self chaos infrastructure is being used. It can be further segregated into Litmus Chaos Infrastructure components and Litmus Backend Execution Infrastructure components.

## Litmus Execution Plane Components

Litmus Chaos Infrastructure Infrastructure components help facilitate the chaos injection, manage chaos observability, and enable chaos automation for target resources. These components include:
Litmus Chaos Infrastructure components help facilitate the chaos injection, manage chaos observability, and enable chaos automation for target resources. These components include:

1. **Workflow Controller:** The Argo Workflow Controller responsible for the creation of Chaos Experiments using the Chaos Experiment CR.

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-3.2.0/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the

### Does Litmusctl support actions that are currently performed from the portal dashboard?

Yes, Chaos Infrastructure connection, creation and chaos experiment executiom are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md).
Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md).

### How to solve `invalid token` issue in litmusctl?

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-3.2.0/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Glossary
---

:::note
Pleas note that Litmus 3.0 is not backward compatible and will require a fresh installation for users looking to migrate from previous versions
Please note that Litmus 3.0 is not backward compatible and will require a fresh installation for users looking to migrate from previous versions
:::

## Chaos Resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The following should be required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md)

## Grafana setup with provisioned data source amd dashboards using Prometheus deployment with scrape jobs
## Grafana setup with provisioned data source and dashboards using Prometheus deployment with scrape jobs

The following steps can be followed to set up Grafana with Prometheus for accessing the integrated and interleaved dashboards

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-3.2.0/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In GKE you have to setup a firewall rule to allow TCP traffic on the node port.

If this firewall rule is set up, It may be accessible on nodeIp:port where nodeIp is the external IP address of your node.

### While uninstalling Chaoscenter using helm, some components like subscriber, exporter, event, chaos scenatios, etc are not removed.
### While uninstalling Chaoscenter using helm, some components like subscriber, exporter, event, chaos scenarios, etc are not removed.

These are chaos infrastructure components, which are launched by the control plane server, so first disconnect the chaos infrastructure from the portal then uninstall the portal using helm.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Chaos Control Plane consists of micro-services responsible for the functioning o

- **Web UI:** A React.js based frontend application micro-service with built-in system observability capabilities and an analytics dashboard. It also facilitates teams of users to collaborate over chaos experiments using role-based user accounts.

- **Litmusctl:** A command-line tool that allows management of Litmus Chaos Infrastructure Infrastructure components. It can be used to create chaos infrastructures, project, and manage multiple Litmus accounts.
- **Litmusctl:** A command-line tool that allows management of Litmus Chaos Infrastructure components. It can be used to create chaos infrastructures, project, and manage multiple Litmus accounts.

- **Litmus API:** Refers to two different Litmus APIs, namely Litmus Authentication API and Litmus Portal API:

Expand Down
Loading

0 comments on commit d943443

Please sign in to comment.