docs: style-standards sweep (terminology fixes)#121
Merged
Conversation
Grounded in the docs-team-standards terminology list: - "once" (ambiguous) -> "after" for temporal uses: transcripts, budgets, ramp, remote-mcp-clients. - "via" -> "through": managed-catalog Gmail row. - Drop the trademarked "ADP" acronym rendered by two stale glossterm macros in cli/index and cli/gitops: glossterm:Agentic Data Plane (ADP)[] -> glossterm:Agentic Data Plane[], matching the renamed glossary term (docs #1774). Excluded: en dashes in numeric ranges (not the banned em dash), one-time "once", code-block matches, and judgment-heavy passive-voice cleanup. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-agentic-data-plane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A style-standards sweep of the hand-authored adp-docs pages, grounded in the docs-team-standards terminology list. Seven small terminology fixes across seven pages.
Changes
"once" → "after" (the word list flags "once" as ambiguous — one-time vs. as-soon-as):
monitor/transcripts.adoc— "resolve after the OTLP ingestion lag clears"control/budgets.adoc— "a different rate after a request crosses a context-length threshold"connect/managed/ramp.adoc— "appears after the task completes"connect/remote-mcp-clients.adoc— "so after the access token expires""via" → "through" (word list: do not use "via"):
connect/managed/managed-catalog.adoc— "Read and send emails through Gmail"Drop the trademarked "ADP" acronym rendered by two stale glossterm macros (follow-up to the #116 rename, now unblocked by the glossary rename in redpanda-data/docs #1774):
cli/index.adoc,cli/gitops.adoc—glossterm:Agentic Data Plane (ADP)[]→glossterm:Agentic Data Plane[](verified the glossterm resolves and no longer renders "(ADP)")Scope / excluded
Clean on the rest of the deterministic checks:
e.g./i.e./etc./please/and/or/for instance, RedPanda miscap, "Step N:" headings, learning-objective banned verbs, andwe-voice all came back zero.Verification
npm run buildcompletes clean; the CLI pages render "Agentic Data Plane" with no "(ADP)".Related
The systemic fix so these stop slipping through generated PRs is docs-team-standards #2862 (deterministic terminology lint wired into the post-edit hook).
🤖 Generated with Claude Code
Preview
Entry point (7 pages changed; navigate from here): https://deploy-preview-121--redpanda-agentic-data-plane.netlify.app/agentic-data-plane/ (404s until Netlify finishes the build)