Files
upstream-mattermost/docs/main/get-help/contribute-to-documentation.mdx
upstream-mirror 240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)
2026-09-16 00:29:55 +05:00

72 lines
5.6 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: "Contribute to this documentation"
---
import useBaseUrl from '@docusaurus/useBaseUrl';
Mattermost has a diverse community that extends well beyond code contributions. If you're interested in contributing to Mattermost, why not help improve the documentation? Be sure to join the documentation community in [DWG: Documentation Working Group](https://community.mattermost.com/core/channels/dwg-documentation-working-group) so we can support and celebrate you!
## How to get started
The fastest way to get started with a documentation contribution is to find something you want to change in the documentation. This might be a typo or broken link, or something more extensive like revising or expanding content. Once you've found a page you want to update, select the edit option <img src={useBaseUrl('/img/ui/edit-on-github.png')} alt="Contribute to Mattermost documentation by selecting the Edit option located in the top right corner of any documentation page." className="theme-icon" /> located in the top right corner of that page.
## First-time contributor?
Start by exploring the [Contribute to Mattermost](https://mattermost.com/contribute/) documentation, specifically the ["You want to help with content"](https://developers.mattermost.com/contribute/why-contribute/#you-want-to-help-with-content) section.
In a GitHub pull request, you can make changes as if you were editing code. If you're new to contributing to documentation using pull requests in GitHub, the following [video](https://www.youtube.com/watch?v=V8ROl9wiHr8) will help you get started:
<div style={{position: 'relative', paddingBottom: '50%', height: '0', overflow: 'hidden', maxWidth: '100%', height: 'auto'}}>
<iframe src="https://www.youtube.com/embed/V8ROl9wiHr8" alt="Video on creating pull requests in GitHub" frameborder="0" allowfullscreen style={{position: 'absolute', top: '0', left: '0', width: '100%', height: '95%'}}></iframe>
</div>
## Where to find more information
Explore the README links below for details on building and previewing documentation locally for our different documentation repositories:
- [Mattermost Product Documentation README](https://github.com/mattermost/docs#readme)
- [Mattermost Developer Documentation README](https://github.com/mattermost/mattermost-developer-documentation/blob/master/README.md)
- [Mattermost API Reference README](https://github.com/mattermost/mattermost/blob/master/api/README.md)
- [Mattermost Handbook README](https://github.com/mattermost/mattermost-handbook/blob/0.2.1/README.md)
Thank you for your support! 💙 If you have any questions, reach out to us in [DWG: Documentation Working Group](https://community.mattermost.com/core/channels/dwg-documentation-working-group).
## Frequently asked questions
### How can I contribute to Mattermost?
You can get involved and contribute to Mattermost in the following ways:
- Join the [Developers](https://community.mattermost.com/core/channels/developers) channel on the Mattermost Community server to get troubleshooting help or provide help to others
- [Contribute code](https://developers.mattermost.com/contribute/why-contribute/#youre-looking-to-practice-your-skills-or-give-back-to-the-community)
- [Find "Help Wanted" projects](https://github.com/search?utf8=%E2%9C%93&q=is%3Aopen+org%3Amattermost+label%3A%22Help+Wanted%22++label%3A%22Up+For+Grabs%22&type=issues)
- [File bugs](https://developers.mattermost.com/contribute/why-contribute/#youve-found-a-bug)
- [Test new features](https://developers.mattermost.com/contribute/why-contribute/#you-want-to-help-test-new-features)
- [Share feature ideas](https://developers.mattermost.com/contribute/why-contribute/#you-have-a-feature-idea)
- [Contribute to content](https://developers.mattermost.com/contribute/why-contribute/#you-want-to-help-with-content)
- [Help translate Mattermost into other languages](https://developers.mattermost.com/contribute/why-contribute/#you-want-to-help-with-product-translation)
- [Make Mattermost more accessible](https://developers.mattermost.com/contribute/why-contribute/#you-want-to-make-something-more-inclusive-or-accessible)
### Can contributors add themselves to the Mattermost company page on LinkedIn?
Yes! If you have contributed to the Mattermost project we think you should be recognized for it professionally beyond GitHub.
To add yourself to the [Mattermost page on LinkedIn](https://www.linkedin.com/company/mattermost/), do the following:
1. Log in to [LinkedIn](https://www.linkedin.com/) or create an account.
2. Go to **Me \> View profile**.
3. Under **Experience**, select the **plus** symbol and specify the following:
> - **Title**:
> - Enter **Developer** if you contributed code to the open source project or created a plugin, integration, or other enhancement.
> - Enter **Contributor** if you've contributed without writing code (e.g., filed bug report, answered troubleshooting questions, proposed a feature, etc.).
> - Enter **Translator** if you've [helped translate](https://translate.mattermost.com) Mattermost products.
> - Enter **QA Tester** if you tested Mattermost features or workflows.
> - Enter **Documentation** if you contributed to Mattermost product, repository, or developer documentation.
> - **Company**: Find **Mattermost** (you’ll see the Mattermost logo).
> - **Location**: Enter where you live.
> - **From**: Date of first contribution or perhaps month you cloned <code>github.com/mattermost</code>.
> - Select **I currently work here**.
> - **Update my industry**: Leave unchecked.
> - **Update my headline**: Leave unchecked.
> - **Description**: Leave blank or write a sentence about what you have contributed.