Skip to content

Commit 849738f

Browse files
committed
Editorial review cleanup
1 parent 402aa46 commit 849738f

File tree

7 files changed

+24
-82
lines changed

7 files changed

+24
-82
lines changed

source/end-user-guide/workflow-automation.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Workflow Automation
44
.. include:: ../_static/badges/all-commercial.rst
55
:start-after: :nosearch:
66

7-
Mattermost Playbooks provides structure, monitoring and automation for repeatable, team-based processes integrated with the Mattermost platform. Playbooks are :doc:`configurable checklists </end-user-guide/workflow-automation/work-with-tasks>` for teams to achieve :doc:`specific and predictable outcomes </end-user-guide/workflow-automation/metrics-and-goals>`, such as incident response, software release management, and logistical operations. From Mattermost v2.6.0, checklists can be created and managed directly in channels as first-class workflows, accessible through the right-hand sidebar (RHS).
7+
Mattermost Playbooks provides structure, monitoring and automation for repeatable, team-based processes integrated with the Mattermost platform. Playbooks are :doc:`configurable checklists </end-user-guide/workflow-automation/work-with-tasks>` for teams to achieve :doc:`specific and predictable outcomes </end-user-guide/workflow-automation/metrics-and-goals>`, such as incident response, software release management, and logistical operations.
88

99
From Mattermost v11.1, Entry, Enterprise, and Enterprise Advanced customers can enable adaptive, conditional workflows responding in real time to changing mission or operational context. Admins can define attributes such as severity, category, or linked ticket ID, and use those attributes to hide or show tasks depending on the values of these attributes which can be seen and modified during a playbook run. Learn more about :ref:`playbook attributes <end-user-guide/workflow-automation/work-with-playbooks:playbook attributes>` and :ref:`conditional playbook tasks <end-user-guide/workflow-automation/work-with-tasks:conditional tasks>`.
1010

@@ -54,8 +54,6 @@ Access
5454

5555
From Mattermost v10.11 and mobile app v2.31.0, mobile users can access playbooks from the mobile app in read-only mode. :ref:`Playbooks slash commands <end-user-guide/workflow-automation/interact-with-playbooks:slash commands>` are supported in the mobile app, but actions like starting runs or updating checklists aren't available through the mobile interface.
5656

57-
From Mattermost mobile v2.35.0, the mobile interface has been updated to display "Playbook checklists" terminology consistently across the mobile app experience.
58-
5957
Usage
6058
-----
6159

source/end-user-guide/workflow-automation/learn-about-playbooks.rst

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,14 @@ Learn about collaborative playbooks
66

77
A collaborative playbook is a repeatable process that is measured and refined over time. For example, the steps you follow when dealing with an outage, a software release, or welcoming a new member of your team can all be made into a playbook.
88

9-
.. tip::
10-
11-
Looking to optimize team productivity? Learn how to automate repeatable workflows with `this on-demand webinar <https://mattermost.com/webinar/4-strategies-to-improve-technical-teams-productivity/>`_, then download our `Mattermost Playbooks datasheet <https://mattermost.com/mattermost-playbooks-datasheet/>`_.
12-
13-
14-
Using collaborative playbooks, development teams can orchestrate prescribed workflows and define, streamline, and document complex, recurring operations.
9+
Using collaborative playbooks, teams can orchestrate prescribed workflows and define, streamline, and document complex, recurring operations.
1510

1611
Each playbook represents a recurring outcome or specific goal that your teams collaborate on to achieve, such as service outage recovery or customer onboarding. Collaborative playbooks are made up of:
1712

18-
- :ref:`Checklists <end-user-guide/workflow-automation/work-with-playbooks:make checklists>`: The list of tasks to be completed for the run. Can be edited ad-hoc during a run. From Mattermost v2.6.0, checklists can also be created and managed directly within channels as first-class workflows.
13+
- :ref:`Checklists <end-user-guide/workflow-automation/work-with-playbooks:make checklists>`: The list of tasks to be completed for the run. Can be edited during a run. From Playbooks v2.6.0, checklists can also be created and managed directly within public and private channels.
1914
- :ref:`Templates <end-user-guide/workflow-automation/work-with-playbooks:templates>`: Used for frequently-used actions such as updates and reminders. You can create your own templates or use default ones.
2015
- :ref:`Automation actions <end-user-guide/workflow-automation/work-with-tasks:task actions>`: Used for inviting members, creating webhooks, editing welcome messages, and more.
21-
- :doc:`Permissions</end-user-guide/workflow-automation/share-and-collaborate>`: Manage permissions at the channel and at the playbook level.
16+
- :doc:`Permissions </end-user-guide/workflow-automation/share-and-collaborate>`: Manage permissions at the channel and at the playbook level.
2217

2318
Teams run a playbook every time they want to orchestrate people, tools, and data to achieve that outcome as quickly as possible while providing visibility to stakeholders.
2419

@@ -63,3 +58,7 @@ Retrospective
6358
-------------
6459

6560
When an incident is over, create a retrospective that captures the impact of the event. You can also add metrics, such as how long it took to resolve the incident, which you can apply to other, similar incidents to see where you can improve and refine your workflows.
61+
62+
.. tip::
63+
64+
Looking to optimize team productivity? Learn how to automate repeatable workflows with `this on-demand webinar <https://mattermost.com/webinar/4-strategies-to-improve-technical-teams-productivity/>`_, then download our `Mattermost Playbooks datasheet <https://mattermost.com/mattermost-playbooks-datasheet/>`_.

source/end-user-guide/workflow-automation/share-and-collaborate.rst

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,17 @@ For more information about System and Team Override Schemes, refer to the :doc:`
1919

2020
In the context of collaborative playbooks, members are assigned a role and based on the selected permissions, this determines how they interact with playbooks. A member can be a member of one playbook, and an admin of another. This allows for granular permissions across teams and departments. For example, setting playbook visibility so only certain teams can view it, or setting permissions to allow an organization to view a playbook but only designated team members can make edits.
2121

22-
Permissions are applied only to playbooks - there are no permissions that are specific to runs.
22+
Permissions are applied only to playbooks. There are no permissions that are specific to runs.
2323

2424
.. important::
2525

26-
From Mattermost v2.6.0, access control for channel checklists has changed to use channel-based permissions rather than playbook-specific permissions. This means that users with appropriate channel permissions can create, manage, and interact with checklists directly within channels without requiring separate playbook access permissions. This change provides more flexible and intuitive access control aligned with existing channel permission models, and affects operational expectations for administrators managing access to workflow functionality.
26+
From Playbooks v2.6.0, channel checklists use :doc:`channel-based permissions </administration-guide/manage/team-channel-members>` rather than playbook-specific permissions. This means that users with appropriate channel permissions can create, manage, and interact with checklists directly within channels without requiring separate playbook access permissions.
2727

2828
Playbook roles
2929
---------------
3030

31-
**Member**
32-
33-
In the context of collaborative playbooks, members are users of Mattermost who are added to a playbook.
34-
35-
**Playbook Admin**
36-
37-
Playbook Admins are also members, and may have elevated permissions to change playbook and run visibility as well as functional settings. They do not have access to the System Console and their privileges are managed by the system admin. Members need to be promoted to the role from within playbooks. The Playbook Admin role is applied per playbook.
31+
- **Member**: In the context of collaborative playbooks, members are users of Mattermost who are added to a playbook.
32+
- **Playbook Admin**: Playbook Admins are also members, and may have elevated permissions to change playbook and run visibility as well as functional settings. They do not have access to the System Console and their privileges are managed by the system admin. Members need to be promoted to the role from within playbooks. The Playbook Admin role is applied per playbook.
3833

3934
.. note::
4035

source/end-user-guide/workflow-automation/work-with-playbooks.rst

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ Work with collaborative playbooks
66

77
A collaborative playbook is a checklist of the tasks that make up your processes. Collaborative playbooks allow you to take codified knowledge and processes and make them accessible and editable by your organization and team. When you're setting up your playbook, you'll be able to break tasks down, and assign actions to them - such as using a slash command to start a Zoom call. You can also decide whether to use the same channel every time your playbook is run, or a new one.
88

9-
.. tip::
10-
11-
Watch this `on-demand webinar on securing your mission-critical work <https://mattermost.com/webinar/cybersecurity-incident-response/>`_ to learn about the key features and functionality to look for in your incident response tooling.
12-
139
There are other parts of a playbook, such as automation settings, and metrics. Playbook configuration applies both to the execution of the playbook as well as to its management and improvement.
1410

1511
But the very first thing you’ll want to set up is a checklist.
@@ -59,27 +55,13 @@ You can change a playbook’s configuration at any time, but changes will only b
5955
Make checklists
6056
----------------
6157

62-
1. In channels, select **Toggle Playbook List** from the Apps Bar.
63-
2. Select **Blank Playbook**, or use the built-in template.
64-
3. Name your playbook and provide a description.
65-
4. Select the **Checklists** tab.
66-
67-
.. note::
68-
69-
From Mattermost v2.6.0, you can also create and manage checklists directly within channels as first-class workflows accessible through the right-hand sidebar (RHS), without requiring a playbook template. This channel-based checklist functionality provides more flexible workflow management for teams.
70-
71-
You can start with the default checklist and edit it, or you can delete it and select **+ New checklist**.
58+
To create a checklist in a playbook, go to the **Tasks** section. Start from templated tasks or create your own. Select **Add a task** or **Add a section** to build out checklists in the playbook. Drag and drop to reorder tasks and sections as needed. Task descriptions support a limited form of Markdown, including text styling and hyperlinks.
7259

73-
* Within each checklist, select **+ New task** to add tasks that are meant to be completed together.
60+
Playbook tasks consist of text rendered in Markdown (when present). You can't run commands directly from a task in a playbook, but you can trigger :doc:`built-in slash commands </integrations-guide/built-in-slash-commands>` and `custom slash commands <https://developers.mattermost.com/integrate/slash-commands/custom/>`_, or outgoing webhooks, to run as part of the task action by starting the task with ``/``.
7461

75-
* Drag and drop to reorganize checklists and tasks.
76-
* Add task descriptions to give additional context to members of the playbook. Descriptions support a limited form of Markdown, including text styling and hyperlinks.
77-
78-
5. Choose **Save**.
79-
80-
.. note::
62+
.. tip::
8163

82-
Tasks in a playbook consists of text rendered in Markdown (when present). You can't run commands directly from a task in a playbook, but you can trigger :doc:`built-in slash commands </integrations-guide/built-in-slash-commands>` and `custom slash commands <https://developers.mattermost.com/integrate/slash-commands/custom/>`_, or outgoing webhooks, to run as part of the task action by starting the task with ``/``.
64+
From Playbooks v2.6.0, you can create and manage checklists directly within public and private channels without requiring a playbook. Select the **Checklists** option in the right-hand sidebar to create a new checklist or manage existing ones. Access control for these channel checklists is based on :doc:`channel-based permissions </administration-guide/manage/team-channel-members>` rather than :doc:`playbook-specific permissions </end-user-guide/workflow-automation/share-and-collaborate>`.
8365

8466
Multiple runs in a channel
8567
--------------------------
@@ -202,4 +184,8 @@ Webhooks
202184
--------
203185

204186
- For information about the webhook payload for ``run start``, see the `PlaybookRunWebhookPayload <https://github.com/mattermost/mattermost-plugin-playbooks/blob/b4c8058d8660efe35050bc7eb080e3819c7ab09c/server/app/playbook_run_service.go#L176-L185>`_ struct. An example of the JSON payload for a run start `is available <https://gist.github.com/icelander/b68f2bf2b4ffefec93400cb050211cf1>`__.
205-
- For information about the webhook payload for ``status update``, see the `PlaybookRunWebhookPayload <https://github.com/mattermost/mattermost-plugin-playbooks/blob/b4c8058d8660efe35050bc7eb080e3819c7ab09c/server/app/playbook_run_service.go#L176-L185>`_ struct. An example JSON payload for a status update `is available <https://gist.github.com/icelander/2f9938ad68d1e0aa656f97969895d080>`__.
187+
- For information about the webhook payload for ``status update``, see the `PlaybookRunWebhookPayload <https://github.com/mattermost/mattermost-plugin-playbooks/blob/b4c8058d8660efe35050bc7eb080e3819c7ab09c/server/app/playbook_run_service.go#L176-L185>`_ struct. An example JSON payload for a status update `is available <https://gist.github.com/icelander/2f9938ad68d1e0aa656f97969895d080>`__.
188+
189+
.. tip::
190+
191+
Watch this `on-demand webinar on securing your mission-critical work <https://mattermost.com/webinar/cybersecurity-incident-response/>`_ to learn about the key features and functionality to look for in your incident response tooling.

source/end-user-guide/workflow-automation/work-with-runs.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Work with runs
44
.. include:: ../../_static/badges/all-commercial.rst
55
:start-after: :nosearch:
66

7-
A run is the execution of a collaborative playbook. You can start each run in a new channel or you can elect to use the same channel for multiple runs. From Mattermost v2.6.0, you can also create and manage checklists directly within channels as standalone workflows, without requiring a playbook template.
7+
A run is the execution of a collaborative playbook. You can start each run in a new channel or you can elect to use the same channel for multiple runs.
88

99
To access runs, select the product menu in the top-left corner of Mattermost, then select **Playbooks**. In the runs list, you can select a run to view more details, such as the overview and retrospective. This is an easy way to assess all the active runs to which you have access.
1010

@@ -33,8 +33,6 @@ Runs and channel behavior
3333

3434
When you configure your playbook, you can decide whether each run of that playbook starts in a new channel or uses the same channel. You can run multiple playbooks in the same channel, simultaneously. Each playbook in use is listed in the RHS of the run channel.
3535

36-
From Mattermost v2.6.0, runs can exist as channel checklists without being associated with a specific playbook (runs can exist without a playbook_id and are typed as channel checklists). This allows for more flexible workflow management where checklists can be created on-demand within any channel context. Access control for these channel checklists is based on channel-level permissions rather than playbook-specific permissions.
37-
3836
If you decide to run a playbook in a new channel, you can do this when you start the run. In the channel RHS, select **Start run**. Then select how you'd like it to be executed.
3937

4038
.. tip::

source/end-user-guide/workflow-automation/work-with-tasks.rst

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@ Tasks and due dates
99

1010
In some workflows, there are time constraints on tasks and others may have more flexible timeframes. Associating tasks with deliverable dates provides visibility into workloads and helps everyone stay accountable during the run.
1111

12-
.. note::
13-
14-
From Mattermost v2.6.0, as part of the interface updates, some terminology has been updated in the user interface. While the underlying functionality remains the same, you may see "sections" referenced in certain UI contexts where "checklists" were previously used. This rebrand tour messaging "Playbook Runs are now Checklists" provides clarity on the terminology changes and new app bar access point.
15-
1612
To assign a due date to a task, select the **Toggle Run Details** icon to open the **Run Details** screen. Hover over the task you’d like to edit and select the calendar icon to assign a due date. Due dates can be used to sort tasks in the run overview.
1713

1814
When a due date is assigned to a task, and the task is overdue or due today, a reminder is added to the playbook's daily digest along with tasks that don't have an assigned due date. As tasks are completed, they're removed from the daily digest reminders. You can refresh the list of assigned tasks at any time using the ``/playbook todo`` slash command.
@@ -108,8 +104,4 @@ Update tasks
108104
- **Edit task commands**: Update slash commands or instructions associated with tasks.
109105
- **Change run ownership**: Transfer run ownership between team members.
110106

111-
These mobile capabilities provide full task management functionality for teams working with playbooks while on mobile devices, complementing your existing desktop and web browser experiences.
112-
113-
.. note::
114-
115-
From Mattermost mobile v2.35.0, mobile UI labels have been updated to display "Playbook checklists" terminology consistently across checklist actions and interfaces. This terminology update aligns with the server v2.6.0 rebrand where "Playbook Runs" became "Checklists" to better reflect the workflow-centric nature of these features.
107+
These mobile capabilities provide full task management functionality for teams working with playbooks while on mobile devices, complementing your existing desktop and web browser experiences.

source/integrations-guide/restful-api.rst

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -31,30 +31,4 @@ Use the API to programmatically create, archive, or update channels, making it e
3131

3232
Build a script or integration that posts messages or reminders into specific channels on a schedule, such as daily stand-up prompts, release announcements, or security notifications.
3333

34-
Learn more about using the `API and available endpoints <https://developers.mattermost.com/api-documentation/>`_.
35-
36-
Playbooks API Updates
37-
----------------------
38-
39-
From Mattermost server v2.6.0 and mobile v2.35.0, the Playbooks API includes the following changes:
40-
41-
**Playbook Run API Changes:**
42-
43-
- Added **Type** field to playbook runs API endpoints to support channel checklists
44-
- The **playbook_id** field is now optional in the create run flow, allowing runs to exist without being associated with a specific playbook
45-
- Runs can be typed as "channel checklists" for standalone workflow management within channels
46-
47-
**Mobile API Endpoints:**
48-
49-
From mobile v2.35.0, the following API endpoints are used for mobile checklist functionality:
50-
51-
- ``/runs/{id}/checklists/{n}/rename`` - Rename checklist items
52-
- ``/runs/{id}/checklists/{n}/add`` - Add new checklist items
53-
54-
.. note::
55-
56-
These API changes support the new channel-based checklist workflow where checklists can be created and managed directly in channels without requiring a playbook template. The Type field and optional playbook_id provide the flexibility needed for both traditional playbook-based workflows and standalone channel checklists.
57-
58-
.. important::
59-
60-
[NOT PRESENT IN PR — REQUIRES HUMAN JUDGMENT] Some API implementation details may require verification with system administrators or developers familiar with the specific API endpoint documentation, as not all implementation details were explicitly provided in the referenced PRs.
34+
Learn more about using the `API and available endpoints <https://developers.mattermost.com/api-documentation/>`_.

0 commit comments

Comments
 (0)