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

Open
clayton-cornell opened this issue Jan 15, 2025 · 2 comments · May be fixed by #2811
Open

Apply linting rules to Alloy OtelCol component docs #2416

clayton-cornell opened this issue Jan 15, 2025 · 2 comments · May be fixed by #2811
Assignees
@clayton-cornell
Labels
needs-attention

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 self-assigned this Jan 15, 2025
@clayton-cornell clayton-cornell mentioned this issue Jan 22, 2025
Open
1 task
@clayton-cornell
Copy link
Contributor Author

Related PR: #1959

@clayton-cornell clayton-cornell linked a pull request Feb 21, 2025 that will close this issue
Draft
4 tasks
@github-actions GitHub Actions
Copy link
Contributor

This issue has not had any activity in the past 30 days, so the needs-attention label has been added to it.
If the opened issue is a bug, check to see if a newer release fixed your issue. If it is no longer relevant, please feel free to close this issue.
The needs-attention label signals to maintainers that something has fallen through the cracks. No action is needed by you; your issue will be kept open and you do not have to respond to this comment. The label will be removed the next time this job runs if there is new activity.
Thank you for your contributions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@clayton-cornell clayton-cornell

Labels
needs-attention
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Apply linting rules to Alloy OtelCol component docs grafana/alloy
1 participant
@clayton-cornell