Skip to content

[DOCS-7735] Improve clarity and formatting on Ingestion Mechanisms page#36280

Merged
brett0000FF merged 1 commit intomasterfrom
brett.blue/cleanup-ingestion-mechanisms-page
Apr 28, 2026
Merged

[DOCS-7735] Improve clarity and formatting on Ingestion Mechanisms page#36280
brett0000FF merged 1 commit intomasterfrom
brett.blue/cleanup-ingestion-mechanisms-page

Conversation

@brett0000FF
Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Fixes DOCS-7735, DOCS-9206

Editorial cleanup of the Ingestion Mechanisms page to improve readability and fix style guide violations. Also resolves the self-referencing deprecation banner reported in DOCS-9206.

Changes:

  • Fix grammar issues (subject-verb agreement, awkward phrasing, missing articles)
  • Replace Vale-flagged words throughout (a number of, ensures, quickly, will, Nginx)
  • Fix the App Analytics deprecation banner that linked back to the section it was already in (confusing self-reference)
  • Change banner from alert-danger to alert-warning and replace self-links with inline references
  • Fix heading casing (RUM TracesRUM traces, In SDKs: user-defined rules)
  • Clean up extra blank lines, broken mid-sentence line breaks, and trailing spaces
  • Tighten prose throughout for clarity and conciseness
  • Fix "visibility on" → "visibility into" (idiomatic phrasing)

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

Pure editorial — no content additions or technical changes. Vale warnings reduced from 20 to 4 (all remaining are false positives: Hugo shortcode identifiers and intentional deprecated product name references).

Fixes DOCS-7735, DOCS-9206

- Fix grammar issues (subject-verb agreement, awkward phrasing)
- Replace Vale-flagged words ("a number of", "ensures", "quickly", "will")
- Fix self-referencing deprecation banner that linked back to its own section
- Fix heading casing ("RUM Traces" → "RUM traces")
- Fix "Nginx" → "NGINX" per style guide
- Clean up extra blank lines and broken mid-sentence line breaks
- Tighten prose throughout for readability
@brett0000FF brett0000FF marked this pull request as ready for review April 24, 2026 23:56
@brett0000FF brett0000FF requested a review from a team as a code owner April 24, 2026 23:56
@github-actions
Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@brett0000FF brett0000FF merged commit bb41fc8 into master Apr 28, 2026
21 of 22 checks passed
@brett0000FF brett0000FF deleted the brett.blue/cleanup-ingestion-mechanisms-page branch April 28, 2026 17:25
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.

2 participants