Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply linting rules to loki.* component docs #2594

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

clayton-cornell
Copy link
Contributor

The Alloy component documentation needs general cleanup, including things like:

  • Pretty print tables
  • Sort table rows alphabetically - required first, then all optional
  • Sort blocks alphabetically
  • Fix block heading hierarchy
  • Add badge for Required blocks
  • Remove block from heading text
  • Remove extra spaces and extra CR/LFs
  • Tidy markdown - spaces around lists, indentation, etc.

Which issue(s) this PR fixes

Fixes #2414

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Jan 31, 2025
Copy link
Contributor

github-actions bot commented Jan 31, 2025

@clayton-cornell clayton-cornell force-pushed the docs/linting_loki_component_topics branch from 5c6a6b7 to f1cf74b Compare February 4, 2025 23:01
@clayton-cornell clayton-cornell requested a review from a team February 6, 2025 00:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Apply linting rules to Alloy Loki component docs
1 participant