From 941f30934d1154ff4d957f7f778c90c5d2a6556b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adnan=20Rahi=C4=87?= Date: Thu, 26 Sep 2024 10:03:01 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Julianne Fermi --- docs/docs/getting-started/automate-test-runs.mdx | 8 ++++---- docs/docs/getting-started/configure-trace-ingestion.mdx | 8 ++++---- docs/docs/getting-started/create-assertions.mdx | 8 ++++---- docs/docs/getting-started/create-response-based-test.mdx | 4 ++-- docs/docs/getting-started/create-trace-based-test.mdx | 2 +- docs/docs/getting-started/create-tracetest-account.mdx | 2 +- docs/docs/getting-started/install-agent.mdx | 6 +++--- docs/docs/install/on-prem-helm-kind.mdx | 2 +- 8 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/docs/getting-started/automate-test-runs.mdx b/docs/docs/getting-started/automate-test-runs.mdx index ee9873eaaa..5aa15ed9e2 100644 --- a/docs/docs/getting-started/automate-test-runs.mdx +++ b/docs/docs/getting-started/automate-test-runs.mdx @@ -43,7 +43,7 @@ You can define any number of tests to run on a schedule as part of a Synthetic M ## Schedule -Use a cronjob syntax or the Web UI dropdown to configure the schedule when the Synthetic Monitor will run. +Use a CronJob syntax or the Web UI dropdown to configure the schedule when the Synthetic Monitor will run. ## List of Alerts @@ -56,7 +56,7 @@ You can define any number of webhooks to send alerts to. This enables integratin ## Create Synthetic Monitors Programatically in YAML -Using the test you added assertions to in the previous section, you can refernce it in the resource defintion for a Synthetic Monitor. +Using the test you added assertions to in the previous section, you can reference it in the resource definition for a Synthetic Monitor. ```yaml type: Monitor @@ -84,8 +84,8 @@ spec: ### The Synthetic Monitor You Defined 1. Runs the `import-pokemon.yaml` test. -2. It has a schedule of every 5 minutes. -3. It will send a webhook alert to Slack when the test fails. +2. Has a schedule of every 5 minutes. +3. Sends a webhook alert to Slack when the test fails. ## Create Synthetic Monitors Visually with the Web UI diff --git a/docs/docs/getting-started/configure-trace-ingestion.mdx b/docs/docs/getting-started/configure-trace-ingestion.mdx index a8eb9b86f3..617db20a84 100644 --- a/docs/docs/getting-started/configure-trace-ingestion.mdx +++ b/docs/docs/getting-started/configure-trace-ingestion.mdx @@ -19,8 +19,8 @@ import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs'; [Tracetest Agent](/concepts/agent) runs alongside your apps, in the same environment/network, to do two things: -1. Run tests against your apps -2. Ingest traces from your apps +1. Run tests against your apps. +2. Ingest traces from your apps. This page explains (2), how to ingest traces into Tracetest Agent to enable trace-based testing. @@ -96,8 +96,8 @@ Add Tracetest Agent to the same network and use service name mapping. *Example: You can reach services running on your local machine using: -- Linux (docker version < 20.10.0): `172.17.0.1:8080` -- MacOS (docker version >= 18.03) and Linux (docker version >= 20.10.0): `host.docker.internal:8080` +- Linux (Docker version < 20.10.0): `172.17.0.1:8080` +- MacOS (Docker version >= 18.03) and Linux (Docker version >= 20.10.0): `host.docker.internal:8080` ::: diff --git a/docs/docs/getting-started/create-assertions.mdx b/docs/docs/getting-started/create-assertions.mdx index d5bb540226..d8fdde6887 100644 --- a/docs/docs/getting-started/create-assertions.mdx +++ b/docs/docs/getting-started/create-assertions.mdx @@ -185,9 +185,9 @@ This opens the assertions engine. 4. Tracetest **DOES NOT** care about how many services were called internally, or which languages your services are written in, or what database you're using. Tracetest **only cares about the distributed trace data** you expose to use as assertions. 5. Tracetest can validate that things that **DID** or **DID NOT** happen, with just 3 lines of YAML! -## How Selectors Work? +## How Do Selectors Work? -**Selectors** works in a similar way as CSS selectors. You can select spans by matching thier attributes. Attributes can be generic, like span type, duration, or be defined by your apps. +**Selectors** works in a similar way as CSS selectors. You can select spans by matching their attributes. Attributes can be generic, like span type, duration, or be defined by your apps. Here are some examples: @@ -210,7 +210,7 @@ Here are some examples: Check the full [selector docs, here](/concepts/selectors). -## How Assertions Work? +## How Do Assertions Work? Assertions are the checks you can apply to the values of all the spans matched by the related selector. @@ -230,7 +230,7 @@ Here are some examples: Check the full [assertions docs, here](/concepts/assertions). -## How Expressions Work? +## How Do Expressions Work? Tracetest allows you to add expressions when writing test specs. diff --git a/docs/docs/getting-started/create-response-based-test.mdx b/docs/docs/getting-started/create-response-based-test.mdx index 7366d05910..74a7354563 100644 --- a/docs/docs/getting-started/create-response-based-test.mdx +++ b/docs/docs/getting-started/create-response-based-test.mdx @@ -17,7 +17,7 @@ import TabItem from '@theme/TabItem'; import CodeBlock from '@theme/CodeBlock'; import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs'; -To create a test you define a `trigger`. A trigger is an action that executes an action against your system. The most basic trigger is an HTTP requests, but we support several trigger types. +To create a test, you define a `trigger`. A trigger is an action that executes an action against your system. The most basic trigger is an HTTP requests, but we support several trigger types. 1. Playwright 2. HTTP @@ -62,7 +62,7 @@ tracetest run test -f ./ping-google.yaml ## Create a Test Visually with the Web UI -Create a test in the Web UI by opening your Tracetest Account. Click the Create button, and select HTTP. +Create a test in the Web UI by opening your Tracetest Account, clicking the Create button, and selecting HTTP. ![create response based test 1](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727177155/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_qc1291.png) diff --git a/docs/docs/getting-started/create-trace-based-test.mdx b/docs/docs/getting-started/create-trace-based-test.mdx index 453c11cd10..061807e959 100644 --- a/docs/docs/getting-started/create-trace-based-test.mdx +++ b/docs/docs/getting-started/create-trace-based-test.mdx @@ -301,7 +301,7 @@ tracetest run test -f ./import-pokemon.yaml ## Create a Trace-based Test Visually with the Web UI -Create a test in the Web UI by opening your Tracetest Account. Click the Create button, and select HTTP. +Create a test in the Web UI by opening your Tracetest account, clicking the Create button, and selecting HTTP. ![create trace based tests 1](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727192707/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_5_v178q5.png) diff --git a/docs/docs/getting-started/create-tracetest-account.mdx b/docs/docs/getting-started/create-tracetest-account.mdx index 74f4e93241..c6f8ec96d0 100644 --- a/docs/docs/getting-started/create-tracetest-account.mdx +++ b/docs/docs/getting-started/create-tracetest-account.mdx @@ -20,6 +20,6 @@ import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs'; This getting started guide is a quick start with [Cloud-based Managed Tracetest](https://app.tracetest.io/). To use [Enterprise On-prem Tracetest, refer to this guide](/install/on-prem-helm). ::: -1. [Sign in to Cloud-based Managed Tracetest](https://app.tracetest.io/). +1. [Sign into Cloud-based Managed Tracetest](https://app.tracetest.io/). 2. Create an [Organization](/concepts/organizations) and [Environment](/concepts/environments). 3. Copy your [Tracetest Organization API Key/Token and Environment ID](https://app.tracetest.io/retrieve-token). diff --git a/docs/docs/getting-started/install-agent.mdx b/docs/docs/getting-started/install-agent.mdx index 0ae840f9e0..89579a7b7d 100644 --- a/docs/docs/getting-started/install-agent.mdx +++ b/docs/docs/getting-started/install-agent.mdx @@ -19,8 +19,8 @@ import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs'; [Tracetest Agent](/concepts/agent) runs alongside your apps, in the same environment/network, to do two things: -1. Run tests against your apps -2. Ingest traces from your apps +1. Run tests against your apps. +2. Ingest traces from your apps. This page explains (1), how to start Tracetest Agent to enable running tests against your apps. Tracetest Agent can run either locally on your machine or as a container in Docker or Kubernetes. @@ -63,7 +63,7 @@ You can: :::note Docker Network Running a test against `localhost` will resolve as `127.0.0.1` inside the Tracetest Agent container. -To run tests against apps running on your local machine you have two options: +To run tests against apps running on your local machine, you have two options: 1. Run Tracetest Agent locally with the `tracetest start` command. 2. Add Tracetest Agent to the same network and use service name mapping. *Example: Instead of running an app on `localhost:8080`, add it to your Docker Compose file, connect it to the same network as your Tracetest Agent service, and use `:8080` in the URL field when creating a test.* diff --git a/docs/docs/install/on-prem-helm-kind.mdx b/docs/docs/install/on-prem-helm-kind.mdx index 9f58e15f3d..d0b4223215 100644 --- a/docs/docs/install/on-prem-helm-kind.mdx +++ b/docs/docs/install/on-prem-helm-kind.mdx @@ -13,7 +13,7 @@ image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_T --- :::note For Development Environment -This installation is meant for testing purposes only. It uses self signed certificates, so your browser will show a warning about it. +This installation is meant for testing purposes only. It uses self signed certificates so your browser will show a warning about it. ::: :::tip For Production