apitech
/
loki
mirror of https://github.com/grafana/loki
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Like Prometheus, but for logs.
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.
5630 Commits
845 Branches
311 Tags
655 MiB
 
 
 
 
 
 
Tag: Branch: Tree: c29ba973a0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c29ba973a0'
${ noResults }
loki/tools/doc-generator
History
Ashwanth 18482c67d6
compactor: deprecate -boltdb.shipper.compactor. prefix in favor of -compactor. (#10344) 		2 years ago
..
parse compactor: deprecate -boltdb.shipper.compactor. prefix in favor of -compactor. (#10344) 2 years ago
README.md Add README file to doc-generator tool (#7983) 2 years ago
main.go gofmt is needed for the build (#8678) 2 years ago
writer.go Add configuration documentation generation tool (#7916) 2 years ago

README.md

Documentation generation tool

The doc-generator tool is used to automatically generate the configuration flags documentation from the metadata information provided in the code.

Run

The tool receives as input a template file and generates the list of configuration value blocks:

go run ./tools/doc-generator docs/sources/configuration/index.template > docs/sources/configuration/_index.md

doc tag

The description and default value of configuration values can be set via CLI flag registration by using the flag package. However, for a more flexible documentation generation it is possible to combine this with the doc tag by applying the following custom values:

  • doc:"deprecated": sets the element as deprecated in the documentation.
  • doc:"hidden": does not show the element in the documentation.
  • doc:"description=foo": overrides the element's description (set via flag registration, if any) with foo.
  • doc:"default=<hostname>": sets the element's documentation default value as <hostname>. Note: this only sets the default value shown in the documentation, it doesn't override the default configuration value.