From 7efff7757f2cd58bf67ea36d69c406d470afa386 Mon Sep 17 00:00:00 2001 From: Matt Simonsen Date: Wed, 13 Mar 2024 04:36:40 -0700 Subject: [PATCH 1/2] Doc update (#3482) * doc: remove reference to previously purged script * doc: correct label for docs updates (cherry picked from commit 719aa7e9be48b8b9803c7e43c24c1a997192a894) --- CONTRIBUTING.md | 2 +- docs/sources/tempo/getting-started/example-demo-app.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c32a22f964d..5ce1458500d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -164,7 +164,7 @@ Tempo documentation is located in the `docs` directory. The `docs` directory has Once you know what you would like to write, use the [Writer's Toolkit](https://grafana.com/docs/writers-toolkit/writing-guide/contribute-documentation/) for information on creating good documentation. The toolkit also provides [document templates](https://github.com/grafana/writers-toolkit/tree/main/docs/static/templates) to help get started. -When you create a PR for documentation, add the `types/doc` label to identify the PR as contributing documentation. +When you create a PR for documentation, add the `type/doc` label to identify the PR as contributing documentation. If your content needs to be added to a previous release, use the `backport` label for the version. When your PR is merged, the backport label triggers an automatic process to create an additional PR to merge the content into the version's branch. Check the PR for content that might not be appropriate for the version. For example, if you fix a broken link on a page and then backport to Tempo 1.5, you would not want any TraceQL information to appear. diff --git a/docs/sources/tempo/getting-started/example-demo-app.md b/docs/sources/tempo/getting-started/example-demo-app.md index 15a0020ed9a..c41ee9fc84d 100644 --- a/docs/sources/tempo/getting-started/example-demo-app.md +++ b/docs/sources/tempo/getting-started/example-demo-app.md @@ -48,4 +48,4 @@ To learn how to set up a Tempo cluster, see [Deploy on Kubernetes with Tanka]({{ The [Introduction to Metrics, Logs and Traces in Grafana](https://github.com/grafana/intro-to-mlt) provides a self-contained environment for learning about Mimir, Loki, Tempo, and Grafana. It includes detailed explanations of each compononent, annotated configurations for each component. -The README.md file has full details on how to quickly download and [start the environment](https://github.com/grafana/intro-to-mlt#running-the-demonstration-environment). Additionally, you can use the [`ctl.sh`](https://github.com/grafana/intro-to-mlt#grafana-cloud) script to alter the environment to send metrics, logs, and traces to Grafana Cloud. +The README.md file has full details on how to quickly download and [start the environment](https://github.com/grafana/intro-to-mlt#running-the-demonstration-environment), including instructions for using Grafana Cloud and the OpenTelemetry Agent. From e8a4e07f0bd27818a02abece6f349d635eb77e71 Mon Sep 17 00:00:00 2001 From: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Date: Tue, 26 Mar 2024 16:08:03 -0400 Subject: [PATCH 2/2] Update docs/sources/tempo/getting-started/example-demo-app.md --- docs/sources/tempo/getting-started/example-demo-app.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sources/tempo/getting-started/example-demo-app.md b/docs/sources/tempo/getting-started/example-demo-app.md index c41ee9fc84d..4df8d82813b 100644 --- a/docs/sources/tempo/getting-started/example-demo-app.md +++ b/docs/sources/tempo/getting-started/example-demo-app.md @@ -49,3 +49,4 @@ To learn how to set up a Tempo cluster, see [Deploy on Kubernetes with Tanka]({{ The [Introduction to Metrics, Logs and Traces in Grafana](https://github.com/grafana/intro-to-mlt) provides a self-contained environment for learning about Mimir, Loki, Tempo, and Grafana. It includes detailed explanations of each compononent, annotated configurations for each component. The README.md file has full details on how to quickly download and [start the environment](https://github.com/grafana/intro-to-mlt#running-the-demonstration-environment), including instructions for using Grafana Cloud and the OpenTelemetry Agent. +