Skip to content

change admonition#507

Merged
micheleRP merged 1 commit intomainfrom
change-admonition
Feb 19, 2026
Merged

change admonition#507
micheleRP merged 1 commit intomainfrom
change-admonition

Conversation

@micheleRP
Copy link
Contributor

@micheleRP micheleRP commented Feb 19, 2026

Description

This pull request replaces references to the byoc-aws-requirement.adoc and ai-gateway-byoc-note.adoc partials with a new adp-la.adoc partial across all relevant files. This ensures consistent messaging and reduces duplication.

  • Replaced include::ai-agents:partial$byoc-aws-requirement.adoc[] and include::ai-agents:partial$ai-gateway-byoc-note.adoc[] with include::ai-agents:partial$adp-la.adoc[] in all agent and AI Gateway documentation pages for consistency. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18]

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:

Page previews

admonition

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@micheleRP micheleRP requested a review from a team as a code owner February 19, 2026 22:27
@netlify
Copy link

netlify bot commented Feb 19, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit c69baa9
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/69978e577ac2700008530595
😎 Deploy Preview https://deploy-preview-507--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 19, 2026

📝 Walkthrough

Walkthrough

This PR systematically replaces documentation partial includes across 41 files in the AI Agents module. The primary change swaps include directives from either ai-gateway-byoc-note.adoc or byoc-aws-requirement.adoc to adp-la.adoc in pages and partials throughout the AI Agents, AI Gateway, and observability documentation. Additionally, troubleshooting.adoc receives expanded guidance content addressing tool usage verification, cost-conscious behavior patterns, and explicit response constraints for agents. All changes are documentation-focused with no modifications to code logic or data structures.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

  • [Epic Branch] ADP pkg1 #494 — Introduces ADP-focused documentation additions and partials that align with the adp-la.adoc includes now being referenced throughout this PR.
  • DOC-1962 #505 — Modifies modules/ai-agents/pages/adp-overview.adoc (the same file updated in this PR with the adp-la.adoc include swap).
  • Add docs for remote MCP servers #413 — Edits modules/ai-agents/pages/index.adoc to change included partials, directly overlapping with this PR's scope.

Suggested reviewers

  • birdayz
  • paulohtb6
  • Feediver1
🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description explains the core change (replacing two partials with one) and includes the rationale, but lacks required template sections: issue number is a placeholder, no review deadline, and no actual page preview links are provided. Replace the placeholder issue number with the actual GitHub issue URL, add a review deadline if applicable, and provide concrete page preview links using the Netlify preview format as specified in the template.
Title check ❓ Inconclusive The title 'change admonition' is vague and does not clearly convey the main objective of replacing two partials with a new consolidated one. Use a more descriptive title such as 'Replace byoc partials with adp-la across documentation' to better summarize the change.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch change-admonition

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

Copy link
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

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

lgtm

@micheleRP micheleRP merged commit 0642848 into main Feb 19, 2026
5 checks passed
@micheleRP micheleRP deleted the change-admonition branch February 19, 2026 23:21
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