Skip to content

Fix small bugs in hints autodiscovery doc#5641

Merged
eedugon merged 2 commits intomainfrom
eedugon/fix-hints-autodiscovery-obvious-bugs
Mar 27, 2026
Merged

Fix small bugs in hints autodiscovery doc#5641
eedugon merged 2 commits intomainfrom
eedugon/fix-hints-autodiscovery-obvious-bugs

Conversation

@eedugon
Copy link
Copy Markdown
Contributor

@eedugon eedugon commented Mar 26, 2026

While reviewing #5397 I found some extra and minor bugs that would need attention. I think they are all obvious but important at the same time.

Summary

  • Correct the hints key name from co.elastic.hints/data_stream to co.elastic.hints/data_streams in the optional hints section heading.
  • Fix the rename processor hints example to use matching list index keys (fields.0.from and fields.0.to).
  • Replace tab indentation with spaces in the multi-container annotations YAML snippet to avoid invalid YAML formatting.

Test plan

  • Verify main...HEAD diff includes only reference/fleet/hints-annotations-autodiscovery.md.
  • Run docs lint diagnostics for the edited file (no lint errors).
  • Manually confirm examples align with current Elastic Agent hints behavior.

Made with Cursor

Correct the documented `data_streams` hint key, fix the `rename` processor example index mapping, and replace tab indentation with spaces in a YAML annotation example so snippets are consistent and valid.

Made-with: Cursor
@eedugon eedugon requested a review from a team as a code owner March 26, 2026 12:23
@eedugon eedugon requested a review from lucabelluccini March 26, 2026 12:24
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 26, 2026

🔍 Preview links for changed docs

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 26, 2026

✅ Vale Linting Results

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

Copy link
Copy Markdown
Contributor

@lucabelluccini lucabelluccini left a comment

Choose a reason for hiding this comment

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

Nice catch! Thank you

@eedugon eedugon changed the title Fix obvious bugs in hints autodiscovery doc examples Fix small bugs in hints autodiscovery doc Mar 26, 2026
Copy link
Copy Markdown
Member

@vishaangelova vishaangelova left a comment

Choose a reason for hiding this comment

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

LGTM!

@eedugon eedugon enabled auto-merge (squash) March 27, 2026 09:55
@eedugon eedugon merged commit 7df67f1 into main Mar 27, 2026
6 checks passed
@eedugon eedugon deleted the eedugon/fix-hints-autodiscovery-obvious-bugs branch March 27, 2026 09:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants