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]>
133 lines
7.2 KiB
Plaintext
133 lines
7.2 KiB
Plaintext
---
|
|
title: "Deployment Solution Programs"
|
|
---
|
|
Mattermost's **Deployment Solutions Programs** help IT administrators understand how Mattermost is being offered in third-party deployment solutions, including other open source projects as well as in commercial solutions.
|
|
|
|
This is an optional program for third-party developers to increase awareness about their work and to enable Mattermost to refer its communities to different solutions.
|
|
|
|
Individuals or companies interested in exploring deployment solutions with Mattermost are encouraged to reach out to us via the [Mattermost Partner Program Form](https://support.mattermost.com/hc/en-us/requests/new?ticket_form_id=24278352368532).
|
|
|
|
Deployment solutions are recognized by Mattermost at three-levels:
|
|
|
|
- **Community Deployment Solutions** - Basic orchestration solutions for Mattermost, typically from the open source community or hosting companies who let us know about their work. The work of partners is included in blog posts and on social media as a benefit to the user and customer communities.
|
|
|
|
> Examples:
|
|
>
|
|
> - [Puppet deployment solution for Mattermost](https://forge.puppet.com/liger1978/mattermost) by Richard Grainger
|
|
> - [Heroku deployment solution for Mattermost](https://chrisdecairos.ca/deploying-mattermost-to-heroku/) by Christopher De Cairos
|
|
|
|
- **Registered Deployment Solutions** - Orchestration solutions that follow detailed Mattermost guidelines on keeping up-to-date with the latest Mattermost version and security updates (typically a one-line change), linking to official documentation, supporting branding guidelines, and maintaining a changelog. This level of engagement allows Mattermost to more prominently promote the work, knowing that it's committed to meeting explicit standards.
|
|
|
|
- **Certified Deployment Solutions** - These solutions meet all the requirements of Registered Deployment Solutions, with the addition that they'll automate the version upgrade and security update processes (typically a one-line change). There is the added benefit that when Mattermost announces new versions and security updates, we can also announce the availability of updates to Certified Deployment Solutions.
|
|
|
|
To summarize the commitment level of different solutions:
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Deployment Solution Requirement</th>
|
|
<th>Community</th>
|
|
<th>Registered</th>
|
|
<th>Certified</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a href="#installation">Installation</a></td>
|
|
<td>`checkmark <mm</td>
|
|
<td>-subst:checkmar</td>
|
|
<td>k>`__ <a href="mm-subst:checkmark">checkmark</a> <a href="mm-subst:checkmark">checkmark</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><hr /></td>
|
|
<td><hr /></td>
|
|
<td><hr /></td>
|
|
<td><hr /></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="#documentation">Minimum Documentation</a></td>
|
|
<td>`checkmark <mm</td>
|
|
<td>-subst:checkmar</td>
|
|
<td>k>`__ <a href="mm-subst:checkmark">checkmark</a> <a href="mm-subst:checkmark">checkmark</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><hr /></td>
|
|
<td><hr /></td>
|
|
<td><hr /></td>
|
|
<td><hr /></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="#security-updates">Security Updates</a></td>
|
|
<td></td>
|
|
<td>`checkmark <mm-</td>
|
|
<td>subst:checkmark>`__ <a href="mm-subst:checkmark">checkmark</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><hr /></td>
|
|
<td><hr /></td>
|
|
<td><hr /></td>
|
|
<td><hr /></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="#branding">Branding</a></td>
|
|
<td></td>
|
|
<td>`checkmark <mm-</td>
|
|
<td>subst:checkmark>`__ <a href="mm-subst:checkmark">checkmark</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><hr /></td>
|
|
<td><hr /></td>
|
|
<td><hr /></td>
|
|
<td><hr /></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="#upgrade">Upgrade</a></td>
|
|
<td></td>
|
|
<td></td>
|
|
<td><a href="mm-subst:checkmark">checkmark</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
Requirement details are outlined below.
|
|
|
|
## Deployment solution program requirements
|
|
|
|
### Installation
|
|
|
|
1. **Installation is designed for officially supported operating systems and platforms**. EXCEPTION: RHEL equivalents (CentOS, Amazon Linux, Oracle Linux, Scientific Linux) are acceptable as long as the exception is noted in README or equivalent with `This deployment uses [OPERATING_SYSTEM] as an equivalent to the officially supported version of Red Hat Enterprise Linux.`
|
|
2. **Automated installation passes basic testing**. After installation run the following manual tests:
|
|
|
|
> 1. Create a new user account and use that account to create a new team and post to Town Square channel.
|
|
> 2. Create a second user account and join the newly created team and reply to first user's post in Town Square.
|
|
> 3. Go back to first user account and post reply with an image attached.
|
|
> 4. Confirm there are no errors and no red alert bar at the top of the screen with "Mattermost unreachable error" (which would indicate a websocket configuration error).
|
|
|
|
### Documentation
|
|
|
|
1. **Include link to official Mattermost documentation**. README or equivalent contains statement **Please see https://docs.mattermost.com for official documentation.**
|
|
|
|
> Include the following information in text, markdown, HTML or other format. Square brackets `[]` indicate optional statements depending on the configuration of your solution:
|
|
>
|
|
> > This deployment solution installs \[and upgrades\] a Mattermost server to provide secure, private cloud messaging for teams and enterprises. More information is available at: [https://mattermost.com](https://mattermost.com)
|
|
> >
|
|
> > Following automated deployment, the following steps are required to make your system production-ready:
|
|
> >
|
|
> > - [Configure SSL for Mattermost](/deployment-guide/server/setup-nginx-proxy#configure-nginx-with-ssl-and-http2)
|
|
> > - [Configure SMTP email for Mattermost](/administration-guide/configure/smtp-email)
|
|
|
|
2. **Unofficial deployment options should be documented**. Unofficial deployment configurations, such as use of Linux operating systems that are not officially supported, should be documented in the README.
|
|
|
|
### Security updates
|
|
|
|
1. **Document commitment to providing security updates.** README or equivalent states `We highly recommend users subscribe to the Mattermost security updates email list. When notified of a security update, the maintainers of this deployment solution will make an effort to update to the secure version within 10 days.`
|
|
2. **Commit to making an effort for your deployment to provide the latest security update within 10 days of announcement**. This is typically a one-line change.
|
|
|
|
### Branding
|
|
|
|
**Support Mattermost branding and naming guidelines**. To ensure naming is clear across deployment solutions, README or equivalent should contain `` The name for this deployment solution in the context of `Mattermost branding guidelines [https://handbook.mattermost.com/operations/operations/publishing/publishing-guidelines/brand-and-visual-design-guidelines](https://handbook.mattermost.com/operations/operations/publishing/publishing-guidelines/brand-and-visual-design-guidelines)`_ is `[NAME] for Mattermost by [CREATOR]`. `` For example, `Multi-node Docker deployment solution for Mattermost by John Doe`. This is the name that will be used to refer to your work in Mattermost community materials.
|
|
|
|
### Upgrade
|
|
|
|
**Support upgrade of Mattermost**. Enable user interface or command line upgrade of a Mattermost deployment to latest version based on [upgrade procedure when Mattermost is embedded](https://developers.mattermost.com/integrate/faq/#how-should-i-automate-the-install-and-upgrade-of-mattermost-when-included-in-another-application).
|