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

Update and lint discovery topics #2403

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

Conversation

clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Jan 14, 2025

PR Description

Splitting Discovery updates into multiple PRs to make reviews a bit easier.

Changes include:

  • 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
  • Fix capitalization
  • Tidy markdown - spaces around lists, indentation, etc.

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

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

Copy link
Contributor

github-actions bot commented Jan 14, 2025

@clayton-cornell
Copy link
Contributor Author

Related issue #2411

@clayton-cornell clayton-cornell changed the title Update and lint discover topics Update and lint discovery topics Jan 15, 2025
@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Jan 15, 2025
@clayton-cornell clayton-cornell marked this pull request as ready for review January 15, 2025 23:36
@clayton-cornell clayton-cornell requested a review from a team January 15, 2025 23:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant