Mattermost documentation
Switch branches/tags
5.0-docs-es Basic-Export Bind-SAML-to-ID-Attribute CLI-Campaign-Docs Edit-Other-Post-Permission LDAP-Group-Sync Restrict-Team-by-Email SAML-AD/LDAP-Override SAML-Button-Default TOS-5.6-Updates Themes-Across-Teams Update-To-Privacy-Measures WebRTC add_doc_mm_gitlab_helm advanced-permissions amyblais-patch-1 amyblais-patch-2 amyblais-patch-3 amyblais-patch-4 amyblais-patch-5 amyblais-patch-6 amyblais-patch-7 amyblais-patch-9 amyblais-patch-11 amyblais-patch-12 amyblais-patch-13 api-naming cff channels checksum commercial-support config-settings deprecation design-process desktop display docs-seperation docs downgrade download-links emoji-bulk-load esethna-5.4 esethna-patch-1 esethna-patch-2 hmhealey-patch http-proxy icloud it33-patch-1 it33-patch-3 it33-patch-6 jasonblais-53-documentation jasonblais-certificate-based-authentication jasonblais-dialogs jasonblais-install-guide-updates jasonblais-install-guides jasonblais-integrations-program jasonblais-interactive-message-menus jasonblais-interactive-messages jasonblais-patch-1 jasonblais-patch-2 jasonblais-patch-3 jasonblais-patch-4 jasonblais-patch-7 jasonblais-patch-8 jasonblais-patch-9 jasonblais-patch-15 jasonblais-patch-17 jasonblais-terms-of-service jasonblais-ubuntu1804 js-api-route js-slack-import js-ulimits js-upgrade-guide js-user-guide js40-teammate-name js310-loadtest js310-turkish-translate lfbrock-patch-1 lfbrock-patch-3 lindy65-patch-1 lindy65-patch-4 lindy65-patch-5 lm-5.5-doc lm-5.5release lm-QA-proce lm-release master md-image-size mfa migration mindsets minimums mm-10555 mm-12505-remove-webrtc-store mm9547 msg-attachment-api name-value new-metrics onboard onboarding paul-recipes-info plan-options pr-customer-thermometer pr-get-desktop-log pr-mobile-push pr-platform-channel-modify pr-typo-fix pr-update-s3-docs public-links push-metadata reseller restrict-team-names revert-1441-jasonblais-patch-10 revert-1693-amyblais-patch-6 sales shoulder-check statistics test-build thread-notifications v3.3-documentation v3.4-documentation v3.5-documentation v3.6-documentation v3.7-documentation v3.8-changelog v3.8-documentation v3.9-documentation v3.10-documentation v4.0-changelog v4.0-documentation v4.2-documentation v4.3-documentation v4.4-documentation v4.6-changelog v4.6-documentation v4.7-documentation v4.8-documentation v4.9-documentation v4.10-documentation v5.0-documentation v5.1-documentation v5.2-documentation v5.3-documentation v5.4-documentation v5.5-documentation v5.6-documentation v5.7-documentation version-checksum webhook wiersgallak-patch-2 yangchen1-patch-3 yangchen1-patch-4 zapier-1 zapier-2 zapier
Nothing to show
Clone or download
amyblais Merge pull request #2435 from comharris/patch-15
Update working-at-mattermost.rst
Latest commit 0a49692 Dec 15, 2018

Mattermost Documentation

This repository generates the documentation available at

All documentation is available under the terms of a Creative Commons License.


To generate the HTML files from markdown in the /source directory:

  1. Download repo onto a machine with Python installed
  2. Install pipenv: pip install pipenv
  3. cd into the cloned repository
  4. Install required packages: pipenv install
  5. Build: make html - generates files in /build directory


How to create Pull Requests to edit or create Mattermost documentation (by community members):

  1. Sign the Contributor License Agreement (see instructions in the next section).
  2. On the Mattermost Documentation page that you want to edit, click the GitHub icon on the upper right corner that says "Edit".
  3. Click "Edit the file in your fork of this project" (pencil icon) on the upper right corner.
  4. After making changes, check the "Propose file change" button.
  5. Compare changes with the original document.
  6. Click "Create a Pull Request". Make sure that the Pull Request has a descriptive title and add comments to briefly tell others what you have worked on (optional).

Signing CLA:

Please read the Mattermost Contributor Agreement and sign it (at the bottom of the page), so you can be added to the Mattermost Approved Contributor List.

Additional process for Core Committers for Doc Repo:

These steps are to be followed only in situations of urgency or in situations where it is necessary to check that there aren't any high confidentiality issues. Otherwise the standard approval process should be followed.

  1. “Needs Editor Review” label should be processed after merge.
  2. IMPORTANT: Person conducting editor review needs to have their suggestions merged by author. Do this by mentioning the user name in the GitHub Pull Request.
  3. Check weekly or bi-weekly that there are no “Needs Editor Review” labels on closed Pull Requests.

Installation issues

If you can't install sphinx on MacOS try sudo pip install sphinx sphinx-autobuild sphinx_rtd_theme --ignore-installed six.