[MASTER] Update Docs for Custom KM for OOB Mode#10708
[MASTER] Update Docs for Custom KM for OOB Mode#10708dakshina99 wants to merge 1 commit intowso2:master-backupfrom
Conversation
dakshina99
requested review from
chamilaadhi and
tharikaGitHub
as code owners
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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.
| | Token Endpoint | The endpoint URL where tokens are issued. | Mandatory | | ||
| | Revoke Endpoint | The endpoint URL for revoking tokens. | Optional | | ||
| | JWKS Endpoint | The JSON Web Key Set endpoint for JWT signature validation. | Optional | | ||
| | Introspection Endpoint | introspection is **not supported** for the OOB mode | Optional | |
There was a problem hiding this comment.
Inconsistent capitalization and phrasing in the Introspection Endpoint row.
"introspection" should be capitalized to match other rows, and the description reads more like a caveat than a description of the field.
Proposed fix
-| Introspection Endpoint | introspection is **not supported** for the OOB mode | Optional |
+| Introspection Endpoint | The endpoint URL for token introspection. Introspection is **not supported** in OOB mode. | Optional |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Introspection Endpoint | introspection is **not supported** for the OOB mode | Optional | | |
| | Introspection Endpoint | The endpoint URL for token introspection. Introspection is **not supported** in OOB mode. | Optional | |
🤖 Prompt for AI Agents
In `@en/docs/administer/key-managers/configure-custom-km-out-of-band.md` at 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.
| !!! warning "Important" | ||
| When **Token Generation** is disabled, the Developer Portal will display the Token Endpoint URL so that developers can generate tokens externally using their preferred method. | ||
|
|
||
| 5. Click **Add** to save the Key Manager configuration. |
There was a problem hiding this comment.
Step numbering is off — should be step 4, not step 5.
The numbered steps in "Step 2" go 1, 2, 3 (line 57), then jump to 5 here. The subsections (General Details, Endpoints, etc.) are all part of step 3's configuration, so this should be step 4.
Proposed fix
-5. Click **Add** to save the Key Manager configuration.
+4. Click **Add** to save the Key Manager configuration.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 5. Click **Add** to save the Key Manager configuration. | |
| 4. Click **Add** to save the Key Manager configuration. |
🤖 Prompt for AI Agents
In `@en/docs/administer/key-managers/configure-custom-km-out-of-band.md` at 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.
|
|
||
| - [Custom Key Manager (Out-of-Band Provisioning)]({{base_path}}/administer/key-managers/configure-custom-km-out-of-band/) |
There was a problem hiding this comment.
Link text is inconsistent with other entries and the page title.
All other entries follow the pattern "Configure X as a Key Manager" (e.g., lines 47–59), and the actual page title in mkdocs.yml is "Configure a Custom Key Manager for Out-of-Band Provisioning". Consider aligning this link text.
Proposed fix
-- [Custom Key Manager (Out-of-Band Provisioning)]({{base_path}}/administer/key-managers/configure-custom-km-out-of-band/)
+- [Configure a Custom Key Manager for Out-of-Band Provisioning]({{base_path}}/administer/key-managers/configure-custom-km-out-of-band/)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [Custom Key Manager (Out-of-Band Provisioning)]({{base_path}}/administer/key-managers/configure-custom-km-out-of-band/) | |
| - [Configure a Custom Key Manager for Out-of-Band Provisioning]({{base_path}}/administer/key-managers/configure-custom-km-out-of-band/) |
🤖 Prompt for AI Agents
In `@en/docs/administer/key-managers/overview.md` around lines 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".
1 participant
Description
Added documentation for custom key manager onboarding for Out-of-band provisioning.
Related Issue
Summary by CodeRabbit