Skip to content

Commit

Permalink
docs(fix seo issues): fix meta tags based on semrush analysis (#3652)
Browse files Browse the repository at this point in the history
  • Loading branch information
adnanrahic committed Feb 16, 2024
1 parent 95758ba commit a417634
Show file tree
Hide file tree
Showing 11 changed files with 36 additions and 21 deletions.
11 changes: 9 additions & 2 deletions docs/docs/cli/cli-installation-reference.mdx
@@ -1,9 +1,11 @@
---
id: cli-installation-reference
title: CLI Installation Reference
description: Tracetest adds versions to tests by giving the initial version "v1". When something changes in your test it's detected and the test increases the version by 1.
description: This page contains a reference of all options for installing Tracetest CLI. Tracetest has a command line interface (CLI) which includes Tracetest Agent - Enables Tracetest to access your application under test and to ingest trace data from your OpenTelemetry Collector or tracing backend. Tracetest Core Install Wizard - Helps install the Tracetest Core Server into Docker or Kubernetes.
keywords:
- tracetest
- tracetest cli
- tracetest reference
- trace-based testing
- observability
- distributed tracing
Expand All @@ -13,7 +15,12 @@ image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_T

This page contains a reference of all options for installing Tracetest CLI.

Tracetest has a command line interface (CLI) which includes an **install wizard** that helps to install the Tracetest server into Docker or Kubernetes. The CLI can also be used to run tests, download or upload tests, and manage much of the capability of Tracetest.
Tracetest has a command line interface (CLI) which includes:

- [Tracetest Agent](/configuration/agent): Enables Tracetest to access your application under test and to ingest trace data from your OpenTelemetry Collector or tracing backend.
- [Tracetest Core Install Wizard](/core/getting-started/installation): Helps install the Tracetest Core Server into Docker or Kubernetes.

The CLI is used to run tests, download or upload tests, and manage Tracetest capability and resources.

:::tip Want more info?
Read more about the installation guide [here](/getting-started/installation).
Expand Down
12 changes: 6 additions & 6 deletions docs/docs/concepts/ad-hoc-testing.mdx
Expand Up @@ -14,26 +14,26 @@ image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_T
This page showcases use-cases for undefined variables and how to enable ad-hoc testing by utilizing variable sets and undefined variables.

:::tip
[Check out how to configure ad-hoc testing with undefined variables with the **Web UI** here.](../web-ui/undefined-variables)
[Check out how to configure ad-hoc testing with undefined variables with the **Web UI** here.](/web-ui/undefined-variables)
:::

:::tip
[Check out how to configure ad-hoc testing with undefined variables with the **CLI** here.](../cli/undefined-variables)
[Check out how to configure ad-hoc testing with undefined variables with the **CLI** here.](/cli/undefined-variables)
:::

## **Undefined Variables Use Cases**
## Undefined Variables Use Cases

### **Supply Variable Value at Runtime**
### Supply Variable Value at Runtime

A user wants a Test or Test Suite they can run on a particular user, order id, etc. that is configurable at run time. This makes running an adhoc test in an environment, even production, very easy and convenient. In this case, the user references the variable, but doesn't add it to the environment. Each time they run the Test or Test Suite, they will be prompted for the unspecified variables.

### **Supply Variable Value from a Previous Test**
### Supply Variable Value from a Previous Test

A user wants to define 3 tests as part of a Test Suite. The first test has an output variable and this output is used by the second test. They define the first test. They then define the second test and reference the variable value that is output from the first test.

In Tracetest, undefined variables can be used in both the UI and CLI.

## **Undefined Variables Test Suite with Multiple Tests Example**
## Undefined Variables Test Suite with Multiple Tests Example

1. Create an HTTP Pokemon list test that uses variables for hostname and the SKIP query parameter:

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/concepts/agent.mdx
@@ -1,7 +1,7 @@
---
id: agent
title: Tracetest Agent
description: Tracetest Agent is a lightweight, dependency-free agent that runs locally in your development environment, or as a Docker container in your Cloud Native infrastructure.
description: The Tracetest Agent enables Tracetest to access your application under test and to ingest trace data from your OpenTelemetry Collector or tracing backend. Learn about Tracetest Agent concepts and how it works when running in your environment as an executable, Docker container, or in your Cloud Native infrastructure.
keywords:
- tracetest
- trace-based testing
Expand All @@ -11,7 +11,7 @@ keywords:
image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg
---

Tracetest Agent is a lightweight, dependency-free agent that runs locally in your development environment, or as a Docker container in your Cloud Native infrastructure.
The Tracetest Agent enables Tracetest to access your application under test and to ingest trace data from your OpenTelemetry Collector or tracing backend. It's a lightweight, dependency-free, agent that runs in your environment as an executable, Docker container, or in your Cloud Native infrastructure.

## How It Works

Expand Down
6 changes: 4 additions & 2 deletions docs/docs/concepts/architecture.mdx
@@ -1,9 +1,11 @@
---
id: architecture
title: Architecture
description: Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces.
description: Learn about the architecture behind Tracetest. It's the fastest way to pinpoint issues from front end to back end and anywhere in between!
keywords:
- tracetest
- tracetest architecture
- tracetest diagram
- trace-based testing
- observability
- distributed tracing
Expand All @@ -13,4 +15,4 @@ image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_T

The diagram below shows the underlying Tracetest architecture.

![Architecture Diagram](../img/creatingatestdiagram.gif)
![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1708074786/docs/64bea6cd26ea7babdf1261f7_Big-scheme-tracetest-24-07-23_1_1_flpuke.png)
4 changes: 3 additions & 1 deletion docs/docs/concepts/organizations.mdx
@@ -1,10 +1,12 @@
---
id: organizations
title: Organizations
description: Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces.
description: Tracetest organizations contain a collection of environments, team members, and settings. Learn how to manage, create, and edit organizations.
hide_table_of_contents: false
keywords:
- tracetest
- tracetest organizations
- tracetest teams
- trace-based testing
- observability
- distributed tracing
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/concepts/test-suites.mdx
@@ -1,7 +1,7 @@
---
id: test-suites
title: Test Suites
description: Use Tracetest to enable ad-hoc testing by utilizing variable sets and undefined variables.
description: Tracetest has Test Suites to execute multiple tests as in sequence. A Test Suite is defined as a group of steps that are executed in the defined order and can access information exported by previous step executions. Each step is a test.
keywords:
- tracetest
- trace-based testing
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/concepts/variable-sets.mdx
@@ -1,7 +1,7 @@
---
id: variable-sets
title: Variable Sets
description: Use Tracetest to enable ad-hoc testing by utilizing variable sets and undefined variables.
description: Tracetest allows you to organize different environments configurations using global objects called Variable Sets.
keywords:
- tracetest
- trace-based testing
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/configuration/agent.mdx
@@ -1,7 +1,7 @@
---
id: agent
title: Configuring the Tracetest Agent
description: Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces.
description: The Tracetest Agent enables Tracetest to access your application under test and to ingest trace data from your OpenTelemetry Collector or tracing backend. Learn how to configure the Tracetest Agent that runs in your environment as an executable, Docker container, or in your Cloud Native infrastructure.
keywords:
- tracetest
- trace-based testing
Expand All @@ -11,7 +11,7 @@ keywords:
image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg
---

Tracetest Agent is a lightweight, dependency-free, agent that runs locally in your development environment, or as a Docker container in your Cloud Native infrastructure.
The Tracetest Agent enables Tracetest to access your application under test and to ingest trace data from your OpenTelemetry Collector or tracing backend. It's a lightweight, dependency-free, agent that runs in your environment as an executable, Docker container, or in your Cloud Native infrastructure.

## Start Tracetest Agent

Expand Down
6 changes: 5 additions & 1 deletion docs/docs/getting-started/overview.mdx
@@ -1,12 +1,16 @@
---
id: overview
title: Getting Started with Tracetest
description: Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces.
description: Get started with Tracetest, the easiest way to test complex microservice flows fast! Use OpenTelemetry distributed traces to find issues from front end to back end and anywhere in between!
hide_table_of_contents: false
keywords:
- tracetest
- tracetest quick start
- tracetest get started
- trace-based testing
- observability
- observability driven development
- observability driven development quick start
- distributed tracing
- testing
image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/index.mdx
@@ -1,7 +1,7 @@
---
id: index
title: Welcome to Tracetest Docs! 馃憢
description: Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces.
description: Tracetest is a trace-based testing tool for building integration and end-to-end tests in minutes using your OpenTelemetry traces. Assert against your trace data at every point of a request transaction.
hide_table_of_contents: false
keywords:
- tracetest
Expand Down
4 changes: 2 additions & 2 deletions docs/sidebars.js
Expand Up @@ -669,12 +669,12 @@ const sidebars = {
{
type: "doc",
id: "concepts/agent",
label: "Agent",
label: "Tracetest Agent",
},
{
type: "doc",
id: "concepts/cloud-agent",
label: "Cloud Agent (Beta)",
label: "Tracetest Cloud Agent (Beta)",
},
{
type: "doc",
Expand Down

0 comments on commit a417634

Please sign in to comment.