Skip to content

docs(permissions): Administrator Guide — 面向客户系统管理员的 onboard 任务手册 - #2929

Merged
os-zhuang merged 2 commits into
mainfrom
claude/admin-operations-manual-cdlbke
Jul 14, 2026
Merged

docs(permissions): Administrator Guide — 面向客户系统管理员的 onboard 任务手册#2929
os-zhuang merged 2 commits into
mainfrom
claude/admin-operations-manual-cdlbke

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Closes #2917

做了什么

原 draft PR 的草稿在任何远程分支上都找不到(本地 git 环境损坏时丢失),按 issue 大纲在干净环境重建了全文,并逐条对照当前代码核实了事实。

  • 新增 content/docs/permissions/administrator-guide.mdx(英文 MDX,~210 行),以「onboard 一个租户」为主线:
    1. 四个概念,只有一个每天用 —— capability / permission set / position / user 分工表 + 90% 规则;
    2. 流程一览 —— 建组织 → 加人 → 给角色 → 验证;
    3. Step 1 建组织(Business Units 的 Org Chart 树视图,附 business unit / team / organization 区分表);
    4. Step 2 管理用户(Invite / Create / Import 三条入口 + Ban/Unban、Unlock、Set Password、Impersonate 生命周期动作);
    5. Step 3 给角色sys_user_position 分配 + BU 锚点 + 权限集记录页 Assigned Users 直接授权);
    6. Step 4 验证(Impersonate + Studio Access「Explain access」);
    7. Step 5 配置权限 —— 一句话立规矩:权限在 Studio 设计、在 Setup 分配,矩阵编辑器是结构化电子表格,不手写 JSON;
    8. Quick paths / FAQ / 「东西在哪」速查表。
  • meta.jsonindex 后插入 administrator-guideindex.mdx 模块列表加入链接。

事实核对(重建时逐一验证)

  • Users 动作以 packages/platform-objects/src/identity/sys-user.object.tsactions[] 为准(invite_user / create_user / ban / unban / unlock_user / set_user_password / impersonate_user 均存在,临时密码一次性展示);
  • BU 树以 sys-business-unit.object.tsorg_chart tree 视图为准(缩进展开树格,改挂靠走 Edit 选父节点,无拖拽)——如实标注为粗糙点;
  • 分配岗位 / BU 成员 / 直接授权三个入口分散、未收进用户页单面板 —— 如实标注;
  • 自助改密依赖已配置的邮件/短信通道(cloud#580)—— 如实标注;
  • 前置修正不再需要:issue 提到的 delegated-administration.mdx frontmatter 垃圾 description 在当前 main 上已是干净的(见 6e2b8ae 之后的版本),本 PR 未改动该文件。

验证

按 issue 要求在 docs 门户浏览器实测(非只读 MDX 推断):pnpm docs:dev + Chromium 渲染 /docs/permissions/administrator-guide —— H1/11 个 H2/5 张表格/侧边栏导航项均正常,页内全部站内链接与锚点(#admin-user-management#access-depth--readscope--writescope-adr-0057-d1 等)实测 200/存在,无页面 JS 错误。

🤖 Generated with Claude Code

https://claude.ai/code/session_01DPYFwzYSsKjU12xSJtbAyB


Generated by Claude Code

…nual for tenant admins

Adds content/docs/permissions/administrator-guide.mdx: an operations manual
for customer system administrators, organized around onboarding a tenant
(build the business-unit tree → add users → assign positions → verify with
impersonation + explain), with the 90% rule (daily admin = assigning
positions; capability ships built-in), quick paths, FAQ, and a
where-is-everything cheat sheet. Registers the page in meta.json after index
and links it from the module overview.

Facts verified against the current runtime surface: sys_user actions
(invite/create/import, ban/unban/unlock/set-password/impersonate), the
sys_business_unit org-chart tree view, sys_user_position BU anchors and the
D12 delegated-admin gate, the Studio permission matrix editor and Access
Explain panel. Known rough edges are labeled in place (read-only tree
presentation, scattered assignment entry points, self-service reset wiring —
cloud#580).

Rendering verified in the docs portal (Chromium): headings, tables, sidebar
nav entry, and all cross-links/anchors resolve.

Closes #2917

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DPYFwzYSsKjU12xSJtbAyB
@vercel

vercel Bot commented Jul 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
spec Canceled Canceled Jul 14, 2026 4:00pm

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/m labels Jul 14, 2026
…role-word guard)

ADR-0090 D3 reserves the word 'role'; the check:role-word CI guard flagged
three new uses. Step 3 is now 'Assign positions' (heading, flow list, and
quick-paths anchor updated to match).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DPYFwzYSsKjU12xSJtbAyB
@os-zhuang os-zhuang added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Jul 14, 2026 — with Claude
@os-zhuang
os-zhuang marked this pull request as ready for review July 14, 2026 16:19
@os-zhuang
os-zhuang merged commit 4f3b8fa into main Jul 14, 2026
17 of 18 checks passed
@os-zhuang
os-zhuang deleted the claude/admin-operations-manual-cdlbke branch July 14, 2026 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/m skip-changeset PR has no user-facing published change; bypasses the changeset gate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(permissions): 系统管理员操作手册(面向客户管理员的 onboard 任务手册)

2 participants