mirror of
https://github.com/hanzoai/team.git
synced 2026-09-30 01:57:35 +00:00
452aa893e0
* docs(sidebar): regroup Administration Guide Onboard and Scale sections
Onboard (34 files) and Scale (28 files) were still flat, unrouped lists
unlike their already-regrouped Configure/Manage/Integrations siblings.
Apply the same manual-grouping-override pattern:
- Onboard: SAML SSO, Other SSO & Identity (OAuth/OIDC/AD-LDAP),
Multi-Factor & Certificate Auth, Guest Accounts & Delegated
Administration, User Provisioning & Bulk Data, Migrating to Mattermost.
- Scale: Capacity Planning (scale-to-N-users pages + storage sizing),
High Availability & Architecture, Search Infrastructure, Observability
& Monitoring, Caching — with Scaling for Enterprise kept as a standalone
landing page since it's a general entry point, not a group member.
Extends the existing orphan-check warning logic in buildAdminGuideSidebar
to also cover Onboard/Scale, so future filesystem drift surfaces the same
way it already does for Configure/Manage. Files stay flat on disk, no
URLs move.
* docs(sidebar): align Onboard/Scale subgroups with Sphinx's live nav
Sphinx's actual toctree groups these files differently than the initial
regroup guessed: SAML/OAuth/OIDC/AD-LDAP all live under one identity
bucket (not split SAML vs "other"), guest/permissions pages sit under a
plain "User management" label, and — most notably — 21 of Scale's 28
files (capacity planning, HA/architecture, search infra, caching) are
navigated to from Deployment Guide -> Reference Architecture in Sphinx,
not Administration Guide, even though their Sphinx URLs stay under
/administration-guide/scale/.
- Merge Onboard's samlSso/otherSso groups into one "SSO & Identity"
group, with SAML nested as its own sub-category inside it.
- Rename "Guest Accounts & Delegated Administration" to "User
Management".
- Physically move the 21 Scale files that Sphinx navigates to from
Deployment Guide into deployment-guide/reference-architecture/scale/,
and add a new `scaling` group to DEPLOYMENT_GROUPS mirroring that
split. Administration Guide -> Scale keeps only the 7
monitoring/observability pages.
- Rewrite the ~130 internal .mdx links that pointed at the old
/administration-guide/scale/* paths for the moved files, and update
the 31 matching Sphinx->Docusaurus redirect targets in
active-redirects.json.
Regenerated the sidebar with zero orphan warnings; all files accounted
for exactly once.
* docs(sidebar): flatten Scale's remaining Observability & Monitoring group
With the 21 architecture/capacity/search files moved to Deployment Guide,
Scale is down to 7 monitoring pages under one theme — wrapping them in
their own "Observability & Monitoring" sub-category just adds a redundant
nesting level (Scale > Observability & Monitoring > 7 files). List them
flat directly under Scale instead.
* docs(sidebar): move Calls docs to deployment-guide, dissolve Storage & Database group
Calls (RTCD, offloader, Kubernetes, logging, metrics) is a deployment/
operations concern, not settings-reference material — physically move the
6 Calls docs from administration-guide/configure/ into a new
deployment-guide/calls/ directory and add a matching `calls` group to
DEPLOYMENT_GROUPS, slotted right after Server/Scaling. Rewrite every
cross-reference across docs/ (including the two PDF book manifests) to the
new /deployment-guide/calls/calls-* paths, and add/update the matching
active-redirects.json entries so old URLs keep resolving.
Also dissolve the "Storage & Database" group in Configure — its three
pages (configuration-in-your-database, environment-variables,
azure-blob-storage) become plain top-level entries instead of a
single-purpose subgroup; no files move since their URLs are unchanged.
* docs(calls,scale): fix RST-migration artifacts and stale links flagged in review
Fixes still-valid review findings on the Calls/Scale content moved in this
branch:
- calls-metrics-monitoring.mdx: unescape HTML-entity braces in inline RTCD
metric names ({/} -> {}), which is unnecessary in fenced/inline
code and rendered literally; convert two legacy docs.mattermost.com
absolute links to root-relative internal links, pointing the
Prometheus/Grafana link at its current post-move location under
deployment-guide/reference-architecture/scale/ rather than the stale
administration-guide/scale/ path.
- calls-rtcd-setup.mdx: convert the ICE Host Override link to a
root-relative path; convert two leftover Sphinx ```{note}``` fences to
the <Note> component (one of these was rendering as barely-readable
plain text due to being an unrecognized code-fence language, not a
proper admonition); add a <Warning> ahead of the community-maintained
installation scripts link.
- elasticsearch-setup.mdx: remove a stray leftover ":start-after:
:nosearch:" Sphinx directive rendering as literal page text.
- opensearch-setup.mdx: remove blockquote (`>`) prefixes wrapping every
numbered-step code fence (another RST-migration artifact), convert a
raw <div class="note"> to <Note>, and unescape HTML-entity braces/angle
brackets in the YAML/JSON/Terraform examples.
- deploy-rhel.mdx: fix the "RTCD setup and configuration" link to point
at calls-rtcd-setup instead of the general calls-deployment-guide page.
- pdf/books/deployment-guide.json: add the two Calls pages missing from
the PDF spine (calls-metrics-monitoring, calls-rtcd-setup).
Skipped: the raw entity-escaped `{}` in calls-rtcd-setup.mdx's <style>
block is intentional (real JSX context, not a code fence/span) and the
"code comment colors nearly invisible" screenshot turned out to be the
same {note}-fence bug above, not a separate Prism/CSS issue -- fixed by
the <Note> conversion. Two more Sphinx ```{note}``` fences exist in
administration-guide/onboard/sso-saml-keycloak.mdx and
sso-saml-adfs-msws2016.mdx but weren't part of the flagged findings, so
left untouched.
---------
Co-authored-by: Hanzo Dev <[email protected]>
Mattermost is an open core, self-hosted collaboration platform that offers chat, workflow automation, voice calling, screen sharing, and AI integration. This repo is the primary source for core development on the Mattermost platform; it's written in Go and React, runs as a single Linux binary, and relies on PostgreSQL. A new compiled version is released under an MIT license every month on the 16th.
Deploy Mattermost on-premises, or try it for free in the cloud.
Learn more about the following use cases with Mattermost:
Other useful resources:
- Download and Install Mattermost - Install, setup, and configure your own Mattermost instance.
- Product documentation - Learn how to run a Mattermost instance and take advantage of all the features.
- Developer documentation - Contribute code to Mattermost or build an integration via APIs, Webhooks, slash commands, Apps, and plugins.
Table of contents
- Install Mattermost
- Native mobile and desktop apps
- Get security bulletins
- Get involved
- Learn more
- License
- Get the latest news
- Contributing
Install Mattermost
- Download and Install Mattermost Self-Hosted - Deploy a Mattermost Self-hosted instance in minutes via Docker, Ubuntu, or tar.
- Get started in the cloud to try Mattermost today.
- Developer machine setup - Follow this guide if you want to write code for Mattermost.
Other install guides:
- Deploy Mattermost on Docker
- Mattermost Omnibus
- Install Mattermost from Tar
- Ubuntu 20.04 LTS
- Kubernetes
- Helm
- Debian Buster
- RHEL 8
- More server install guides
Native mobile and desktop apps
In addition to the web interface, you can also download Mattermost clients for Android, iOS, Windows PC, macOS, and Linux.
Get security bulletins
Receive notifications of critical security updates. The sophistication of online attackers is perpetually increasing. If you're deploying Mattermost it's highly recommended you subscribe to the Mattermost Security Bulletin mailing list for updates on critical security releases.
Get involved
- Contribute to Mattermost
- Find "Help Wanted" projects
- Join Developer Discussion on a Mattermost server for contributors
- Get Help With Mattermost
Learn more
- API options - webhooks, slash commands, drivers, and web service
- See who's using Mattermost
- Browse over 700 Mattermost integrations
License
See the LICENSE file for license rights and limitations.
Get the latest news
- X - Follow Mattermost on X, formerly Twitter.
- Blog - Get the latest updates from the Mattermost blog.
- Facebook - Follow Mattermost on Facebook.
- LinkedIn - Follow Mattermost on LinkedIn.
- Email - Subscribe to our newsletter (1 or 2 per month).
- Mattermost - Join the ~contributors channel on the Mattermost Community Server.
- IRC - Join the #matterbridge channel on Freenode (thanks to matterircd).
- YouTube - Subscribe to Mattermost.
Contributing
Please see CONTRIBUTING.md. Join the Mattermost Contributors server to join community discussions about contributions, development, and more.