[SC-17750] Document role visibility for shared views, layouts, and Analytics pages - #1481
Open
even-steven wants to merge 1 commit into
Open
Conversation
…es (sc-17750) Covers the Visible to Roles control added by frontend#2793 / backend#3456 across all three surfaces it shipped on: shared table views, shared record and artifact field layouts, and custom Analytics pages. The story description was empty, so behavior is taken from the merged implementation. A new shared include carries the rules that hold for all three: empty means everyone, organization roles only, admins bypass restrictions, the publisher keeps access, and a restriction whose last gating role is deleted stays closed rather than widening. Each surface also gets its own constraint documented: role restrictions apply to shared views only, and neither the organization default layout nor the default Analytics page can be restricted. The Analytics include is consumed by a RevealJS training deck, so its addition uses inline prose rather than footnotes, which do not render in presentation mode. Co-Authored-By: Claude Opus 5 <[email protected]>
Contributor
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
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.
Pull Request Description
What and why?
Documents sc-17750 — the Visible to Roles control that restricts shared views, layouts, and Analytics pages to selected organization roles. Shipped in validmind/frontend#2793 and validmind/backend#3456, both merged.
The story description was empty, so all behavior here is taken from the merged implementation rather than from a spec.
All three surfaces the control shipped on are covered:
_organization-table-views.qmd— publish step, plus a new sub-section for changing name/description/roles without unpublishing_organization-field-views.qmd— publish step, plus the organization-default constraint_create-an-analytics-page.qmd(creation) andmanage-custom-reports.qmd(new Restrict an analytics page to roles section)A new shared include,
_role-visibility.qmd, carries the rules that hold on all three so they can't drift:filterScope="Organization").Customer Adminusers bypass role restrictions entirely, matching howAuthService.enforceshort-circuits for admins._accessible_clause).db/role_visibility.py.Per-surface constraints, each verified against the code that enforces them:
SavedView.unpublish).PageLayout.set_as_org_default).Also documented: the Exit View button, so a user displaying a view that's no longer available to them has a documented way out.
How to test
Rendered locally against
--profile development, then checked on the deployed preview. All seven consumers of the three edited includes render clean.Shared table views
One include, three consumers. The workflow one is the highest-value read, since it is a different product area from where the change was authored:
Within those, the restructured Edit shared views tab deserves a specific look. I split it in two, because only the first case requires unpublishing:
Shared field layouts
The organization-default constraint lives here:
Analytics pages
Visible to Rolesbullet must read as plain prose, with no footnote markers.What I verified
On the deployed preview, Visible to Roles appears on all seven pages, with per-page counts matching what each include should contribute — 3 on the three table-view pages (publish step, shared callout, edit sub-section), 2 on the two layout pages (publish step, shared callout), 4 on Manage custom reports, and 1 clean occurrence in the RevealJS deck with no footnote artifacts.
The
Edit shared viewstabset still has exactly three tabs: my addition is a####sub-section inside the existing tab, not a rogue fourth tab.UI labels were taken from the source rather than guessed —
Edit View,Save Changes, andDetails. The Analytics page editor is reached via Edit Dashboard → Details, not Edit Dashboard alone.Caveats on the preview links
The RevealJS link uses a
#/section-Nfragment, which is less stable than a heading anchor — if the slide has shifted, search the deck forVisible to Rolesinstead. Previews render only changed pages on top of validated staging, so navigation outside these seven pages may 404.What needs special review?
1. Terminology: "Visible to Roles" vs. existing permission language. The docs already describe permissions to manage shared inventory layout views as a prerequisite for publishing. Role visibility is a different axis — who can see the result — and I've kept them adjacent but distinct. Worth a check that this reads clearly rather than as two competing concepts.
2. No screenshots. The publish and edit modals gained a field; I did not capture new images. Say the word and I'll add them.
3. The role-deletion dependency dialog is out of scope here. frontend#2793 also made the delete-role confirmation list the Record Layouts and Analytics Pages that a role gates. There is currently no documentation of deleting an organization role at all —
manage-roles.qmdonly covers removing roles from users — so this is a source gap rather than an incremental edit. Flagging rather than inventing a section; happy to follow up if you want it covered.4. Related PR, duplicated wording. The sc-17866 docs PR covers the dashboard side of the same epic (Views by Role / Default Views). It states the same role-visibility rules inline rather than including
_role-visibility.qmdfrom this PR, so the two are independent and can merge in either order. Once both land, that section could switch to this include — worth doing, but not a blocker here.Dependencies, breaking changes, and deployment notes
main).site/guide/shared/manage-views/_role-visibility.qmd. The sc-17866 docs PR duplicates its wording inline rather than including it, so there is no file overlap and no ordering constraint between the two.Release notes
Shared views, record and artifact field layouts, and custom analytics pages can now be limited to selected organization roles. Set Visible to Roles when publishing, or leave it empty to keep something visible to everyone in your organization. Learn more ...
Checklist
documentation