Command Reference for https://github.com/thanos-io/thanos/
This documentation page provides a detailed guide to using Thanos commands, including options, flags, and usage examples.
What is Command Reference?
The Command Reference is a set of scripts and Makefile targets that help maintain the Thanos project documentation. It includes tasks for checking docs against discrepancies, cleaning up white noise, formatting shell scripts, and more.
Why is Command Reference important?
The Command Reference is essential for ensuring the accuracy and consistency of Thanos documentation. It automates various tasks, such as checking links, formatting shell scripts, and cleaning up white noise, making it easier for maintainers to keep the documentation up-to-date and accurate.
Insights
The following is a brief overview of the Command Reference targets and their usage.
check-docs
This target checks the documentation against discrepancies with flags, links, and white noise. It builds examples and formats the Markdown files using the mdox tool.
make check-docs
white-noise-cleanup
This target cleans up white noise in the Markdown files. It uses a shell script named cleanup-white-noise.sh to remove unnecessary characters.
make white-noise-cleanup
shell-format
This target formats shell scripts using the shfmt tool.
make shell-format
Labels
Thanos uses various labels to help navigate through issues and PRs. The main labels are:
help wanted: Indicates that the issue or PR is a good starting point for new contributors.good first issue: Indicates that the issue or PR is suitable for beginners.bug: Indicates that there is a reproducible issue with the code.documentation: Indicates that the issue or PR is related to documentation.enhancement: Indicates that the issue or PR proposes an improvement or new feature.
For more information on labels, see Thanos issue labels.
Maintainers
The Thanos project is maintained by a team of volunteers from various companies, including Google, Polar Signals, Vinted, Red Hat, Aiven, and Coralogix. For more information about the maintainers, see the CONTRIBUTORS.md file in the Thanos repository.
