docs: update for 1.69 release#4867
Conversation
- Connect: document wildcard suffix entry format (e.g. .benchling.com) - Qurator: note platform MCP tools work in-catalog without Connect - Admin: theme logo upload, stack-managed bucket protection, role-scoped listings - SSO: document union_roles flag - Benchling: async canvas updates and reviewRecord trigger Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4867 +/- ##
=======================================
Coverage 46.51% 46.51%
=======================================
Files 832 832
Lines 34116 34116
Branches 5828 5828
=======================================
Hits 15868 15868
Misses 16243 16243
Partials 2005 2005
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Refresh QuiltSync Settings screenshot (Commit and Push, Auth, Diagnostics) - Add Benchling canvas updated state screenshot - Add Qurator platform-tools connector screenshot Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
optipng -o7 -zm1-9; combined ~14 KB saved. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
sir-sigurd
left a comment
There was a problem hiding this comment.
1. Admin.md — drop "Stack-managed buckets" section
docs/Catalog/Admin.md:108-112. Two reasons:
- Wrong home — this file documents the catalog admin panel UI; the new section is about an S3-policy-level guardrail applied by CloudFormation.
- Self-surfacing — admins who try a console change get a clear AWS denial at that moment, with the bucket policy as the explanation. A reader not mid-incident has no reason to encounter this section; one mid-incident gets the answer from the error itself.
Already covered in the 1.69 release notes — drop here.
2. Admin.md — drop "Role-scoped bucket listings" section
docs/Catalog/Admin.md:114-119. "Rather than every bucket on the stack" is changelog-shaped — only meaningful to a reader who already knows the prior behavior. The substantive product fact (admins are also scoped by role grants) is already covered at lines 46-47, which currently reads as if it excludes admins. Drop the new section and clarify there instead.
3. sso-permissions.md — list item 3 misnested
docs/advanced-features/sso-permissions.md:70-76. Item 3 ("all other users will have ReadQuiltBucket role") applies regardless of union_roles, but it's nested under the "With union_roles: true" header. Reader can infer the default_role fallback is union-mode-specific.
4. Connect.md — wildcard semantics underspecified
docs/Catalog/Connect.md:39. New row says .benchling.com matches https://<any-subdomain>.benchling.com/*. Two questions unanswered:
- Does it match the apex (
https://benchling.com/*)? - Does it match nested subdomains (
https://app.us.benchling.com/*)?
Also, lines 50-53 ("use a bare hostname for HTTPS clients") are now stale — should mention the wildcard form.
- Admin.md: drop standalone "Stack-managed buckets" and "Role-scoped bucket listings" sections; reword the existing managed-roles paragraph to clarify that admins are also scoped by their role's bucket grants - sso-permissions.md: move the default_role fallback out of the union_roles list since it applies regardless of that flag - Connect.md: clarify wildcard-suffix semantics (matches any subdomain at any depth; does not match the apex) and update the bare-hostname guidance to mention the wildcard form
|
Thanks @sir-sigurd — addressed all four in 9517ffb:
|
Combine the pre-example "first match" / "union_roles" notes into one "by default … alternatively" block, and rewrite the post-example walkthrough the same way so the two modes read as alternatives instead of two contradicting paragraphs.
sir-sigurd
left a comment
There was a problem hiding this comment.
Rename applied in 93fda08 — re-approving.
Summary
Minimal docs updates aligned with the 1.69 platform release notes:
.benchling.com) inConnectAllowedHostsunion_roles: trueflagreviewRecordtriggerTest plan
Connect.mdandCatalog/Admin.md🤖 Generated with Claude Code
Greptile Summary
This PR updates documentation for the 1.69 platform release across five files, covering wildcard host entries in
ConnectAllowedHosts, in-catalog MCP tool availability in Qurator, theme logo file upload, stack-managed bucket protection, role-scoped admin bucket listings, the newunion_roles: trueSSO flag, and async Benchling canvas updates withreviewRecordtrigger support. The changes are minimal, accurate, and consistent with the existing documentation style.Confidence Score: 5/5
Safe to merge — documentation-only changes with no code impact.
All five files contain accurate, well-scoped documentation additions. No logic, security, or formatting issues were found. Changes are consistent with the existing document style throughout the repo.
No files require special attention.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[SSO Login] --> B{union_roles: true?} B -- No --> C[First matching mapping applied] B -- Yes --> D[All matching mappings evaluated] D --> E[Union of roles granted] E --> F[User can switch roles via role switcher] E --> G[Roles not in match set revoked on next login] C --> F H[ConnectAllowedHosts entry] --> I{Format?} I -- Hostname --> J["https://hostname/*"] I -- Wildcard suffix --> K["https://subdomain.domain/*"] I -- Custom scheme --> L["scheme://any-host/*"] I -- localhost --> M["http://localhost:port/*"]Reviews (1): Last reviewed commit: "docs: update for 1.69 release" | Re-trigger Greptile