From 031f5ab2f69ed3c076c67ac7bd29e697f6e7e7e9 Mon Sep 17 00:00:00 2001 From: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> Date: Mon, 10 Feb 2025 06:25:31 -0800 Subject: [PATCH] Apply linting rules to loki.* component docs (#2594) * First linting pass through some loki components * General linting cleanup * Format table styles * Fix small typo * Fix up rule selector block * General tidy catching spelling, typos, and formatting * Another pass to fix style spelling and typos * Fix some missing syntax and layout * Add some missing nested block explanations * Markdown coding cleanup * Fix ref to OAuth 2.0 * Fix typo in compatible components * Add required to block definition * Second try at fixing compat components section --- .../reference/components/local/_index.md | 2 +- .../reference/components/local/local.file.md | 32 +- .../components/local/local.file_match.md | 18 +- .../reference/components/loki/_index.md | 2 +- .../reference/components/loki/loki.echo.md | 24 +- .../reference/components/loki/loki.process.md | 1199 ++++++++--------- .../reference/components/loki/loki.relabel.md | 60 +- .../components/loki/loki.rules.kubernetes.md | 206 +-- .../components/loki/loki.secretfilter.md | 68 +- .../components/loki/loki.source.api.md | 65 +- .../loki/loki.source.awsfirehose.md | 150 ++- .../loki/loki.source.azure_event_hubs.md | 121 +- .../components/loki/loki.source.cloudflare.md | 144 +- .../components/loki/loki.source.docker.md | 107 +- .../components/loki/loki.source.file.md | 69 +- .../components/loki/loki.source.gcplog.md | 138 +- .../components/loki/loki.source.gelf.md | 58 +- .../components/loki/loki.source.heroku.md | 81 +- .../components/loki/loki.source.journal.md | 62 +- .../components/loki/loki.source.kafka.md | 138 +- .../components/loki/loki.source.kubernetes.md | 142 +- .../loki/loki.source.kubernetes_events.md | 150 +-- .../components/loki/loki.source.podlogs.md | 288 ++-- .../components/loki/loki.source.syslog.md | 103 +- .../loki/loki.source.windowsevent.md | 44 +- .../reference/components/loki/loki.write.md | 239 ++-- 26 files changed, 1841 insertions(+), 1869 deletions(-) diff --git a/docs/sources/reference/components/local/_index.md b/docs/sources/reference/components/local/_index.md index 3c8f2793cc..f3830a3e30 100644 --- a/docs/sources/reference/components/local/_index.md +++ b/docs/sources/reference/components/local/_index.md @@ -5,7 +5,7 @@ title: local weight: 100 --- -# local +# `local` This section contains reference documentation for the `local` components. diff --git a/docs/sources/reference/components/local/local.file.md b/docs/sources/reference/components/local/local.file.md index cdd8d866ea..bec308ee4f 100644 --- a/docs/sources/reference/components/local/local.file.md +++ b/docs/sources/reference/components/local/local.file.md @@ -3,17 +3,19 @@ canonical: https://grafana.com/docs/alloy/latest/reference/components/local/loca aliases: - ../local.file/ # /docs/alloy/latest/reference/components/local.file/ description: Learn about local.file +labels: + stage: general-availability title: local.file --- # `local.file` `local.file` exposes the contents of a file on disk to other components. -The file will be watched for changes so that its latest content is always exposed. +The file is watched for changes so that its latest content is always exposed. The most common use of `local.file` is to load secrets (for example, API keys) from files. -Multiple `local.file` components can be specified by giving them different labels. +You can specify multiple `local.file` components by giving them different labels. ## Usage @@ -25,14 +27,14 @@ local.file "