docs(get-started): new simplified onboarding flow (#4029)

* docs(getting-started): break down steps into smaller chunks * docs(get-started): finalize step-by-step guide * docs(get-started): remove "installation" page * docs(gs): fix redirect * Apply suggestions from code review Co-authored-by: Julianne Fermi <[email protected]> * docs(gs): improve seo description --------- Co-authored-by: Julianne Fermi <[email protected]>
kubeshop · Sep 26, 2024 · c2d1f43 · c2d1f43
1 parent 7007ebf
commit c2d1f43
Show file tree

Hide file tree

Showing 66 changed files with 1,398 additions and 84 deletions.
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@
 
 <b>
   <p align="center">
-    <a href="https://docs.tracetest.io/getting-started/installation">
+    <a href="https://docs.tracetest.io/getting-started/overview">
       Get Started! &nbsp;👉&nbsp;
     </a>
   </p>
@@ -145,7 +145,7 @@ You can:
 
 ## Cloud-based Managed Tracetest (Free to get started!)
 
-The easiest and most reliable way to test microservices and distributed apps with OpenTelemetry distributed traces is signing up for free at [app.tracetest.io](https://app.tracetest.io/). After creating an account, getting started is as easy as [installing the Tracetest Agent](https://docs.tracetest.io/getting-started/installation).
+The easiest and most reliable way to test microservices and distributed apps with OpenTelemetry distributed traces is signing up for free at [app.tracetest.io](https://app.tracetest.io/). After creating an account, getting started is as easy as [installing the Tracetest Agent](https://docs.tracetest.io/getting-started/overview).
 
 ## Enterprise Self-hosted Tracetest (1 month free trial!)
 
@@ -161,7 +161,7 @@ Get the same experience as with the Cloud-based Managed Tracetest but self-hoste
 curl -L https://raw.githubusercontent.com/kubeshop/tracetest/main/install-cli.sh | bash -s
 ```
 
-> [:gear: Read the CLI installation docs for more options and instructions.](https://docs.tracetest.io/getting-started/installation#install-the-tracetest-cli)
+> [:gear: Read the CLI installation docs for more options and instructions.](https://docs.tracetest.io/getting-started/install-cli)
 
 ### 2️⃣ Install the Tracetest Server
 
@@ -177,7 +177,7 @@ Or, install Tracetest with Helm. The Tracetest Helm charts are located [here](ht
 helm install tracetest kubeshop/tracetest --namespace=tracetest --create-namespace
 ```
 
-> [:gear: Read the Server installation docs for more options and instructions.](https://docs.tracetest.io/getting-started/installation#install-the-tracetest-server)
+> [:gear: Read the Server installation docs for more options and instructions.](https://docs.tracetest.io/core/getting-started/overview)
 
 ### 3️⃣ Open Tracetest
 
@@ -204,7 +204,7 @@ Check out the [Opening Tracetest guide](https://docs.tracetest.io/core/getting-s
 - Use test definition files and the Tracetest CLI to [enable Gitops flows and CI/CD automation](https://docs.tracetest.io/ci-cd-automation/overview).
 - [Tracetest CLI](https://docs.tracetest.io/cli/cli-installation-reference) allows importing & exporting tests, running tests, and more.
 - [Version tests](https://docs.tracetest.io/concepts/versioning/) as the definition of the test is altered.
-- The [guided install](https://docs.tracetest.io/getting-started/installation) can include [an example "Pokeshop" microservice](https://docs.tracetest.io/live-examples/pokeshop/overview) that is instrumented with OpenTelemetry to use as an example application under test.
+- The [guided install](https://docs.tracetest.io/getting-started/overview) can include [an example "Pokeshop" microservice](https://docs.tracetest.io/live-examples/pokeshop/overview) that is instrumented with OpenTelemetry to use as an example application under test.
 - Create [environment variables](https://docs.tracetest.io/concepts/environments) to assert the same behavior across multiple environments (dev, staging, and production, for example)
 - Create [test outputs](https://docs.tracetest.io/web-ui/creating-test-outputs/) by defining a variable based on the information contained in a particular span's attributes.
 - Run [ad-hoc tests](https://docs.tracetest.io/concepts/ad-hoc-testing) by using undefined variables to enable supplying variables at runtime.

diff --git a/docs/docs/ci-cd-automation/overview.mdx b/docs/docs/ci-cd-automation/overview.mdx
@@ -23,7 +23,7 @@ You can find guides for:
 If you want to see more examples with other CI/CD tools, let us know by [opening an issue in GitHub](https://github.com/kubeshop/tracetest/issues/new/choose)!
 :::
 
-Tracetest is designed to work with all CI/CD platforms and automation tools. To enable Tracetest to run in CI/CD environments, make sure to [install the Tracetest CLI](../getting-started/installation.mdx) and configure it to access your [Tracetest server](../core/configuration/server.mdx).
+Tracetest is designed to work with all CI/CD platforms and automation tools. To enable Tracetest to run in CI/CD environments, make sure to [install the Tracetest CLI and configure it to access your Tracetest account](/getting-started/install-cli).
 
 To read more about integrating Tracetest with CI/CD tools, check out tutorials in our blog:
 

diff --git a/docs/docs/ci-cd-automation/tekton-pipeline.mdx b/docs/docs/ci-cd-automation/tekton-pipeline.mdx
@@ -74,7 +74,7 @@ https://storage.googleapis.com/tekton-releases/triggers/latest/interceptors.yaml
 
 ## 2. Install Tracetest CLI
 
-Install Tracetest CLI by following [these instructions](https://docs.tracetest.io/getting-started/installation) for your OS.
+Install Tracetest CLI by following [these instructions](/getting-started/install-cli) for your OS.
 
 ```bash
 # MacOS example

diff --git a/docs/docs/ci-cd-automation/testkube-pipeline.mdx b/docs/docs/ci-cd-automation/testkube-pipeline.mdx
@@ -76,7 +76,7 @@ This guide will show how to use Testkube alongside Tracetest to run scheduled Tr
 
 **Tracetest account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Create an [organization](/concepts/organizations) and [environment](/concepts/environments).
 - Deploy the [Tracetest Agent](/configuration/agent) in your cluster.
 - Create an [environment token](/concepts/environment-tokens).

diff --git a/docs/docs/cli/cli-installation-reference.mdx b/docs/docs/cli/cli-installation-reference.mdx
@@ -22,7 +22,7 @@ Tracetest has a command line interface (CLI) which includes:
 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).
+Read more about the installation guide [here](/getting-started/overview).
 :::
 
 ## Installing the Tracetest CLI in different operating systems

diff --git a/docs/docs/concepts/agent.mdx b/docs/docs/concepts/agent.mdx
@@ -43,5 +43,5 @@ Enable and configure the tracing backend you're using via the trace ingestion ta
 ![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1715929575/docs/tracetest-private-agent-marketechture-may-17_jiyf1t.png)
 
 :::note
-Want to start Tracetest Agent? Check out [this page to get started](../getting-started/installation).
+Want to start Tracetest Agent? Check out [this page to get started](/getting-started/install-agent).
 :::
diff --git a/...s/recipes/running-playwright-performance-tests-with-artillery-and-tracetest.mdx b/...s/recipes/running-playwright-performance-tests-with-artillery-and-tracetest.mdx
@@ -64,7 +64,7 @@ The [`artillery-engine-playwright` npm package](https://www.npmjs.com/package/ar
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine.

diff --git a/...rials/recipes/running-python-app-with-opentelemetry-collector-and-tracetest.mdx b/...rials/recipes/running-python-app-with-opentelemetry-collector-and-tracetest.mdx
@@ -31,7 +31,7 @@ This is a simple quick start on how to configure a Python app to use OpenTelemet
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine.

diff --git a/...cs/examples-tutorials/recipes/running-tests-with-tracetest-graphql-pokeshop.mdx b/...cs/examples-tutorials/recipes/running-tests-with-tracetest-graphql-pokeshop.mdx
@@ -43,7 +43,7 @@ Other impactful benefits of using traces as test specs are:
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine.

diff --git a/...s/examples-tutorials/recipes/running-tests-with-tracetest-playwright-engine.mdx b/...s/examples-tutorials/recipes/running-tests-with-tracetest-playwright-engine.mdx
@@ -48,7 +48,7 @@ Another big benefit of using traces as test specs is that you can:
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine.

diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray-adot.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray-adot.mdx
@@ -38,7 +38,7 @@ This is a simple quick start guide on how to configure a Node.js app to use inst
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **AWS Account**:
@@ -71,7 +71,7 @@ Follow along with the sections below for an in detail breakdown of what the exam
 
 ## Project Structure
 
-The project contains the [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and a Node.js app.
+The project contains the [Tracetest Agent](/getting-started/install-agent), and a Node.js app.
 
 The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, [AWS Distro for OpenTelemetry (ADOT)](https://aws-otel.github.io/docs/getting-started/collector), and the [Tracetest Agent](/concepts/agent) setup.
 

diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray-pokeshop.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray-pokeshop.mdx
@@ -40,7 +40,7 @@ This is a simple quick start guide on how to configure a fully instrumented API
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **AWS Account**:
@@ -73,7 +73,7 @@ Follow along with the sections below for an in detail breakdown of what the exam
 
 ## Project Structure
 
-The project contains the [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and the [Pokeshop Demo app](/live-examples/pokeshop/overview).
+The project contains the [Tracetest Agent](/getting-started/install-agent), and the [Pokeshop Demo app](/live-examples/pokeshop/overview).
 
 The `docker-compose.yaml` file in the root directory of the quick start runs the Pokeshop Demo app, [AWS Distro for OpenTelemetry (ADOT)](https://aws-otel.github.io/docs/getting-started/collector), and the [Tracetest Agent](/concepts/agent) setup.
 

diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray.mdx
@@ -34,7 +34,7 @@ This is a simple quick start guide on how to configure a Node.js app to use inst
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **AWS Account**:
@@ -67,7 +67,7 @@ Follow along with the sections below for an in detail breakdown of what the exam
 
 ## Project Structure
 
-The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and a Node.js app.
+The project contains [Tracetest Agent](/getting-started/install-agent), and a Node.js app.
 
 The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, [X-Ray Daemon](https://docs.aws.amazon.com/xray/latest/devguide/xray-daemon.html), and the [Tracetest Agent](/concepts/agent) setup.
 

diff --git a/...mples-tutorials/recipes/running-tracetest-with-azure-app-insights-collector.mdx b/...mples-tutorials/recipes/running-tracetest-with-azure-app-insights-collector.mdx
@@ -41,7 +41,7 @@ This is a simple quick start guide on how to configure a Node.js app to use inst
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **Azure Account**:
@@ -75,7 +75,7 @@ Follow along with the sections below for an in detail breakdown of what the exam
 
 ## Project Structure
 
-The project contains the [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and a Node.js app.
+The project contains the [Tracetest Agent](/getting-started/install-agent), and a Node.js app.
 
 The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, Elasticsearch, Elastic APM server, OpenTelemetry Collector, and the [Tracetest Agent](/concepts/agent) setup.
 

diff --git a/...amples-tutorials/recipes/running-tracetest-with-azure-app-insights-pokeshop.mdx b/...amples-tutorials/recipes/running-tracetest-with-azure-app-insights-pokeshop.mdx
@@ -41,7 +41,7 @@ This is a simple quick start guide on how to configure a fully instrumented API
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **Azure Account**:

diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights.mdx
@@ -37,7 +37,7 @@ This is a simple quick start guide on how to configure a Node.js app to use inst
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **Azure Account**:
@@ -72,7 +72,7 @@ Follow along with the sections below for an in detail breakdown of what the exam
 
 ## Project Structure
 
-The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and a Node.js app.
+The project contains [Tracetest Agent](/getting-started/install-agent), and a Node.js app.
 
 The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, and the [Tracetest Agent](/concepts/agent) setup.
 

diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-datadog.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-datadog.mdx
@@ -28,7 +28,7 @@ This is a simple sample app on how to configure the [OpenTelemetry Demo `v1.3.0`
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine.

diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-dynatrace.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-dynatrace.mdx
@@ -28,7 +28,7 @@ This is a simple sample app on how to configure the [OpenTelemetry Demo `v1.3.0`
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine.

diff --git a/...ocs/examples-tutorials/recipes/running-tracetest-with-elastic-opentelemetry.mdx b/...ocs/examples-tutorials/recipes/running-tracetest-with-elastic-opentelemetry.mdx
@@ -36,7 +36,7 @@ This is a simple quick start on how to configure a Node.js app to use OpenTeleme
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine.
@@ -63,7 +63,7 @@ Follow along with the sections below for an in detail breakdown of what the exam
 
 ## Project Structure
 
-The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), [Elastic APM server](https://github.com/elastic/apm-server), [Elasticsearch](https://github.com/elastic/elasticsearch), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib), and a Node.js app.
+The project contains [Tracetest Agent](/getting-started/install-agent), [Elastic APM server](https://github.com/elastic/apm-server), [Elasticsearch](https://github.com/elastic/elasticsearch), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib), and a Node.js app.
 
 The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, Elasticsearch, Elastic APM server, OpenTelemetry Collector, and the [Tracetest Agent](/concepts/agent) setup.
 

diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-elasticapm.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-elasticapm.mdx
@@ -33,7 +33,7 @@ This is a simple quick start on how to configure a Node.js app to use Elastic AP
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine.
@@ -60,7 +60,7 @@ Follow along with the sections below for an in detail breakdown of what the exam
 
 ## Project Structure
 
-The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), and a Node.js app.
+The project contains [Tracetest Agent](/getting-started/install-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), and a Node.js app.
 
 The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, Elasticsearch, Elastic APM server, and the [Tracetest Agent](/concepts/agent) setup.
 

diff --git a/...mples-tutorials/recipes/running-tracetest-with-grafana-cloud-tempo-pokeshop.mdx b/...mples-tutorials/recipes/running-tracetest-with-grafana-cloud-tempo-pokeshop.mdx
@@ -38,7 +38,7 @@ This is a simple quick start guide on how to configure a fully instrumented API
 
 **Tracetest Account**:
 
-- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
+- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs.
 - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).
 
 **Grafana Cloud Account**
@@ -71,7 +71,7 @@ Follow along with the sections below for an in detail breakdown of what the exam
 
 ## Project Structure
 
-The project contains the [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and the [Pokeshop Demo app](/live-examples/pokeshop/overview).
+The project contains the [Tracetest Agent](/getting-started/install-agent), and the [Pokeshop Demo app](/live-examples/pokeshop/overview).
 
 The `docker-compose.yaml` file in the root directory of the quick start runs the Pokeshop Demo app, [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib), and the [Tracetest Agent](/concepts/agent) setup.