Skip to content

docs(aws_sns sink): correct documentation to use SNS topic terminology#24958

Draft
thomasqueirozb wants to merge 1 commit intomasterfrom
fix/aws-sns-docs
Draft

docs(aws_sns sink): correct documentation to use SNS topic terminology#24958
thomasqueirozb wants to merge 1 commit intomasterfrom
fix/aws-sns-docs

Conversation

@thomasqueirozb
Copy link
Contributor

Summary

The aws_sns sink documentation was incorrectly referencing SQS configuration and terminology throughout. The topic_arn field was not appearing in the live docs at all because the CUE configuration pointed to the aws_sqs generated config instead of aws_sns.

Vector configuration

NA

How did you test this PR?

Ran make generate-component-docs to regenerate the component docs and verified topic_arn now appears correctly in the generated aws_sns.cue.

Change Type

  • Bug fix
  • New feature
  • Dependencies
  • Non-functional (chore, refactoring, docs)
  • Performance

Is this a breaking change?

  • Yes
  • No

Does this PR include user facing changes?

  • Yes. Please add a changelog fragment based on our guidelines.
  • No. A maintainer will apply the no-changelog label to this PR.

References

@github-actions github-actions bot added domain: sinks Anything related to the Vector's sinks domain: external docs Anything related to Vector's external, public documentation labels Mar 18, 2026
@thomasqueirozb thomasqueirozb changed the title fix(aws_sns sink): correct documentation to use SNS topic terminology docs(aws_sns sink): correct documentation to use SNS topic terminology Mar 18, 2026
@thomasqueirozb thomasqueirozb added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Mar 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain: external docs Anything related to Vector's external, public documentation domain: sinks Anything related to the Vector's sinks no-changelog Changes in this PR do not need user-facing explanations in the release changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Confusing SNS sink documentation

1 participant