Apply suggestions from code review

Co-authored-by: Julianne Fermi <[email protected]>
kubeshop · Aug 19, 2024 · 9cbda7b · 9cbda7b
1 parent 06d51e2
commit 9cbda7b
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 15 deletions.
diff --git a/docs/docs/getting-started/installation.mdx b/docs/docs/getting-started/installation.mdx
@@ -240,7 +240,7 @@ This installation is meant for testing purposes only. It uses self signed certif
 For the Production-ready installation:
 
 - [View the official Helm chart readme](https://github.com/kubeshop/tracetest-cloud-charts/blob/main/README.md).
-- [View the official installation docs](/install/helm)
+- [View the official installation docs](/install/helm).
 :::
 
 1. Install [Helm](https://helm.sh/) and [kind](https://kind.sigs.k8s.io/) on your machine. Clone the official Tracetest Helm chart.

diff --git a/docs/docs/install/cli.mdx b/docs/docs/install/cli.mdx
@@ -17,7 +17,7 @@ image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_T
 
 import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs';
 
-This guide explain how to configure Cloud-based managed Tracetest with the Tracetest CLI, and install a Tracetest Agent in your local development environment. This deployment uses the Cloud-based managed Tracetest Control Plane and Dashboard.
+This guide explains how to configure Cloud-based managed Tracetest with the Tracetest CLI and install a Tracetest Agent in your local development environment. This deployment uses the Cloud-based managed Tracetest Control Plane and Dashboard.
 
 ## Prerequisites
 
@@ -54,7 +54,7 @@ You can:
   Stop this agent
 ```
 
-Tracetest Agent runs tests and ingests traces. It exposes OTLP ports `4317` (gRPC) and `4318` (HTTP) for trace ingestion. In this example you can trigger tests against apps running in your local environment on `localhost`, and export traces from your local apps to `localhost` as well.
+Tracetest Agent runs tests and ingests traces. It exposes OTLP ports `4317` (gRPC) and `4318` (HTTP) for trace ingestion. In this example you can trigger tests against apps running in your local environment on `localhost` and export traces from your local apps to `localhost` as well.
 
 To ingest traces in this example with Tracetest Agent use these URLs:
 

diff --git a/docs/docs/install/deployment-architecture.mdx b/docs/docs/install/deployment-architecture.mdx
@@ -21,7 +21,7 @@ You can deploy Tracetest in two ways.
 - Deploy Tracetest Agent and use the Cloud-based managed Control Plane.
 - Deploy both Tracetest Agent and Control Plane On-Prem.
 
-## Enterprise self-hosted Tracetest
+## Enterprise Self-hosted Tracetest
 
 With Enterprise self-hosted Tracetest you deploy both the control plane and agent in your own infrastructure.
 
@@ -31,7 +31,7 @@ To deploy Enterprise self-hosted Tracetest follow the [installing with Helm guid
 
 Enterprise self-hosted Tracetest is composed of multiple services:
 
-- **Frontend**: WebUI used to interact with the Tracetest, allowing users to [create and manage tests](https://docs.tracetest.io/web-ui/creating-tests).
+- **Frontend**: the WebUI used to interact with Tracetest, allowing users to [create and manage tests](https://docs.tracetest.io/web-ui/creating-tests).
 - **Cloud/Core API**: APIs that are called directly by the Frontend, the Tracetest CLI and the Tracetest Agent to perform operations on the systems, like creating and running tests.
 - **Ory Ecosystem**: Tracetest relies on the [Ory Ecosystem](https://www.ory.sh/) for authentication and authorization. This includes [Ory Kratos](https://www.ory.sh/kratos/docs/), [Ory Keto](https://www.ory.sh/keto/docs/), and [Ory Oathkeeper](https://www.ory.sh/oathkeeper/docs/).
 - **Tracetest Workers**: A set of workers that manage the test execution.
@@ -110,7 +110,7 @@ Your main domain is `tracetest.mydomain.com`. You need to setup `tracetest.mydom
 
 ### Cert Manager
 
-Tracetest uses cert-manager to create sign certificates for JWT tokens, and SSL certificates for Ingress.
+Tracetest uses cert-manager to create sign certificates for JWT tokens and SSL certificates for Ingress.
 
 ```bash title="Terminal"
 helm repo add jetstack https://charts.jetstack.io --force-update
@@ -190,7 +190,7 @@ global:
 
 ### SSO
 
-This chart comes with an **EXTREMELY INSECURE** default GitHub OAuth App. It is used for demo purposes only, and should not under any circumstances be used in any real environment.
+This chart comes with an **EXTREMELY INSECURE** default GitHub OAuth App. It is used for demo purposes only and should not, under any circumstances, be used in any real environment.
 
 You can enable GitHub and Google SSO by creating corresponding Apps and setting the credentials in `values.yaml`:
 
@@ -205,11 +205,11 @@ global:
       clientSecret: "clientSecret"
 ```
 
-## Cloud-based managed Tracetest
+## Cloud-based Managed Tracetest
 
 With Cloud-based managed Tracetest you only deploy an agent in your infrastructure.
 
-To deploy Tracetest Agent follow the [installing guide](/install/cli).
+To deploy Tracetest Agent follow the [installation guide](/install/cli).
 
 ## Architecture
 

diff --git a/docs/docs/install/docker.mdx b/docs/docs/install/docker.mdx
@@ -15,7 +15,7 @@ keywords:
 image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg
 ---
 
-This guide explain how to install a Tracetest Agent in your Docker (and Docker Compose) environment. This deployment uses the Cloud-based managed Tracetest Control Plane and Dashboard.
+This guide explains how to install a Tracetest Agent in your Docker (and Docker Compose) environment. This deployment uses the Cloud-based managed Tracetest Control Plane and Dashboard.
 
 ## Prerequisites
 

diff --git a/docs/docs/install/gcp.mdx b/docs/docs/install/gcp.mdx
@@ -11,13 +11,13 @@ keywords:
 image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg
 ---
 
-Installation and deployment instructions for using Helm to deploy Enterprise self-hosted Tracetest in GCP (GKE) and use the On-Prem Tracetest Control Plane / Dashboard.
+Installation and deployment instructions for using Helm to deploy Enterprise self-hosted Tracetest in GCP (GKE) and use the On-Prem Tracetest Control Plane/Dashboard.
 
 ## Prerequisites
 
-- A Kubernetes cluster running on GKE ([installation instructions](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-an-autopilot-cluster))
-- Traefik installed in your cluster ([installation instructions](https://doc.traefik.io/traefik/getting-started/install-traefik/))
-- Cert Manager installed in your cluster ([installation instructions](https://cert-manager.io/docs/installation/kubernetes/))
+- A Kubernetes cluster running on GKE ([installation instructions](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-an-autopilot-cluster)).
+- Traefik installed in your cluster ([installation instructions](https://doc.traefik.io/traefik/getting-started/install-traefik/)).
+- A Cert Manager installed in your cluster ([installation instructions](https://cert-manager.io/docs/installation/kubernetes/)).
 - A Tracetest license key. If you don't have one, you can request a trial license key [here](https://tracetest.io/on-prem-installation).
 - Install [`kubectl`](https://kubernetes.io/docs/tasks/tools/#kubectl).
 - Install [Helm](https://helm.sh/).
@@ -47,7 +47,7 @@ helm install cert-manager jetstack/cert-manager      \
 
 ### Traefik
 
-Also, you will need to have a Traefik proxy, that will handle all connections to the Tracetest services. You can install Traefik, by creating a `values-traefik.yaml` file with the following content:
+Also, you will need to have a Traefik proxy, that will handle all connections to the Tracetest services. You can install Traefik by creating a `values-traefik.yaml` file with the following content:
 
 ```yaml title="values-traefik.yaml"
 dnsNames: