Skip to content

Commit

Permalink
Remove hidden flags (#96)
Browse files Browse the repository at this point in the history
* Remove hidden flag and clean up root level readme

* Added missed staged changes

* Remove ref to external Heml chart

* Remove obsolete info from README
  • Loading branch information
clayton-cornell authored Mar 28, 2024
1 parent 6cbe18f commit ea77e2b
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 43 deletions.
39 changes: 11 additions & 28 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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`.
3 changes: 0 additions & 3 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}}
Expand Down
3 changes: 0 additions & 3 deletions docs/sources/_index.md.t
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}}
Expand Down
3 changes: 0 additions & 3 deletions docs/sources/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}}
Expand Down
3 changes: 0 additions & 3 deletions docs/sources/data-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/sources/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}}
Expand Down

0 comments on commit ea77e2b

Please sign in to comment.