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

Update otelcol.exporter.kafka.md #1959

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

lomobot
Copy link

@lomobot lomobot commented Oct 22, 2024

PR Description

Changes were added in otelcol.exporter.kafka.md

Notes to the Reviewer

Current doc markup structure for otelcol.exporter.kafka module doesn't describes that plaintext, sasl, aws_msk, tls, kerberos must be included in authentication block and retry block in metadata. I'd try to highlight this fact by using markup for this blocks.

PR Checklist

  • Documentation added

Changes were added in otelcol.exporter.kafka.md
@clayton-cornell
Copy link
Contributor

clayton-cornell commented Oct 24, 2024

Thanks for this suggestion. :-)

This change isn't consistent with the other component documentation topics (there are a few topics that do nest the blocks as a child heading in the doc structure, but not all do this). The block nesting is shown in the Blocks table here: https://grafana.com/docs/alloy/latest/reference/components/otelcol/otelcol.exporter.kafka/#blocks

I agree the presentation in the individual block descriptions doesn't make it clear what has to go where. I've got an open task right now to revisit how we document this exact part of the component documentation. So, I'd like to put this PR on hold for a couple of days until I've had some time to revisit this suggestion - if this is the way forward, then we can either add other topics with similar issues to this PR or open up a new PR to capture the change in the other topics (keeps things consistent)

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants