mirror of
https://github.com/hanzoai/team.git
synced 2026-09-30 01:57:35 +00:00
b5f007d35e
* docs: resolve cross-file anchor mismatches from RST-to-MDX migration
The Sphinx-to-Docusaurus migration converted `:ref:`/`{ref}` links using
naive text-slugification, so anchors that pointed to headings in a
different file (e.g. release-summary tables linking into their
respective changelog pages) were emitted as same-page fragments and
silently resolved to nothing.
Built a label registry from the original Sphinx `.. _label:` / `(label)=`
targets to recover the true source file for each cross-reference, then
rewrote the affected links to point at the correct file + heading
anchor. Fixes 282 broken cross-file anchors, primarily in the mobile/
desktop/server release-summary pages, plus assorted same-page anchor
mismatches caught by re-auditing after the prior admonition/anchor fix.
* docs: manually resolve remaining anchor mismatches after cross-file audit
Hand-verified fixes for anchors that fuzzy-matching alone couldn't
safely resolve (confirmed against actual heading text/context, and in a
few cases against the original RST source, before applying):
- Typos and dropped words carried over from the original Sphinx docs
(e.g. "bot-acocunts", "auto-follow-all-new-channel-threads" ->
"follow-all-new-channel-threads").
- Sphinx auto-generated duplicate-heading IDs (#id1/#id3/#id4) resolved
to their real target headings.
- Numbered-step TOC links in enterprise-roll-out-checklist.mdx that
dropped the leading "N. " used in the actual heading slugs.
- Push-notification docs pointing at the wrong file entirely
(environment-configuration-settings instead of
push-notification-server-configuration-settings).
- SAML "saml-enterprise" label resolved to its true cross-file target
(authentication-configuration-settings#saml-2-0), recovered from the
original RST label definition that the automated registry missed
because it sat after an RST transition marker.
- sso-saml-technical references converted from broken same-page/
malformed-path anchors to correct page links.
* docs: fix SAML 2.0 anchor slug (saml-2-0 -> saml-20)
github-slugger strips periods rather than hyphenating them, so "SAML
2.0" slugifies to saml-20, not saml-2-0 as previously fixed.
* docs: fix broken path links found during docs/main migration cleanup
* docs: convert div.tab blocks to Docusaurus Tabs/TabItem components
* docs: restore missing Kubernetes deployment architecture diagrams
The RST-to-MDX migration never copied over the AWS/Azure/Oracle
architecture diagrams referenced by the deployment-architecture-at-scale
page, leaving broken images in each Tabs/TabItem.
* docs: fix 7 anchor mismatches from the fragment/heading audit
Covers three root causes from the anchor mismatch breakdown:
- Fragment repeated the target page's own title instead of a real
heading, so the link is simplified to point at the bare page.
- Heading exists verbatim but lives on a sibling settings page
(experimental-configuration-settings, push-notification-server-
configuration-settings) rather than environment-configuration-settings.
- A page path was mistakenly pasted into a same-page #fragment instead
of being used as a real cross-page link.
* docs: fix 8 anchor slugs that were close but didn't match the real heading
Repoints links whose fragment was a plausible guess (typo, reworded
heading, or wrong section) at the actual auto-generated slug of the
target heading, confirmed by inspecting each target page directly.
* docs: merge split Tabs blocks so tabs render horizontally
The div.tab conversion script split some sibling tab groups into
separate single-item Tabs blocks whenever a stray blockquote marker
sat between them, causing them to render stacked instead of as one
horizontal tab bar. Merges the MySQL/PostgreSQL and Team/Enterprise
Edition tab groups back into single Tabs blocks.
* docs: remove Azure tab and restore Kubernetes deploy content
The Mattermost Operator, Azure, and Oracle platform tabs on the
Kubernetes deployment guide were split across two separate Tabs
blocks (rendering stacked instead of as one tab bar) and all three
tab bodies were empty because the migration never flattened the
original RST include directives. Removes the unsupported Azure tab
and restores the Mattermost Operator and Oracle content from the
pre-migration RST sources as a single merged Tabs block.
* addresscoderabbitreview
* docs: unify Linux/Kubernetes/Containers deploy pages and fix FIPS/STIG placement
Kubernetes and Containers duplicated full install content across a top-level
page (Tabs) and orphaned sidebar subpages that nothing linked to. Reworked
both to follow the Linux page's pattern: shared content on the landing page,
platform-specific instructions live once in their own subpage.
Also removed configure-fips-at-install-time.mdx, which claimed FIPS is
available for native Linux installs — FIPS/STIG in Mattermost is a container
image property (Chainguard-based build), not available outside Docker/
Kubernetes. Consolidated all FIPS/STIG references onto
containers/fips-stig.mdx and pointed the Mattermost Operator subpage (not
Oracle OKE, which doesn't expose image selection) at it.
* docs: fix review findings — image alt text, Important callout markup, typo
- Replace generic alt="image" on scaling diagrams with descriptive text
identifying cloud provider and user scale.
- Convert raw div.important markup in deploy-containers.mdx to the
repo's <Important> component, matching usage elsewhere in the file.
- Fix "Matermost" typo in manage-your-display-options.mdx.
---------
Co-authored-by: Hanzo Dev <[email protected]>
68 lines
5.8 KiB
Plaintext
68 lines
5.8 KiB
Plaintext
---
|
|
title: "Workflow Automation"
|
|
---
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<PlanAvailability slug="all-commercial" />
|
|
|
|
Mattermost Playbooks provides structure, monitoring and automation for repeatable, team-based processes integrated with the Mattermost platform. Playbooks are [configurable checklists](/end-user-guide/workflow-automation/work-with-tasks) for teams to achieve [specific and predictable outcomes](/end-user-guide/workflow-automation/metrics-and-goals), such as incident response, software release management, and logistical operations.
|
|
|
|
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 [playbook attributes](/end-user-guide/workflow-automation/work-with-playbooks#playbook-attributes) and [conditional playbook tasks](/end-user-guide/workflow-automation/work-with-tasks#conditional-tasks).
|
|
|
|
While Playbooks primarily focus on coordinating people and tasks, they also have integration points. You can trigger a playbook run via an incoming webhook, allowing an external tool to trigger a playbook run. Within a playbook, you can define steps that execute webhooks or call external APIs. Additionally, playbooks can work in conjunction with plugins, keeping the entire workflow visible in Mattermost, and reducing the need to switch between apps during critical processes.
|
|
|
|
Playbooks monitor channels for keywords or user actions to trigger a structured process, which brings up a set of individual or shared tasks, each associated with manual or automated actions. As playbooks are executed, some may have requirements for [broadcasting status updates to stakeholders](/end-user-guide/workflow-automation/notifications-and-updates) at regular intervals, to populate workflow dashboards by conducting [retrospectives](/end-user-guide/workflow-automation/metrics-and-goals#configure-retrospectives-before-a-run) after the core process is complete, or other customer requirements as exit criteria for a [playbook “run”](/end-user-guide/workflow-automation/work-with-runs).
|
|
|
|
[Advanced permissions](/end-user-guide/workflow-automation/share-and-collaborate) are also available to delegate and manage playbook controls in larger organizations.
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
Playbooks comes pre-packaged, installed, and enabled with Mattermost server.
|
|
|
|
## Access
|
|
|
|
<Tabs>
|
|
<TabItem value="web-and-desktop" label="Web and Desktop">
|
|
|
|
Access playbooks using a web browser or the desktop app by selecting the product menu located in the top-left corner of the Mattermost interface and then selecting **Playbooks**.
|
|
|
|
</TabItem>
|
|
<TabItem value="mobile" label="Mobile">
|
|
|
|
From Mattermost v11.0 and mobile app v2.34.0, mobile users can:
|
|
|
|
- **Post status updates directly from mobile**: When you open a playbook run on mobile, a new status update button allows you to post progress updates and share status with your team while on the move or in the field.
|
|
- **Create and manage playbook runs** for operational command at the edge.
|
|
|
|
From Mattermost v11 and mobile app v2.32.0, mobile users can access playbooks from the mobile app to [interact with playbook tasks](/end-user-guide/workflow-automation/work-with-tasks#interact-with-playbook-tasks) and [update tasks](/end-user-guide/workflow-automation/work-with-tasks#update-tasks).
|
|
|
|
From Mattermost v10.11 and mobile app v2.31.0, mobile users can access playbooks from the mobile app in read-only mode. [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.
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
|
|
## Usage
|
|
|
|
Use collaborative playbooks to orchestrate prescribed workflows and define, streamline, and document complex, recurring operations, and help your organization stay in command with integrated communication, collaboration, and status dashboards managing your workflow life cycles.
|
|
|
|
### Try it yourself!
|
|
|
|
Walk through our [Incident Response playbook demonstration](https://mattermost.com/demo/playbooks-incident-response/) to see what you can do with playbooks.
|
|
|
|
## Learn more
|
|
|
|
This end user documentation is for anyone who wants guidance on building repeatable processes in Mattermost.
|
|
|
|
- [Overview](/end-user-guide/workflow-automation/learn-about-playbooks) - Learn what collaborative playbooks are and how they're used.
|
|
- [Work with collaborative playbooks](/end-user-guide/workflow-automation/work-with-playbooks) - Customize a playbook for successful runs.
|
|
- [Work with runs](/end-user-guide/workflow-automation/work-with-runs) - Edit triggers and actions in an active run.
|
|
- [Work with tasks](/end-user-guide/workflow-automation/work-with-tasks) - Work with tasks and the task inbox.
|
|
- [Work with notifications and updates](/end-user-guide/workflow-automation/notifications-and-updates) - Keep track of all your active runs and tasks.
|
|
- [Work with metrics and goals](/end-user-guide/workflow-automation/metrics-and-goals) - Unlock insights about the performance of collaborative workflows across organizations with workflow dashboards.
|
|
- [Share and collaborate](/end-user-guide/workflow-automation/share-and-collaborate) - Reuse and share collaborative playbooks with your organization.
|
|
- [Interact with collaborative playbooks](/end-user-guide/workflow-automation/interact-with-playbooks) - Interact with collaborative playbooks using slash commands and the REST API.
|