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

Rework and reorganise Beyla component doc #1630

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Sep 6, 2024

PR Description

Rework and reorganise the beyla.ebpf component documentation

Changes:

  • Pretty tables (only shows in markdown source)
  • Minor spelling fixes and a few Vale linting related fixes
  • Sort table content first by Required and Optional and then alphabetical
  • Sort table comments to match table order
  • Sort block descriptions to match order in overview
    • Move output to the top
    • Move routes to the bottom
  • Add a Required badge to the required block sections
  • Expand the Usage content to add the Required block
  • Remove block from the headings
  • Fix some of the headings which were at the wrong level

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 Oct 8, 2024

This PR has not had any activity in the past 30 days, so the needs-attention label has been added to it.
If you do not have enough time to follow up on this PR or you think it's no longer relevant, consider closing it.
The needs-attention label signals to maintainers that something has fallen through the cracks. No action is needed by you; your PR 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!

@clayton-cornell
Copy link
Contributor Author

clayton-cornell commented Dec 4, 2024

Some ideas in progress

Related screenshots:
Image
and
Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-attention 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