Skip to content

Playbooks v2.6: Checklists #8654

@cwarnermm

Description

@cwarnermm

@claude - Let’s update the Mattermost Product Documentation to reflect the End User checklist workflow product experience from Mattermost server v2.6.0 onward captured via mattermost-plugin-playbooks PRs #2126, #2117#2128, #2132#2147, and #2154 (evidence: PR #2126 milestone v2.6.0).

Also update mobile experience from Mattermost mobile v2.35.0 onward captured via mattermost-mobile PR #9234 (evidence: PR #9234 milestone v2.35.0). For PRs without milestones, use [NOT PRESENT IN PR — REQUIRES HUMAN JUDGMENT] if a version is required.

Scope & constraints (include non-editable docs list):

Do NOT modify: changelogs, important upgrade notes, version archive, removed/deprecated features, unsupported legacy releases.

Required doc touchpoints (pages/sections if known; otherwise “identify likely pages”):

Identify likely pages for Playbooks/Checklists user docs, RHS/app bar UI guidance, permissions/access model, and Playbooks API/reference (including mobile client endpoints), plus mobile app UX docs.

Persona-separated tasks:

End User:

Document channel checklists as a first‑class workflow (create/manage in channel, checklist UI in RHS) based on PR #2126 summary.

Update UI terminology changes from “checklist” to “section” and related text updates (evidence: PR #2128 webapp/i18n/en.json, checklist_list.tsx, collapsible_checklist_hover_menu.tsx, rhs_* components).

Add note about the rebrand tour messaging “Playbook Runs are now Checklists” and app bar access point (evidence: PR #2154 webapp/i18n/en.json, checklists_rebrand_tour.tsx).

Update mobile UI labels to “Playbook checklists” and checklist actions where shown (evidence: PR #9234 playbook_runs_option.tsx).

System Admin:

Describe behavior that runs can exist without a playbook_id and are typed as channel checklists, including any operational expectations (evidence: PR #2117 server/api/playbook_runs.go, client/playbook_run.go).

Note DB migration behavior for nullable PlaybookID and RunID metrics support (evidence: PR #2117 server/sqlstore/migrations/...).

Risk Assessor:

Explain the access control change to channel-based permissions for checklists and expected access implications (evidence: PR #2147 PR summary).

System Integrator:

Update API reference to reflect Type in playbook runs and optional playbook_id in create flow (evidence: PR #2117 client/playbook_run.go, server/api/playbook_runs.go).

Add/confirm API endpoints used by mobile for rename checklist and add checklist item (evidence: PR #9234 client/rest.ts, rest.test.ts showing /runs/{id}/checklists/{n}/rename and /runs/{id}/checklists/{n}/add).

Output requirements:

Provide a list of pages/sections to update.

Provide proposed text for each page/section (before/after snippets where possible).

Call out any PR evidence gaps as [NOT PRESENT IN PR — REQUIRES HUMAN JUDGMENT].

Validation & SME:

Confirm permissions model details for channel checklists and any admin-facing settings or rollout guidance not explicit in PRs.

Validate version scoping for PRs without milestones (use [NOT PRESENT IN PR — REQUIRES HUMAN JUDGMENT] if unverified).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions