-
Notifications
You must be signed in to change notification settings - Fork 239
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 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
1 parent
6cbe18f
commit ea77e2b
Showing
6 changed files
with
11 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters