Skip to content

Commit

Permalink
docs(get-started): remove "installation" page
Browse files Browse the repository at this point in the history
  • Loading branch information
adnanrahic committed Sep 25, 2024
1 parent e593da9 commit 62ff17d
Show file tree
Hide file tree
Showing 59 changed files with 158 additions and 91 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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!)
Expand All @@ -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

Expand All @@ -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

Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/ci-cd-automation/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/ci-cd-automation/tekton-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/ci-cd-automation/testkube-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cli/cli-installation-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/concepts/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
:::
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand Down Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand Down Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand Down Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand Down Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand Down Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down Expand Up @@ -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.

Expand Down
Loading

0 comments on commit 62ff17d

Please sign in to comment.