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.

Sign up for GitHub

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

Jump to bottom

Apply linting rules to Alloy Beyla Component docs #2409

Closed
clayton-cornell opened this issue Jan 15, 2025 · 1 comment · Fixed by #2387
Closed

Apply linting rules to Alloy Beyla Component docs #2409

clayton-cornell opened this issue Jan 15, 2025 · 1 comment · Fixed by #2387
Assignees
@clayton-cornell

Comments

@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.
@clayton-cornell clayton-cornell mentioned this issue Jan 15, 2025
Merged
@clayton-cornell
Copy link
Contributor Author

Fixed in #2387

@clayton-cornell clayton-cornell self-assigned this Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@clayton-cornell clayton-cornell

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Clean up Alloy component docs grafana/alloy
1 participant
@clayton-cornell