[MASTER] Update Docs for Custom KM for OOB Mode#10708
Conversation
WalkthroughThree documentation files were added and updated to provide a comprehensive user guide for configuring a Custom Key Manager in Out-of-Band provisioning mode with external OAuth 2.0 authorization servers, along with corresponding navigation updates to the documentation site structure. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@en/docs/administer/key-managers/configure-custom-km-out-of-band.md`:
- Line 79: Update the Introspection Endpoint table row to use consistent
capitalization and a clear descriptive phrase: change "introspection is **not
supported** for the OOB mode" to a capitalized, succinct description such as
"Not supported in Out‑of‑Band (OOB) mode" (or "Not supported in OOB mode") so it
matches other rows' style and reads as a field description rather than a caveat;
apply this change to the "Introspection Endpoint" row in the table.
- Line 127: The numbered list has a wrong step number for the final action:
change the line containing "Click **Add** to save the Key Manager
configuration." so its prefix number is 4 instead of 5; update the ordered list
item number to 4 (ensuring the surrounding steps remain 1–3 for the prior items
and the subsections remain under step 3) so the sequence reads 1, 2, 3, 4.
In `@en/docs/administer/key-managers/overview.md`:
- Around line 60-61: Update the markdown link text that currently reads "Custom
Key Manager (Out-of-Band Provisioning)" to match the project's link-title
pattern and the page title; change it to "Configure a Custom Key Manager for
Out-of-Band Provisioning" for the link pointing to
/administer/key-managers/configure-custom-km-out-of-band/ so it aligns with
other entries that follow "Configure X as a Key Manager".
🧹 Nitpick comments (1)
en/docs/administer/key-managers/configure-custom-km-out-of-band.md (1)
162-172: Steps 4 content is sparse — consider adding a sample token request and API invocation example.Other Key Manager docs in this repo typically include sample
curlcommands for token generation and API invocation. Adding at least a generic example (with placeholder values) would make this guide more actionable for users, especially since OOB mode requires external token generation which may be unfamiliar.
cbd454b to
76f5246
Compare
76f5246 to
5bfdea3
Compare
Description
Added documentation for custom key manager onboarding for Out-of-band provisioning.
Related Issue
Summary by CodeRabbit