From 00124fb593a068bb5d1683faecabbdbdeb5c2f16 Mon Sep 17 00:00:00 2001 From: Pete Wall Date: Wed, 23 Oct 2024 11:05:22 +0200 Subject: [PATCH] Fix lint issues Signed-off-by: Pete Wall --- CONTRIBUTING.md | 6 ++++-- charts/k8s-monitoring/docs/destinations/README.md | 4 ++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d036ee34..a045453e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,9 +39,11 @@ Each chart has a Makefile with targets to automate much of the process. Each component has its own guide for contributing: {{/** [Main Helm chart](./charts/k8s-monitoring/README.md#Contributing)*/}} -* [Feature subcharts](./charts/k8s-monitoring/docs/Features.md#Contributing) + +- [Feature subcharts](./charts/k8s-monitoring/docs/Features.md#Contributing) +- [Destinations](./charts/k8s-monitoring/docs/Destinations/README.md#Contributing) + {{/** [Integrations](./charts/feature-integrations/README.md#Contributing)*/}} -* [Destinations](./charts/k8s-monitoring/docs/Destinations/README.md#Contributing) ## Building diff --git a/charts/k8s-monitoring/docs/destinations/README.md b/charts/k8s-monitoring/docs/destinations/README.md index 0aaccdec9..9c5c30530 100644 --- a/charts/k8s-monitoring/docs/destinations/README.md +++ b/charts/k8s-monitoring/docs/destinations/README.md @@ -141,7 +141,7 @@ podLogs: ## Contributing -Destinations use a set of special files to define the destination configuration. These files are used to generate the +Destinations use a specific set of files to define the destination configuration. These files are used to generate the destination configuration and documentation. Several files are used for defining a destination: @@ -160,7 +160,7 @@ Several files are used for defining a destination: - `destinations.<destination slug>.ecosystem` - Returns the telemetry data ecosystem. - `destinations.<destination slug>.<ecosystem>.<data type>.target` - Returns the name of the Alloy target where telemetry data of the matching type and ecosystem should be sent. Multiple target template functions can be made to support converting from one ecosystem to another. -- `docs/destinations/.doc_templates/<destination slug>.gotmpl` - The documentation template file for the +- `docs/destinations/.doc_templates/<destination slug>.gotmpl` - The optional documentation template file for the destination. This file can include examples, usage instructions, and other information about the destination. ### Generated files