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

Clean up Alloy component docs #2387

Merged
merged 6 commits into from
Jan 13, 2025
Merged

Conversation

clayton-cornell
Copy link
Contributor

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

PR Description

This PR is the first in a series focusing on cleaning up the Alloy component docs.

  • 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.

Which issue(s) this PR fixes

Notes to the Reviewer

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Jan 10, 2025
Copy link
Contributor

github-actions bot commented Jan 10, 2025

💻 Deploy preview deleted.

@clayton-cornell clayton-cornell requested a review from a team January 13, 2025 18:56
@clayton-cornell clayton-cornell marked this pull request as ready for review January 13, 2025 18:56
Copy link
Collaborator

@mattdurham mattdurham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gave a quick look, LGTM

@clayton-cornell clayton-cornell merged commit cb9f7b0 into main Jan 13, 2025
26 checks passed
@clayton-cornell clayton-cornell deleted the docs/update_component_docs_part_1 branch January 13, 2025 21:38
github-actions bot pushed a commit that referenced this pull request Jan 13, 2025
* First pass at cleanup, pretty tables, sort lists

* Sort content, add badge

* Fix link

* Set link URL correctly

* Still fxing link targets

* One more tidy pass

(cherry picked from commit cb9f7b0)
github-actions bot pushed a commit that referenced this pull request Jan 13, 2025
* First pass at cleanup, pretty tables, sort lists

* Sort content, add badge

* Fix link

* Set link URL correctly

* Still fxing link targets

* One more tidy pass

(cherry picked from commit cb9f7b0)
github-actions bot pushed a commit that referenced this pull request Jan 13, 2025
* First pass at cleanup, pretty tables, sort lists

* Sort content, add badge

* Fix link

* Set link URL correctly

* Still fxing link targets

* One more tidy pass

(cherry picked from commit cb9f7b0)
@grafana grafana deleted a comment from github-actions bot Jan 13, 2025
@grafana grafana deleted a comment from github-actions bot Jan 13, 2025
@grafana grafana deleted a comment from github-actions bot Jan 13, 2025
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.

2 participants