mirror of
https://github.com/hanzoai/team.git
synced 2026-10-30 14:49: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]>
90 lines
4.9 KiB
Plaintext
90 lines
4.9 KiB
Plaintext
---
|
||
title: "Notifications and updates"
|
||
---
|
||
import Tabs from '@theme/Tabs';
|
||
import TabItem from '@theme/TabItem';
|
||
|
||
<PlanAvailability slug="all-commercial" />
|
||
|
||
There are multiple ways to receive collaborative playbook updates and notifications.
|
||
|
||
## Status updates
|
||
|
||
Status updates ensure that stakeholders remain informed about the playbook run's progress.
|
||
|
||
You can post a status update from the run channel and you can also configure the playbook to send a reminder to post a status update.
|
||
|
||
<Tabs>
|
||
<TabItem value="web-and-desktop" label="Web and Desktop">
|
||
|
||
1. To post a status update, access the **Playbooks** tab in Mattermost. Select the run you want to post the update for. In the run details page, select **Post update**.
|
||
- If this is the first status update and the playbook has a defined template, that template will be pre-populated here.
|
||
- If this is a subsequent status update, the message from the last status update will be pre-populated here.
|
||
2. Optionally set a reminder to prompt for the next status update.
|
||
- If this is the first status update and the playbook has a defined default reminder timer, that timer will be pre-selected here.
|
||
- If this is a subsequent status update, the last reminder timer will be pre-populated here.
|
||
3. Select **Post update** to post your status update.
|
||
|
||
</TabItem>
|
||
<TabItem value="mobile" label="Mobile">
|
||
|
||
From Mattermost v11.1 and mobile v2.34.0, mobile users can post status updates directly from the Mattermost mobile app:
|
||
|
||
1. Open a playbook run from your mobile app.
|
||
2. Select the status update button that appears when viewing the run details.
|
||
3. In the status update modal:
|
||
- If this is your first status update and the playbook has a status update template, the template content will be pre-populated.
|
||
- For subsequent updates, your most recent status update content will be pre-populated.
|
||
- The modal header shows how many people and channels will receive your status update.
|
||
4. Select your reminder timing from the predefined options available in the mobile app.
|
||
5. Select **Post update** to share your status update.
|
||
|
||
<Note>
|
||
|
||
- The status update button is only available to participants in the playbook run and is disabled when the run is finished.
|
||
- Mobile time selector options are limited to predefined choices, unlike the web interface which allows custom date entry.
|
||
|
||
</Note>
|
||
|
||
</TabItem>
|
||
</Tabs>
|
||
|
||
|
||
When the playbook has a defined broadcast channel, status updates are copied to the broadcast channel as a message from the Playbooks bot. Status updates broadcast to another channel won’t be updated or removed if the original post is edited or deleted.
|
||
|
||
The most recent status post alsos displays in the right-hand sidebar of the run channel and in the timeline. To correct or remove a status post, edit or delete the post as needed.
|
||
|
||
## Request an update
|
||
|
||
To request a status update, access the **Playbooks** tab in Mattermost. Select the run you want an update for. In the run details page, select the <img src="/img/ui/dots-vertical_F01D9.svg" alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> menu next to **Post update** and select **Request update**.
|
||
|
||
<Note>
|
||
|
||
Requesting updates is only available in the web browser and desktop app. This functionality is not available on mobile.
|
||
|
||
</Note>
|
||
|
||
## Follow runs and playbooks
|
||
|
||
Follow specific playbooks to receive updates on important events such as when a run is started and finished, as well as status and retrospective updates every time that playbook is run. This is a good option if you're interested in all instances of a specific workflow, such as an outage resolution playbook.
|
||
|
||
You can also choose to follow a specific run without actively participating. You’ll receive updates for that run only and can take action if needed. This is useful when you’re only interested in a single instance of a procedure—for example, following onboarding for one specific customer rather than every onboarding run.
|
||
|
||
<Note>
|
||
|
||
Following playbooks and runs is only available in the web browser and desktop app. This functionality is not available on mobile.
|
||
|
||
</Note>
|
||
|
||
## Daily digest
|
||
|
||
To help you keep track of your runs, tasks, and statuses, a daily digest is sent via direct message in Mattermost.
|
||
|
||
Running playbooks in multiple channels can be overwhelming. The daily digest is sent once a day, in the morning. It lists the actionable items for each run, as well as any outstanding tasks or status updates required. Select the run name to move to that channel.
|
||
|
||
The digest is on by default. To turn it off, use the slash command `/playbook settings digest off`.
|
||
|
||
## Playbook to do
|
||
|
||
As you complete tasks and finish runs, you can update the details in the digest using the slash command `/playbook todo`. This slash command can be run in any channel, direct message, or group message. Once run, it delivers an updated digest which includes a list of active runs you belong to.
|