Mattermost Handbook now exists at https://handbook.mattermost.com/ and is powered by GitBook. This repository has been archived with content from this repository eventually migrated to https://handbook.mattermost.com/.
All documentation is available under the terms of a Creative Commons License.
The handbook is being developed in the following rough structure:
- About Mattermost (
/about) - Mission, vision, values, company, history, cadence, mindsets, metrics, definitions - Contributing (
/contributors) - contributor categories, criteria and levels: open source contributors, staff (employees + commercial contributors), partners (resellers, SIs, tech partners) - Onboarding (
/onboarding) - contributor onboarding by category, with emphasis on staff - Cadences (
/cadence) - High level processes and calendars, framed in MLT cadence for developing strategy, plan, contributors and SOPs - Operations (
/sop) - Resources and Standard Operating Procedures ("SOP") for the company aligned with strategy and plan - Join Us (
/join) - How to begin your journey of contribution and elevation
To generate the HTML files from markdown in the /source directory:
- Download repo onto a machine with Python installed
- Install pipenv:
pip install pipenv cdinto the cloned repository- Install required packages:
pipenv install - Build:
make html- generates files in/builddirectory
How to create Pull Requests to edit or create Mattermost documentation (by community members):
- Sign the Contributor License Agreement (see instructions in the next section).
- On the Mattermost Documentation page that you want to edit, click the GitHub icon on the upper right corner that says "Edit".
- Click "Edit this file" (pencil icon).
- After making changes, check the "Create a new branch for this commit and start a pull request".
- Make sure that the Pull Request has a descriptive title. Add comments to briefly tell others what you have worked on (optional).
- Click "Create a Pull Request".
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.
- “Needs Editor Review” label should be processed after merge.
- IMPORTANT: Person conducting editor review needs to have their suggestions merged by author. Do this by mentioning the pre-release.mattermost.com user name in the GitHub Pull Request.
- Check weekly or bi-weekly that there are no “Needs Editor Review” labels on closed Pull Requests.
If you can't install sphinx on MacOS try sudo pip install sphinx sphinx-autobuild sphinx_rtd_theme --ignore-installed six.
- First, wait for 15 minutes until the build finishes.
- Search for recent commits to see if one of them resulted in a build failure.
- If there is one or more, review the changes to see if you can find a fix for it.
- If you cannot find a fix, reach out to the R&D Infra team in the IST Infra/Sec Team channel and ask for help. Here's the list of current members of the Infra team.
- Identify which section you want to add the new page to, e.g. "About Mattermost".
- Locate the file that manages the left sidebar TOC of that section, e.g.
about/about-mattermost. The locations can be found at https://github.com/mattermost/mattermost-handbook/blob/master/source/index.rst - Add the new page to the TOC.
If you're changing folders and file names make sure to:
- Update the front page (6 tiles): https://github.com/mattermost/mattermost-handbook/blob/master/source/templates/index.html
- Update the left sidebar navigation: https://github.com/mattermost/mattermost-handbook/blob/master/source/index.rst