From ea77e2b6ee1ddd390266caa2446a7bb083bd79de Mon Sep 17 00:00:00 2001 From: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> Date: Thu, 28 Mar 2024 10:56:18 -0700 Subject: [PATCH] Remove hidden flags (#96) * Remove hidden flag and clean up root level readme * Added missed staged changes * Remove ref to external Heml chart * Remove obsolete info from README --- docs/README.md | 39 ++++++++++----------------------- docs/sources/_index.md | 3 --- docs/sources/_index.md.t | 3 --- docs/sources/about.md | 3 --- docs/sources/data-collection.md | 3 --- docs/sources/release-notes.md | 3 --- 6 files changed, 11 insertions(+), 43 deletions(-) diff --git a/docs/README.md b/docs/README.md index 96b0459204..b5cc6be1be 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,42 +1,25 @@ -# Grafana Agent Documentation +# Grafana Alloy Documentation -This directory contains documentation for Grafana Agent. It is split into the -following parts: +This directory contains documentation for Grafana Alloy. It is split into the following parts: -* `sources/`: Source of user-facing documentation. This directory is hosted on - [grafana.com/docs/agent](https://grafana.com/docs/agent/latest/), and we - recommend viewing it there instead of the markdown on - GitHub. +* `sources/`: Source of user-facing documentation. + This directory is hosted on [grafana.com/docs/alloy](https://grafana.com/docs/alloy/latest/), and we recommend viewing it there instead of the markdown on GitHub. * `developer/`: Documentation for contributors and maintainers. -* `rfcs/`: RFCs for proposals relating to Grafana Agent. * `generator/`: Code for generating some parts of the documentation. ## Preview the website -Run `make docs`. This launches a preview of the website with the current grafana docs at `http://localhost:3002/docs/agent/latest/` which will refresh automatically when changes are made to content in the `sources` directory. +Run `make docs`. +This launches a preview of the website with the current grafana docs at `http://localhost:3002/docs/alloy/latest/` which automatically refreshes when changes are made to content in the `sources` directory. Make sure Docker is running. -## Update cloudwatch docs +## Update CloudWatch docs -First, inside the `docs/` folder run `make check-cloudwatch-integration` to verify that the cloudwatch docs needs updating. +First, inside the `docs/` folder run `make check-cloudwatch-integration` to verify that the CloudWatch docs needs updating. -If the check fails, then the doc supported services list should be updated. For that, run `make generate-cloudwatch-integration` to get the updated list, which should replace the old one in [the docs](./sources/static/configuration/integrations/cloudwatch-exporter-config.md). +If the check fails, then the doc supported services list should be updated. +For that, run `make generate-cloudwatch-integration` to get the updated list, which should replace the old one in [the docs](./sources/static/configuration/integrations/cloudwatch-exporter-config.md). ## Update generated reference docs -Some sections of Grafana Agent Flow reference documentation are automatically generated. To update them, run `make generate-docs`. - -### Community Projects - -The following is a list of community-led projects for working with Grafana Agent. These projects are not maintained or supported by Grafana Labs. - -#### Helm (Kubernetes Deployment) - -A publicly available release of a Grafana Agent Helm chart is maintained [here](https://github.com/DandyDeveloper/charts/tree/master/charts/grafana-agent). Contributions and improvements are welcomed. Full details on rolling out and supported options can be found in the [readme](https://github.com/DandyDeveloper/charts/blob/master/charts/grafana-agent/README.md). - -This *does not* require the Grafana Agent Operator to rollout / deploy. - -#### Juju (Charmed Operator) - -The [grafana-agent-k8s](https://github.com/canonical/grafana-agent-operator) charmed operator runs with [Juju](https://juju.is) the Grafana Agent on Kubernetes. -The Grafana Agent charmed operator is designed to work with the [Logs, Metrics and Alerts](https://juju.is/docs/lma2) observability stack. +Some sections of Grafana Alloy reference documentation are automatically generated. To update them, run `make generate-docs`. diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 1664c3f806..a49b107d68 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -8,9 +8,6 @@ cascade: OTEL_VERSION: v0.87.0 FULL_PRODUCT_NAME: Grafana Alloy PRODUCT_NAME: Alloy - _build: - list: false - noindex: true --- # {{% param "PRODUCT_NAME" %}} diff --git a/docs/sources/_index.md.t b/docs/sources/_index.md.t index 87ea5a83fe..93b418161d 100644 --- a/docs/sources/_index.md.t +++ b/docs/sources/_index.md.t @@ -8,9 +8,6 @@ cascade: OTEL_VERSION: v0.87.0 FULL_PRODUCT_NAME: Grafana Alloy PRODUCT_NAME: Alloy - _build: - list: false - noindex: true --- # {{% param "PRODUCT_NAME" %}} diff --git a/docs/sources/about.md b/docs/sources/about.md index 6cc3501594..02a73e5d2c 100644 --- a/docs/sources/about.md +++ b/docs/sources/about.md @@ -4,9 +4,6 @@ description: Alloy is a flexible, performant, vendor-neutral, telemetry collecto menuTitle: Introduction title: Introduction to Alloy weight: 10 -_build: - list: false -noindex: true --- # Introduction to {{% param "PRODUCT_NAME" %}} diff --git a/docs/sources/data-collection.md b/docs/sources/data-collection.md index 310312c38b..60af15c578 100644 --- a/docs/sources/data-collection.md +++ b/docs/sources/data-collection.md @@ -4,9 +4,6 @@ description: Grafana Alloy data collection menuTitle: Data collection title: Grafana Alloy data collection weight: 900 -_build: - list: false -noindex: true --- # {{% param "FULL_PRODUCT_NAME" %}} Data collection diff --git a/docs/sources/release-notes.md b/docs/sources/release-notes.md index 7a077a0680..44bd15d6d1 100644 --- a/docs/sources/release-notes.md +++ b/docs/sources/release-notes.md @@ -4,9 +4,6 @@ description: Release notes for Grafana Alloy menuTitle: Release notes title: Release notes for Grafana Alloy weight: 999 -_build: - list: false -noindex: true --- # Release notes for {{% param "FULL_PRODUCT_NAME" %}}