Skip to content

docs: pipeline: outputs: opentelemetry: fix lint errors#2623

Open
eschabell wants to merge 1 commit into
fluent:masterfrom
eschabell:erics_out_opentelemetry_fixes
Open

docs: pipeline: outputs: opentelemetry: fix lint errors#2623
eschabell wants to merge 1 commit into
fluent:masterfrom
eschabell:erics_out_opentelemetry_fixes

Conversation

@eschabell

@eschabell eschabell commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator
  • reword "plaintext" to "plain text" to clear the Vale spelling suggestion
  • reformat all tables from padded alignment to compact single-space style to resolve markdownlint MD060 errors and match the other output docs (http.md, s3.md)

Summary by CodeRabbit

  • Documentation
    • Corrected Markdown table formatting in the OpenTelemetry output plugin documentation.
    • Clarified OTLP/gRPC example wording to “plaintext OTLP/gRPC.”
    • Reformatted and standardized the configuration parameters table (key/description/default) for improved readability and consistent spacing.

@eschabell eschabell self-assigned this Jul 13, 2026
@eschabell eschabell requested a review from a team as a code owner July 13, 2026 14:42
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0.9 labels Jul 13, 2026
@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4f709ea1-0196-413a-b2b3-c8dee7149a89

📥 Commits

Reviewing files that changed from the base of the PR and between d4e4422 and 6ed27e5.

📒 Files selected for processing (1)
  • pipeline/outputs/opentelemetry.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • pipeline/outputs/opentelemetry.md

📝 Walkthrough

Walkthrough

The OpenTelemetry output documentation was reformatted. Transport table separators and terminology were corrected, and configuration parameters were rewritten into a consistent three-column Markdown table with normalized formatting.

Changes

OpenTelemetry documentation

Layer / File(s) Summary
Format transport and configuration documentation
pipeline/outputs/opentelemetry.md
Transport tables and example wording were corrected, while configuration parameters were normalized into a consistent key/description/default table.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested labels: 5.0

Suggested reviewers: patrick-stephens

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the PR’s main purpose: fixing documentation lint issues in the OpenTelemetry output docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@eschabell

Copy link
Copy Markdown
Collaborator Author

@patrick-stephens fixing errors not handled in doc PR #2621.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@pipeline/outputs/opentelemetry.md`:
- Line 68: Update the aws_role_arn description in the OpenTelemetry
documentation to use “e.g., for cross-account access,” including the hyphenation
and preferred abbreviation.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 327b6894-c868-488d-a722-ab16e9b4de30

📥 Commits

Reviewing files that changed from the base of the PR and between 9ac2dfa and d4e4422.

📒 Files selected for processing (1)
  • pipeline/outputs/opentelemetry.md

Comment thread pipeline/outputs/opentelemetry.md Outdated
- reword "plaintext" to "plain text" to clear the Vale spelling suggestion
- reformat all tables from padded alignment to compact single-space
  style to resolve markdownlint MD060 errors and match the other
  output docs (http.md, s3.md)
- fixed hyphenated vale issue

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the erics_out_opentelemetry_fixes branch from d4e4422 to 6ed27e5 Compare July 13, 2026 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5.0.9 waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants