Mattermost Handbook
Need help?How to spend company moneyHow to update the HandbookRelease overview
0.2.1
0.2.1
  • Mattermost Handbook
  • Company
    • About Mattermost
      • List of terms
      • Business model
      • Mindsets
    • "How to" guides for staff
      • How to set up a 1-1 channel
      • How to update the handbook
      • How to manage Handbook notifications
      • How to change mobile device
        • How to handle a lost mobile device
      • How to do a mini-retrospective
      • How to autolink keywords in Mattermost
  • Operations
    • Company operations
      • Areas of Responsibility
      • Mattermost Leadership Team (MLT)
        • MLT cadence
      • Company measures
        • Metrics definitions
        • FY23 goals board
        • MLT metrics
      • Company cadence
      • Company policies
        • Community response policy
        • Security policy
      • Company processes
        • Issue/solution process
        • Company agreements
        • Publishing
          • Public web properties
          • Publishing guidelines
            • Brand and visual design guidelines
            • Voice, tone, and writing style guidelines
              • Contribute to documentation
            • Confidentiality guidelines
          • Post-publication quality control process
      • Handbook processes and policies
        • Handbook onboarding
      • Fiscal year planning
    • Research and Development
      • Organization
        • Tech Writing
        • Data engineering
        • Delivery
        • Cloud Platform
        • Site Reliability Engineering
        • GRC
        • Product Security
        • Security Operations
      • Processes
        • Feature Labels
      • Product
        • Product planning
          • Product philosophy and principles
          • Prioritization process
          • Release planning process
          • Roadmap views
          • Release plan
          • Launch plan
          • Feature requests
        • Development process
          • Mobile feature guidelines
          • Deprecation policy
          • Mattermost software requirements process
          • Jira ticket lifecycle
          • Creating new Jira bug tickets
            • Priority levels for tickets
            • Jira fix versions
        • Release process
          • Release overview
          • Feature release process
          • Dot release process
          • Security release process
          • Mobile app release process
          • Desktop app release process
          • Release tips
          • Release scorecard definitions
        • How-to guides for Product
          • How to use productboard
          • How to record a roadmap video
          • How to update integrations directory
          • How to write a feature release announcement
        • Product Management team handbook
          • Product Management Areas of Ownership
          • Product Manager onboarding
          • Product Manager levels
          • Professional development
        • Product Design team handbook
          • Product Design levels
        • Technical Writing team handbook
          • Work with us
          • User interface text guidelines
          • Documentation style guide
          • Our terminology
          • Guidelines for PMs and developers
          • Guidelines for community contributions
          • Technical Writer levels
          • Docathon 2021
            • Getting started with contributing
        • Growth
          • A/B testing methodology
          • PQL definition
        • Analytics
          • Product Analyst Engineer levels
          • Looker
            • Dashboards
            • Explores
          • Telemetry
        • Developer relations
        • Product team hangouts
      • Engineering
        • Infrastructure engineering
          • Cloud infrastructure cost KPIs
          • Cloud data export process
          • Cloud churn process
          • Reliability Manifesto
          • Production Readiness Review
          • Infrastructure Library
        • Integrations team processes
        • Plugin release process
        • Data Engineering
        • Sustained Engineering
          • On call
        • How to go to a conference
        • Public speaking
        • Core contributor expanded access policy
      • Quality Assurance
        • QA workflow
        • QA testing tips and tools
        • Rainforest process
    • Messaging and Math
      • How-to guides for M&M
        • How to create release announcements
        • How to create screenshots and GIFs
        • How to write Mattermost case studies
        • How to write guest blog posts for Mattermost apps and services
        • How to write Mattermost recipes
        • How to compose tweets
        • How to create a split test for web page
        • How to run meetups
        • How to run executive dinners
      • Checklists for M&M
        • Blog post checklist
        • Bio checklist
      • Mattermost websites
      • Demand generation reporting
      • M&M Asana guidelines
      • Content marketing
        • How to use the editorial calendar
        • Content development and distribution
        • Video content guidelines
        • How to contribute content
    • Sales
      • Deal Desk
      • Partner programs
      • Lead management
    • Deployment Engineering
      • Overview
      • Workflows
      • Frequently Asked Questions
      • Playbook for MME Sev 1 Outages
      • Status Update Template
    • Program Management
    • Customer Success
      • Customer Support
    • Legal
      • Contracts
      • Ironclad Basics
        • Company-Wide Workflows
        • Sales Contracts and Workflows
        • Signing a Contract and Contract Repository
    • Finance
      • Budget
      • How to use Airbase
        • Access Airbase
        • Navigate Airbase
        • How to submit a purchase request
        • How to submit a reimbursement request
        • How to review a reimbursement request
        • Vendor portal guide
        • Frequently asked questions
      • Onboarding
        • Vendor onboarding
        • ROW staff onboarding
      • Staff member expenses
        • How to spend company money
        • How to spend company money: Internships
        • Corporate credit card policy
        • How to access Airbase
        • Gifting policy
        • How to book airfare and travel
        • How to reimburse the company
        • How to convert currencies
        • How to get paid
      • Arrange a Bounty Program
      • Naming files and agreements
      • Risk management
        • Mattermost U.S. consulting agreements
      • Operations playbook
    • Security
      • Policies
      • Privacy
        • Data deletion requests
        • Data subject access requests
      • Product Security
        • Product Vulnerability Process
        • Working on security-sensitive pull requests
        • Secure Software Development guide
      • Security Operations
        • User guides
    • Workplace
      • PeopleOps
        • HR cadences
        • HR systems
        • HR Processes
        • Working at Mattermost
          • Onboarding
            • Things everyone must know
            • Staff onboarding
            • Engineer onboarding timeline and expectations
            • Manager onboarding
            • Frequently asked questions
          • Learning and development
          • Mattermost communication best practices
          • Paid time off
            • Out of office email example
          • Travel
            • Business travel insurance
          • Leaves of absence
            • Pregnancy leave
            • Baby bonding parental leave
            • Jury duty
          • Workplace program
          • Relocation
          • Total rewards
        • Performance reviews
          • Formal review process
          • New staff performance review
          • Informal review process
        • Transfers and promotions
        • Offboarding instructions for managers
        • People compliance
      • People policies
      • Groups
        • Staff Resource Groups
      • Approvals and iteration
      • IT
        • IT helpdesk
        • Hardware and software purchases
        • Hardware buy back policy
        • Software systems
  • Contributors
    • Contributors
      • Equity, diversity, and inclusion
      • How to contribute to Mattermost
        • Community Content program
        • Documentation contributions
        • Help Wanted tickets
        • Localization
        • Contribution events
      • Mattermost community
      • Contributor kindness
      • Community systems
      • Guidelines and playbooks
        • Social engagement guidelines
        • Contribution guidelines and code of conduct
        • Mattermost Community playbook
        • How to run a Hackathon
        • Hacktoberfest event organizer guide for Mattermost
    • MatterCon
      • Staff information privacy management
      • Mattermost events code of conduct
      • MatterCon2021
    • Join us
      • Ice-breakers
      • Help Wanted tickets
      • Localization
      • Mattermost GitHub sponsorship
      • Things candidates should know
      • Staff recruiting
      • Recruiting cadences
        • Product Manager hiring process
      • Exec recruiting
        • EA logistics
  • Help and support
    • Contact us
Powered by GitBook
On this page

Was this helpful?

Edit on Git
Export as PDF
  1. Contributors
  2. Contributors
  3. How to contribute to Mattermost

Documentation contributions

PreviousCommunity Content programNextHelp Wanted tickets

Last updated 3 years ago

Was this helpful?

Thanks for looking into ways to contribute to Mattermost! Updating existing information is a great way to get started contributing, and the writing team is here to help. The hardest part is where to start.

For the documentation available at , we recommend starting anywhere where you've found content in the documentation that's inaccurate, outdated, or could benefit from more detail or context.

If you're reading a page of the documentation and thinking to yourself "that's not how that works!" or "I wish there was more detail on this page", that's a perfect place to begin! Simply select Edit located in the top right corner of any docs page to open the source file in GitHub directly.

Note: There's a different process to follow for the API documentation, so if you're interested in contributing to the content available at , please let us know!

Some additional ideas on where to start contributing to Mattermost product docs:

  1. If you've started using specific Mattermost features, one way you can contribute is to review the docs on a given feature. Are the docs complete? Is anything missing? Would a screenshot or an animated GIF help others learn this feature faster?

  2. If you've been learning how to install, configure, or integrate with Mattermost -- your experience with installing Mattermost is hugely valuable, especially when it comes to the install documentation. There are many installation topics that could benefit from a review and update.

  3. If you found it challenging to find specific information from the homepage, through the left-hand sidebar, or by searching, that's also excellent feedback for the internal writing team. If you're having trouble finding something, others will too. Together, we can figure out how make that content easier to find.

  4. And one final idea: In GitHub, you'll see a number of Docs issues you can contribute to here: . Any issue marked as Help Wanted and/or Up For Grabs is something the writing team would love to incorporate into the product docs. If there's something in that list that appeals to you, please let me know, and we can discuss the request in more detail together.

Working with us

We really appreciate the time taken by contributors to help us, and want to help every contributor submit meaningful content that adds value to our documentation. We refer to these types of contributions as valid contributions.

A valid contribution is one that isn't done just for the sake of submitting a PR, but one that:

  • Fixes an error (anything from a typo to a grammatical error to incorrect instructions).

  • Improves existing content by adding context or use cases.

  • Proposes improvements to processes, tech stacks, and workflows.

  • Solves a known problem.

  • Fills an existing gap.

  • Offers a fresh perspective.

  • Clarifies, expands, supplements, illustrates, corrects, or updates existing content with imagery, examples, or recommendations based on real-world experience.

  • Includes new screenshots, diagrams, workflows

  • Addresses an issue or request in the docs repo.

All that said, we don't expect greatness from every contribution! One of the best and easiest ways to get started is with copy-editing. It's extremely helpful, and will provide a stepping stone to get used to our processes.

We also really value ideas that we've never thought of. So, if you're contributing to our documentation with your own ideas (i.e., not based on existing GitHub issues) that's great! Please clearly describe the problem space you're addressing in your PR. This context is important and helps us evaluate incoming PRs effectively.

We're a small but mighty team, and we really look forward to engaging with you. Come join us in the and start a conversation.

https://docs.mattermost.com/
https://api.mattermost.com/
https://github.com/mattermost/docs/issues
DWG channel