Add B2B concepts guide with hierarchy and terminology#5863
Add B2B concepts guide with hierarchy and terminology#5863HasiniSama wants to merge 1 commit intowso2:masterfrom
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughAdds a new Organizations overview guide across all documentation versions (7.0.0, 7.1.0, 7.2.0, and next) by creating a shared canonical documentation file and adding navigation entries. Version-specific documents include content from the shared source to avoid duplication. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
⚔️ Resolve merge conflicts (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: 1
🤖 Fix all issues with AI agents
In `@en/includes/concepts/b2b-concepts.md`:
- Around line 248-268: The example endpoint strings in the Root organization
section (`https://api.example.com/management/v1/organizations`) and Organization
APIs section (`https://api.example.com/o/{org-id}/users`) are misleading; update
them to either the realistic documented paths (e.g.,
`https://{{host}}/api/server/v1/organizations` for root org APIs and
`https://{{host}}/o/api/server/v1/applications` or
`https://{{host}}/o/scim/Users` for org-scoped APIs) or explicitly mark the
examples as non-functional placeholders (e.g., prefix with "Example
placeholder:"), replacing the incorrect `/management/v1/organizations` and
`/o/{org-id}/users` strings in en/includes/concepts/b2b-concepts.md so readers
won’t copy-paste the wrong endpoints.
🧹 Nitpick comments (1)
en/includes/concepts/b2b-concepts.md (1)
42-45: Clarify “root organization” vs “tenant.”The parenthetical “(also called tenant)” could be confusing in multitenant IS deployments. Consider a short clarification (or a link to the multitenancy guide) to explain how “tenant” maps to “root organization.”
22ea4cf to
9642bf7
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@en/includes/concepts/b2b-concepts.md`:
- Line 70: Replace the typo in the sentence "Sets heirarchy-vise policies." by
updating the phrase to "Sets hierarchy-wise policies." — locate the exact line
containing "Sets heirarchy-vise policies." in the b2b-concepts content and
change "heirarchy-vise" to "hierarchy-wise".
- Line 68: The sentence "Creates their own child organizations." uses the plural
pronoun "their" for the singular subject "Root organization"; update the text in
en/includes/concepts/b2b-concepts.md replacing "their" with "its" so the line
reads "Creates its own child organizations." to fix pronoun-antecedent
agreement.
🧹 Nitpick comments (3)
en/includes/concepts/b2b-concepts.md (3)
27-27: Complete the section heading.The heading "Choose B2B when you [Need to be updated]" has an incomplete placeholder. Please finalize this section with the appropriate criteria.
Would you like me to suggest completion options based on the list items that follow (lines 29-32)?
91-91: Use plural form for consistency.All other items in the list use plural forms ("applications, roles, and users" in line 47; "roles" and "users" in this line). Change "application" to "applications" for parallelism.
📝 Proposed fix
-- Manages its own application, roles, and users. +- Manages its own applications, roles, and users.
153-153: Complete the section heading.The heading "⑥ Putting it all together [Need to be updated]" has a placeholder marker. Please finalize this heading to remove the TODO note.
If the current heading is acceptable, simply remove "[Need to be updated]". Otherwise, let me know if you'd like suggestions for alternative titles.
9642bf7 to
986b1bc
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@en/includes/concepts/organizations-overview.md`:
- Around line 39-44: Fix the typo in the text snippet in
en/includes/concepts/organizations-overview.md by replacing "heirarchy-vise"
with the correct phrase "hierarchy-wise" in the line containing "- Sets
heirarchy-vise policies." so the bullet reads "- Sets hierarchy-wise policies."
- Around line 62-67: Update the pluralization in the bullet list by changing the
phrase "Manages its own application, roles, and users." to "Manages its own
applications, roles, and users." so it matches the other plural nouns; locate
this string in en/includes/concepts/organizations-overview.md and replace
"application" with "applications" in the list item.
🧹 Nitpick comments (1)
en/includes/concepts/organizations-overview.md (1)
75-78: Consider splitting the dense resource table for readability.The "Resources" row on line 78 packs a large number of items into two cells, which makes the source hard to review and maintain. Consider using sub-tables or bullet lists within each column, or breaking this into separate tables per resource behavior type.
986b1bc to
d437ab0
Compare
d437ab0 to
29bf195
Compare
|
|
||
| An **organization** represents one entity in your system. | ||
|
|
||
| Each organization has its own applications, roles, APIs, and users. Organizations can customize login pages, branding, and have dedicated administrators with isolated data and configurations. |
There was a problem hiding this comment.
shall we remove APIs from this list, as we don't have the capability to define APIs in the child orgs.
Update the image as well
NOTE: Last two diagrams needs to be updated according to the usecase.
Purpose
Comprehensive documentation covering organizations, hierarchy (root/child), ownership vs sharing, inheritance model, and Management vs Organization APIs.
Related Issue
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.