docs(rbac): split Roles & Permissions into three pages - #826
Open
abhijaisrivastava15 wants to merge 2 commits into
Open
docs(rbac): split Roles & Permissions into three pages#826abhijaisrivastava15 wants to merge 2 commits into
abhijaisrivastava15 wants to merge 2 commits into
Conversation
The single page had reached 7,400 words with sixteen top-level headings, so finding one fact meant scanning all of them. It splits along the seam it already had. Roles and permissions is a question about what one person can reach, and that is now a reference page carrying five grids. Organization and workspace segregation is a question about where a boundary sits, and that is now a concept page. The setup walkthrough, the people lifecycle and share links each become their own guide, and the FAQ becomes a troubleshooting page. The shape is copied from the billing/ folder on this branch rather than invented: index plus concepts, guides and reference, with the flat troubleshooting.mdx that annotations/ uses. /docs/roles-and-permissions still resolves, because the folder index serves the same URL. Also answers the review on #802: the blurred emails on users-list.png are redone as house masks, seat limits are gone from every page and from the diagram, the diagram names all three boxes as workspaces and shows traces in each, user management gains the reactivation answer, and every page now puts the keys page at Build > Keys rather than Settings.
Eight pages was a finer cut than the content needs. Three match the seams Khushal named: organization and workspace segregation is the Overview, what one person can and cannot reach is the reference, and doing any of it is the guide. About 1,900 words each. Also lands the style pass against his billing pages: one owner per fact with links instead of restatement, the FAQ in his troubleshooting shape, company-side voice out of the openers, and 'act on' replaced with what the reader actually does.
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
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.
What
Splits
Roles & Permissionsfrom one 7,400 word page into three, built to the same shape as thebilling/folder you merged in #821.Three pages, about 1,900 words each.
/docs/roles-and-permissionskeeps working, because the folder index serves the same URL, so no redirect is needed and no inbound link breaks.Why these three
The page was two subjects and a lookup table interleaved.
Organization and workspace segregation is a question about where a boundary sits. That is the Overview now, with the diagram, what is scoped where, and the four things the boundary does not cover.
What one person can and cannot reach is a lookup. That is the reference: six grids and the troubleshooting table, nothing else.
Doing any of it is a walkthrough. That is the guide: workspaces, roles, invites, keys, role changes, removals, 2FA and share links, in the order they come up.
Page shapes
Copied from
billing/, not invented. index opens with a lead and closes on## Start here. The guide opens with a lead, carries## Before you startwith a reason on each bullet, uses imperative H2s, and closes on## Dive deeper. The reference opens at its first H2 and closes on## Keep exploring. Frontmatter descriptions carry a trailing period on the guide and none on the other two, matching yours.Content
Every claim was derived by driving the live dashboard through nine role combinations, because a customer cannot read our source. Some of what that turned up:
A key silently takes the workspace you have open. The Add API Key dialog asks for a name and nothing else, but the key binds to whichever workspace is active and traces sent with it land there. Build > Keys then lists only that workspace's keys, so a key made in the wrong place shows the empty state until you switch back.
Delete Key is Owner-only, and the button does not say so. An Admin or a Workspace Admin gets the confirmation and then
You are not authorized to access this resource. Proved by an A/B on one key, same organization, same coordinates, only the role changed.The obvious team setup cannot do its own job. A team lead as organization Member plus Workspace Admin fails the moment the people they lead are also Members, because a Workspace Admin can only change or remove people whose organization role is lower than their own.
Four things the boundary does not cover, which anyone promising a customer isolation needs first: the gateway, where a key can send, what a key can be aimed at, and usage.
Chintan's review on #802, carried over
#802 got 43 inline comments from @jedigalt on 12 Aug. This is the answer to them.
users-list.pngwas a blur, flagged twice. Redone the house way: sharp black rectangles with whitemaskedcentred, blur ghost wiped back to the table background, Status column untouchedadmin-settings/api-keys.mdxsaid Settings > API Keys; clicking through the app puts it at Build > Keys. Every page now says Build > KeysOne comment not acted on, and it is yours to call: "we dont have gateway keys and request logs as part of organization." Driving the live app put gateway request logs at the organization and let every role open every gateway page. That is what these pages say. If the product has moved, say so and I will change it everywhere in one pass.
Verification
npx astro build: 1174 pages, no errorsnode scripts/audit-links.mjs: 0 broken content links, 0 broken nav links, no new orphansX-Workspace-Idoverride order, the reactivation answer) and all are restored/docs/installationto/docs/sdk,/docs/admin-settings/billing-pricingto/docs/billing,/docs/annotations/features/queuesto/docs/annotations/concepts/queues-and-itemsAlso in this PR
api-keys,user-managementandworkspace-managementrewritten against the same evidence,AboutandNext Stepsreplaced with the house headings, titles matched to their sidebar labels.Route names corrected: Profile is
/settings/profile-settings, Org Settings is/settings/org-settings, Workspaces is singular/settings/workspace. The previously documented/settings/profile,/settings/organizationand/settings/workspacesare not routes and 404 for an Owner.Known gaps, left out deliberately
0-0 of 0everywhere. Untestable, so unclaimedinvite-modal.pngis 1068 wide againstusers-list.pngat 3024. It needs a re-capture at full width to meet the uniform-size rule