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 Alloy OtelCol component docs #2811

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Feb 21, 2025

PR Description

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.

This PR will also consider the community suggestion in this PR: #1959

Which issue(s) this PR fixes

Fixes #2416

Notes to the Reviewer

PR Checklist

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

Copy link
Contributor

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 OtelCol component docs
1 participant