Skip to content

Commit

Permalink
Update _index.md (#1134)
Browse files Browse the repository at this point in the history
* Update _index.md

* Update _index.md

* Update _index.md

Changed title why-contribute

* Update _index.md

* Update site/content/contribute/good-decisions/_index.md

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>

* Update site/content/contribute/good-decisions/_index.md

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>

* Update _index.md

Added note about CoC and community expectations to Contributor expectations page

* Update _index.md

* Update _index.md

linking sections around documentation to one another

* Update _index.md

linking to the repos on the Contributor expectations

* Update site/content/contribute/why-contribute/_index.md

* Update site/content/contribute/good-decisions/_index.md

* Update site/content/contribute/good-decisions/_index.md

* Update _index.md

added @azigler's suggestion for app integrations rewrite

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>
  • Loading branch information
jordanafung and cwarnermm authored Oct 7, 2022
1 parent bd56f3b commit 6e3c2f4
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 14 deletions.
2 changes: 1 addition & 1 deletion site/content/contribute/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This guide is your reference for all Mattermost contributions. The following is
- **[Why and how to contribute]({{<ref "why-contribute">}})**:
How to get started contributing to Mattermost projects.

- **[Making good decisions]({{<ref "good-decisions">}})**:
- **[Community expectations]({{<ref "good-decisions">}})**:
How to communicate and interact effectively, respectfully, and inclusively with other members of the Mattermost community.

- **[Contributor expectations]({{<ref "expectations">}})**:
Expand Down
5 changes: 3 additions & 2 deletions site/content/contribute/expectations/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ weight: 3
---

To contribute to Mattermost, you must sign the [Contributor License Agreement](https://mattermost.com/mattermost-contributor-agreement/). Doing so adds you to our list of [Mattermost Approved Contributors](https://docs.google.com/spreadsheets/d/1NTCeG-iL_VS9bFqtmHSfwETo5f-8MQ7oMDE5IUYJi_Y/pubhtml?gid=0&single=true).
Please also read our [community expectations]({{< ref "/contribute/good-decisions/" >}}) and note that we all abide by the [Mattermost Code of Conduct (CoC)](https://handbook.mattermost.com/contributors/contributors/guidelines/contribution-guidelines), and by joining our contributor community, you agree to abide by it as well.

**Tip:** Love swag? If you choose to provide us with your mailing address in the signed agreement, you'll receive a [Limited Edition Mattermost Mug](https://forum.mattermost.com/t/limited-edition-mattermost-mugs/143) as a thank you gift after your first pull request is merged.

## Before contributing

There are many ways to contribute to Mattermost beyond a core Mattermost repository:
- You can [create an app integration]({{< ref "/integrate/apps/" >}}), which connects to Mattermost’s functionality that's hosted elsewhere.
- You can create [app integrations]({{< ref "/integrate/apps/" >}}) for Mattermost to provide additional functionality and host them anywhere.
- You can create lightweight external applications that don’t require customizations to the Mattermost user experience by using [incoming]({{< ref "/integrate/webhooks/incoming" >}}) and [outgoing]({{< ref "/integrate/webhooks/outgoing" >}}) webhooks, or by using [the Mattermost API](https://api.mattermost.com/).
- You can activate external functionality within Mattermost by creating custom [slash commands]({{< ref "/integrate/slash-commands/" >}}).
- You can extend, modify, and deeply integrate with the Mattermost server, its apps, and its UI/UX by using [plugins]({{< ref "/integrate/plugins/" >}}). However, please note that plugin development comes with the highest level of overhead and must be written in Go and React.
Expand All @@ -29,7 +30,7 @@ To get started:
- [Core Plugins]({{< ref "/contribute/more-info/plugins/" >}}): A core set of officially-maintained plugins that provide a variety of improvements to Mattermost.
- [Boards]({{< ref "/contribute/more-info/focalboard/" >}}) and [Playbooks](https://github.com/mattermost/mattermost-plugin-playbooks) core integrations.

2. To contribute to documentation, you should be able to edit any page and get to the source file in the documentation repository by selecting the **Edit in Github** button in the top right of its respective published page. You can contribute to the following Mattermost documentation sites:
2. To contribute to documentation, you should be able to edit any page and get to the source file in the documentation repository by selecting the **Edit in Github** button in the top right of its respective published page. You can read more about this process on the [why and how to contribute page]({{< ref "/contribute/why-contribute/#you-want-to-help-with-content" >}}). You can contribute to the following Mattermost documentation sites:

- [Product documentation](https://github.com/mattermost/docs)
- [Developer documentation](https://github.com/mattermost/mattermost-developer-documentation)
Expand Down
18 changes: 10 additions & 8 deletions site/content/contribute/good-decisions/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Making good decisions"
heading: "Making good decisions"
title: "Community expectations"
heading: "Community expectations"
weight: 2
---
We are a welcoming and open community and we’re excited to have you join us!
Expand All @@ -9,28 +9,30 @@ To be an open, safe, and welcoming community, we strive to be inclusive, collabo

Learn more about our {{<newtabref title="company values" href="https://handbook.mattermost.com/company/about-mattermost#leadership-principles">}}, and how to become a successful member of the Mattermost community by learning and following our standard operational guidelines below. Please read these sections below carefully and let us know if you have any questions or concerns.

## We're inclusive
## We are inclusive

We welcome all people, **but not all behavior**.

We are a diverse community who celebrate both our differences and the things that connect us. We treat each other with respect, and aim to treat others better than they wish to be treated.

We try our best to be clear and respectful. We remember that others may not speak the same language. We recognize that communication can be challenging, especially among a diverse group of people speaking many different languages and coming from many different cultures and backgrounds.
We try our best to be clear and respectful. We remember that others may not communicate in the same language with the same fluency. We recognize that communication can be challenging, especially among a diverse group of people communicating in many different languages and coming from many different cultures and backgrounds.

We all try to be mindful of our differences when we communicate and collaborate. We’re aware that misunderstandings can happen. We try to resolve them by being respectful, understanding, and by using clear and simple language.

## We're collaborative
## We are collaborative
- We ask questions and consult others.
- We work together and help each other.
- We aim for clarity.

## We're considerate
## We are considerate
- We have patience with each other.
- No one has all the answers, nor are they expected to.
- We understand that no one has all the answers, nor are they expected to.

## We're respectful
## We are respectful
- We offer thanks and we’re grateful.
- We may occasionally disagree, but we resolve these disagreements in respectful ways, take breaks if things get heated, reassess, and consult others where appropriate.
- We aim to be self-aware and we take responsibility for our impact through our words and actions.
- We understand and acknowledge that {{<newtabref title="intent doesn’t equal impact" href="https://www.betterup.com/blog/intent-vs-impact">}}. We can have the best of intentions, but still cause negative impact to others by our words and actions. This can happen to all of us, so we practice openness and grace.

### Attribution
This document was heavily inspired by and adapted from the work of the [Drupal Community and its Code of Conduct](https://www.drupal.org/dcoc) and its [Values and Principles](https://www.drupal.org/about/values-and-principles) documents.
7 changes: 4 additions & 3 deletions site/content/contribute/why-contribute/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Why you might contribute"
heading: "Why you might contribute"
title: "Why and how to contribute"
heading: "Why and how to contribute"
weight: 1
---

Expand Down Expand Up @@ -72,6 +72,7 @@ Good product and developer documentation content is as important as good code! I
- If you don’t have time to fix the mistake, copy the file path you’re on, and create a GitHub issue about the problem you found on the applicable repository. Make sure to include the file path and fill out the issue template completely to maximize clarity.
- If you’re not up for creating a GitHub issue right now, that’s alright too! In the bottom-right corner of every product documentation page is the question “Did you find what you were looking for?” Use this to quickly provide direct feedback about any page you’re viewing.
- If you want to fix a larger problem that affects multiple pages or the structure of the docs, you should first report it as an issue on the appropriate GitHub repository, and follow the steps under [“You’ve found a bug”]({{< ref "/contribute/why-contribute/#youve-found-a-bug" >}}). The [developer](https://developers.mattermost.com/) and [product](https://docs.mattermost.com/) documentation repositories contain instructions on how to build and modify the sites locally so you can test larger changes more efficiently.
- Find a list of the Mattermost documentation specific repos on the [Contributor expectations page]({{< ref "/contribute/expectations/#before-contributing" >}}) of this guide.

**Tip:** The best place to discuss problems with the writing team is in the [Documentation Working Group channel](https://community.mattermost.com/core/channels/dwg-documentation-working-group) where you can ping our technical writers with the group `@docsteam`.

Expand Down Expand Up @@ -109,7 +110,7 @@ Thank you for your enthusiasm! You can act on feature ideas in a few ways:

We love developers who are passionate about open-source!

If you’re looking to tackle an interesting problem, we’ve got you covered! Feel free to check out [the help wanted tickets on GitHub](https://github.com/search?utf8=%E2%9C%93&q=is%3Aopen+archived%3Afalse+org%3Amattermost+label%3A%22Help+Wanted%22++label%3A%22Up+For+Grabs%22). To take one on, just comment on the issue, and follow the process outlined in [You've found a bug](#youve-found-a-bug) of this guide.
If you’re looking to tackle an interesting problem, we’ve got you covered! Feel free to check out [the help wanted tickets on GitHub](https://github.com/search?utf8=%E2%9C%93&q=is%3Aopen+archived%3Afalse+org%3Amattermost+label%3A%22Help+Wanted%22++label%3A%22Up+For+Grabs%22). To take one on, just comment on the issue, and follow the process outlined in [You've found a bug](#youve-found-a-bug) of this guide. You can find a list of the Mattermost repos on the [Contributor expectations page]({{< ref "/contribute/expectations/#before-contributing" >}}) of this guide.

## You want to help with product translation

Expand Down

0 comments on commit 6e3c2f4

Please sign in to comment.