Like Prometheus, but for logs.

prometheushacktoberfestgrafanacloudnativeloggingloki

You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Susana Ferreira f93b91bfb5 Add configuration documentation generation tool (#7916) ... **What this PR does / why we need it**: Add a tool to generate configuration flags documentation based on the flags properties defined on registration on the code. This tool is based on the [Mimir doc generation tool](https://github.com/grafana/mimir/tree/main/tools/doc-generator) and adapted according to Loki configuration specifications. Prior to this PR, the configuration flags documentation was dispersed across two sources: * [_index.md](5550cd65ec/docs/sources/configuration/_index.md) * configuration flags registration in the code This meant that there was no single source of truth. In this PR, the previous `_index.md` file is replaced with the new file generated by the tool. The next step includes adding a CI step that validates if the _index.md file was generated according to the flags settings. This will be done in a follow-up PR. **NOTE:** this is not a documentation update PR. Apart from some minor typo fixes, the documentation changes on the code, were copied from the `_index.md` file. **Which issue(s) this PR fixes**: Fixes https://github.com/grafana/loki-private/issues/83 **Special notes for your reviewer**: Files: * [docs/sources/configuration/index.template](5550cd65ec/docs/sources/configuration/index.template): template used to generate the final configuration file * [/docs/sources/configuration/_index.md](c32e5d0acb/docs/sources/configuration/_index.md): file generated by tool * `loki/pkg` directory files updated with up-to-date documentation from `_index.md` file * [tools/doc-generator](5550cd65ec/tools/doc-generator) directory with documentation generation tool. **Checklist** - [ ] Reviewed the `CONTRIBUTING.md` guide - [ ] Documentation added - [ ] Tests updated - [ ] `CHANGELOG.md` updated - [ ] Changes that require user attention or interaction to upgrade are documented in `docs/sources/upgrading/_index.md`		3 years ago
..
api	doc(api): Default value for `delete_ring_tokens` on `/ingester/shutdown` endpoint (#7921)	3 years ago
best-practices	Update _index.md (#5934)	4 years ago
clients	promtail: ratelimiting by label (#7597)	3 years ago
community	[Docs] Typo: Fix build path of promtail binary (#7776)	3 years ago
configuration	Add configuration documentation generation tool (#7916)	3 years ago
design-documents	Docs: Fix design docs index page (#6008)	4 years ago
fundamentals	Documentation: Fix broken link (#7136)	3 years ago
getting-started	Remove CTA per @grafanawriter. (#7559)	3 years ago
installation	Helm: Decouple the Canary from self-monitoring (#7757)	3 years ago
logql	[docs] removed static URL to LogQL Analyzer API (#7773)	3 years ago
maintaining	rerun make drone so the newest build image is used (#7849)	3 years ago
operations	fix small typo (#7874)	3 years ago
release-notes	Prepare changelog and release notes for 2.7.1 (#7895)	3 years ago
rules	Docs: remove Cortex references (#6079)	4 years ago
storage	Provide Terraform script for setting up S3 and document role based access. (#7656)	3 years ago
tools	Retry pr (#7579)	3 years ago
upgrading	docs/upgrading: Add a note about windows event log fix (#7668)	3 years ago
_index.md	Remove CTA per @grafanawriter. (#7557)	3 years ago
logo.png	Sync docs to website (#2378)	5 years ago
logo_and_name.png	Sync docs to website (#2378)	5 years ago