From 90253d34a53226d260589c52b2a3e14808d94e4a Mon Sep 17 00:00:00 2001 From: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> Date: Wed, 3 Apr 2024 13:21:24 -0700 Subject: [PATCH] Edit cycle on Alloy docs to catch typos and rework some text (#109) * Fix typo in heading * Updates from review * Fix command description * Style updates for some reference topics * Modify and rework tutorials and add prereqs --- .../configuration-syntax/components.md | 4 +- docs/sources/introduction/_index.md | 4 +- .../reference/components/discovery.azure.md | 48 ++++++------- .../reference/components/discovery.consul.md | 12 ++-- .../components/discovery.consulagent.md | 67 +++++++++---------- .../components/discovery.digitalocean.md | 18 ++--- docs/sources/tasks/migrate/_index.md | 2 +- docs/sources/tasks/migrate/from-operator.md | 8 +-- .../first-components-and-stdlib/index.md | 53 +++++++++------ docs/sources/tutorials/get-started.md | 25 +++---- .../logs-and-relabeling-basics/index.md | 66 +++++++++++------- .../tutorials/processing-logs/index.md | 49 ++++++++------ 12 files changed, 197 insertions(+), 159 deletions(-) diff --git a/docs/sources/concepts/configuration-syntax/components.md b/docs/sources/concepts/configuration-syntax/components.md index d33a4a071f..5114e4c570 100644 --- a/docs/sources/concepts/configuration-syntax/components.md +++ b/docs/sources/concepts/configuration-syntax/components.md @@ -1,11 +1,11 @@ --- canonical: https://grafana.com/docs/alloy/latest/concepts/configuration-syntax/components/ description: Learn about the components configuration language -title: Components configuration language +title: Components configuration weight: 300 --- -# Components configuration language +# Components configuration Components are the defining feature of {{< param "PRODUCT_NAME" >}}. Components are small, reusable pieces of business logic that perform a single task like retrieving secrets or collecting Prometheus metrics, and you can wire them together to form programmable pipelines of telemetry data. diff --git a/docs/sources/introduction/_index.md b/docs/sources/introduction/_index.md index 5c21b5434e..ba31aa20d0 100644 --- a/docs/sources/introduction/_index.md +++ b/docs/sources/introduction/_index.md @@ -75,9 +75,9 @@ binaries and images with BoringCrypto enabled. Builds and Docker images for Linu * [Install][] {{< param "PRODUCT_NAME" >}}. * Learn about the core [Concepts][] of {{< param "PRODUCT_NAME" >}}. -* Follow the [Tutorials][] for hands-on learning of {{< param "PRODUCT_NAME" >}}. +* Follow the [Tutorials][] for hands-on learning about {{< param "PRODUCT_NAME" >}}. * Consult the [Tasks][] instructions to accomplish common objectives with {{< param "PRODUCT_NAME" >}}. -* Check out the [Reference][] documentation to find specific information you might be looking for. +* Check out the [Reference][] documentation to find information about the Alloy components, configuration blocks, and command line tools. [OpenTelemetry]: https://opentelemetry.io/ecosystem/distributions/ [Install]: ../get-started/install/ diff --git a/docs/sources/reference/components/discovery.azure.md b/docs/sources/reference/components/discovery.azure.md index 985c295baf..d558f902f3 100644 --- a/docs/sources/reference/components/discovery.azure.md +++ b/docs/sources/reference/components/discovery.azure.md @@ -13,7 +13,7 @@ title: discovery.azure ## Usage ```alloy -discovery.azure "LABEL" { +discovery.azure "