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

Fixes #2409

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
mattdurham added a commit that referenced this pull request Jan 14, 2025
* update changelog for rc (#2360)

* update changelog for rc

* update changelog for rc

* update changelog for rc (#2361)

* update version (#2362)

* update changelog for rc (#2360)

* update changelog for rc

* update changelog for rc

Signed-off-by: matt durham <[email protected]>

* fix conversion

* Fix changelog main (#2364)

* update version

* Fix changelog

* update the image version to work with the given example (#2358)

* docs: fixed kafka config example (#2359)

Example shows `loki.source.kafka "local"` pointing to `loki.relabel.kafka.receiver`. This leads to no new label being added. Correct example should have the kafka source pointing directly to `loki.write.local.receiver`

* feat(helm): add the ability to deploy extra manifest files (#2347)

* feat(helm): add the ability to deploy extra manifest files

* docs(helm): run helm-docs

* ci(helm): add tests

* Update wal queue tls (#2363)

* add tls to wal

* add alloy config

* update version

* Add support for TLS doc.

* Add changelog.

* fix import order

* add support and doc for round robin.

* fix conversion

* Update docs/sources/reference/components/prometheus/prometheus.write.queue.md

Co-authored-by: Clayton Cornell <[email protected]>

* Add test

* fix merge

* Update internal/component/prometheus/write/queue/types.go

Co-authored-by: William Dumont <[email protected]>

---------

Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: William Dumont <[email protected]>

* #229 Add OpenTelemetry Collector Server Auth Extensions to Receivers (#2203)

* Work on adding auth so far

* Cleanup

* Made a ton of progress

* Fix test fails?

* Refactor

* Add auth blocks to implementing extensions

* Refactor to use feature flag

* Comments

* Cleanup

* Spacing

* Update docs

* Update CHANGELOG

* Last auth extension missing

* We also need grpc auth

* Fix opencensus docs

* Fix extra comment

* Update comment with findings

* Properly fix merge conflict

* Save file

* Spelling error

* That has been released now

* Add auth support to influxdb receiver

* Fix failing auth test/MAIL

* Comment cleanup

* MAIL for documentation

* docs MAIL

* MAIL

* Move from Auth to Authentication

* Update triton-go dependency to avoid embedded RSA key (#2380)

* Fix examples for filter and transform processors (#2379)

* fix examples filter and transform processors

* remove unecessary docs about escaping strings and backticks

* fix(loki.secretfilter): Fix partial masking for short secrets and support multiple allowlists per rule (#2320)

* Fix partial masking bug and support new allowlist format

* Add docs and changelog

* Update docs

* Add comments

* Add comments

* Minor docs update

* Add more tests

* Change criteria for partial redaction

* Changes to partial masking rules

* Fix comment location

* Clarify usage of secret types

* Clarify usage of secret types

* Update docs/sources/reference/components/loki/loki.secretfilter.md

Co-authored-by: Clayton Cornell <[email protected]>

* Suggestions

* Suggestions

---------

Co-authored-by: Clayton Cornell <[email protected]>

* Fix only run on fork guard (#2378)

* Fix only run on fork guard

The previous guard fails because `github.repository` resolves to the base repository on `pull_request` events.

* Fix syntax

* Fix relabel processed bug (#2394)

* Fix issue where alloy_prometheus_relabel_metrics_processed was not being incremented.

* Add unit tests

* Update WAL to version that supports v2. (#2397)

* Update WAL to version that supports v2.

* Update WAL to version that supports v2.

* Add samples check.

* Clean up Alloy component docs (#2387)

* 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

* database_observability: report health of component and collectors (#2392)

Report unhealthy in case of errors when starting up the collectors or
of any collector is stopped during operations.

* update for rc.1 (#2401)

* Update version.

* fix version

* fix version

---------

Signed-off-by: matt durham <[email protected]>
Co-authored-by: Adam ABICHOU <[email protected]>
Co-authored-by: Jay Clifford <[email protected]>
Co-authored-by: dbluxo <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: William Dumont <[email protected]>
Co-authored-by: Aidan Leuck <[email protected]>
Co-authored-by: Sam DeHaan <[email protected]>
Co-authored-by: Romain Gaillard <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Cristian Greco <[email protected]>
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 Beyla Component docs
2 participants