mirror of
https://github.com/hanzoai/team.git
synced 2026-09-30 01:57:35 +00:00
* feat(docs): move docs-experimental content into monorepo docs/ * Remove plan related files and comments * Cleanup comments, remove generated files --------- Co-authored-by: Hanzo Dev <[email protected]>
70 lines
5.5 KiB
Plaintext
70 lines
5.5 KiB
Plaintext
---
|
||
title: "Contribute to this documentation"
|
||
---
|
||
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="/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.
|