Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
60a11b5
adding sidebar for community docs
Rumyra Aug 3, 2022
d533773
Update files/en-us/mdn/community/contributing/index.md
Rumyra Aug 3, 2022
b12e5f9
Update files/en-us/mdn/community/contributing/our_repositories/index.md
Rumyra Aug 3, 2022
a028cdd
Update files/en-us/mdn/community/contributing/security_vulnerability_…
Rumyra Aug 3, 2022
6c2fbd7
Update files/en-us/mdn/community/contributing/translated_content/inde…
Rumyra Aug 3, 2022
8cfcb08
Update files/en-us/mdn/community/discussions/index.md
Rumyra Aug 3, 2022
c4b6e0c
Update files/en-us/mdn/community/issues/content_suggestions_feature_p…
Rumyra Aug 3, 2022
57e247a
Update files/en-us/mdn/community/pull_requests/index.md
Rumyra Aug 3, 2022
44f32c0
Update files/en-us/mdn/community/index.md
Rumyra Aug 3, 2022
8dd08fd
Update files/en-us/mdn/writing_guidelines/index.md
Rumyra Aug 3, 2022
86ec056
Update files/en-us/mdn/community/users_teams/index.md
Rumyra Aug 3, 2022
c28b6b8
Update files/en-us/mdn/community/contributing/getting_started/index.md
Rumyra Aug 3, 2022
7059e17
Update files/en-us/mdn/community/issues/index.md
Rumyra Aug 3, 2022
7d17123
Update files/en-us/mdn/community/mdn_content/index.md
Rumyra Aug 3, 2022
5693c26
Update files/en-us/mdn/community/learn_forum/index.md
Rumyra Aug 3, 2022
d2a912c
Update files/en-us/mdn/community/mdn_content/pull_requests/index.md
Rumyra Aug 3, 2022
c6d3d4f
Update files/en-us/mdn/community/mdn_content/issues/index.md
Rumyra Aug 3, 2022
cf20314
Update files/en-us/mdn/community/open_source_etiquette/index.md
Rumyra Aug 3, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ tags:
- governance
---

{{MDNSidebar}}

We are an open community of developers, technical writers, and learners building resources for a better Web, regardless of brand, browser, or platform. Anyone can contribute, and each person who does contribute makes us stronger. Together we can continue to drive innovation on the Web to serve the greater good. It starts here, with you.

[Join us!](https://github.com/mdn/mdn-community/)
Expand Down Expand Up @@ -36,7 +38,7 @@ To contribute, you will need a GitHub account. If you do not already have one, g

### Additional reading and learning material

- [Basic etiquette for open source projects](../../open-source-etiquette/index.md): If you've never contributed to an open source project before, we encourage you to read this document.
- [Basic etiquette for open source projects](/en_US/docs/MDN/Community/Open_source_etiquette): If you've never contributed to an open source project before, we encourage you to read this document.
- [Learn web development](https://developer.mozilla.org/docs/Learn): If you are new to HTML, CSS, JavaScript, we have some great content to help you get started.
- [Deep dive into collaborating with pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests)

Expand Down
10 changes: 6 additions & 4 deletions files/en-us/mdn/community/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ tags:
- governance
---

- [Getting started](getting-started/index.md)
- [Our repositories](our-repositories/index.md)
- [Translated content](translated-content/index.md)
- [Security vulnerability response](security-vulnerability-response/index.md)
{{MDNSidebar}}

- [Getting started](/en-US/docs/MDN/Community/Contributing/Getting-Started)
- [Our repositories](/en-US/docs/MDN/Community/Contributing/Our_repositories)
- [Translated content](/en-US/docs/MDN/Community/Contributing/Translated_content)
- [Security vulnerability response](/en-US/docs/MDN/Community/Contributing/Security_vulnerability_response)
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ tags:
- governance
---

{{MDNSidebar}}

[MDN Web Docs](https://developer.mozilla.org) is a complex project with lots of moving parts. It's a good idea to get familiar with the projects different repositories. This document intends to help you find the different repositories (repos) you may need when contributing to different parts of the MDN Web Docs project.

## Repository tiers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ tags:
- governance
---

{{MDNSidebar}}

## A little history
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should give some context before this h2, or we should get rid of the header here.


On ~27 November 2018 an NPM security vulnerability was announced for all users that depend, either directly or indirectly, on the [event-stream](https://snyk.io/blog/malicious-code-found-in-npm-package-event-stream) package. It was a very targeted attack, that only activated if the Copay bitcoin wallet was installed, whereupon it tried to steal the contents.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ tags:
- governance
---

{{MDNSidebar}}

Since December 14th 2020, MDN has been running on the new GitHub-based [Yari platform](https://github.com/mdn/yari). This has a lot of advantages for MDN, but we've needed to make radical changes to the way in which we handle localization. This is because we've ended up with a lot of unmaintained and out-of-date content in our non-en-US locales, and we want to manage it better in the future.

We have frozen all localized content (meaning that we won't accept any edits to it; it'll be read-only), EXCEPT for the below locales — these locales have dedicated teams taking responsibility for maintaining them.
Expand Down
2 changes: 2 additions & 0 deletions files/en-us/mdn/community/discussions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ tags:
- governance
---

{{MDNSidebar}}

On MDN Web Docs, we encourage our community to start and/or engage in discussions around topics related to the overall project. Discussions are categorized by different topic areas. We ask that you keep each discussion focused on the topic at hand instead of covering multiple topics in one discussion.

_NOTE:_ mdn-community/discussions is not the place to report problems. For any problems you encounter on MDN Web Docs, it is best to raise issues against the [relevant project](https://github.com/mdn/). If you're ever in doubt about whether to open an issue or a discussion, consider the following guidelines:
Expand Down
7 changes: 4 additions & 3 deletions files/en-us/mdn/community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ tags:
- community-guidelines
- governance
---
{{MDNSidebar}}

👋 Welcome to MDN Web Docs on GitHub! MDN Web Docs is an open-source, collaborative project that documents web platform technologies, including [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML), [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS), [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript), and [Web APIs](https://developer.mozilla.org/en-US/docs/Web/API). We also provide extensive [learning resources](https://developer.mozilla.org/en-US/docs/Learn) for early-stage developers and students.

Expand All @@ -15,10 +16,10 @@ tags:
[//]: # "TODO: Remember to update these links as we move the documentation around."

- [Fixing known high impact issues](https://github.com/orgs/mdn/projects/25/views/1)
- [Reviewing pull requests](pull-requests/)
- [Help beginners to learn on MDN Web Docs](learn-forum/)
- [Reviewing pull requests](/en-US/docs/MDN/Community/Pull_requests/)
- [Help beginners to learn on MDN Web Docs](/en-US/docs/MDN/Community/Learn_forum/)
- [Contribute to MDN Web Docs interactive examples](https://github.com/mdn/interactive-examples/blob/main/CONTRIBUTING.md)
- [Help translate MDN Web Docs](https://developer.mozilla.org/en-US/docs/MDN/Contribute/Localize)
- [Help translate MDN Web Docs](/en-US/docs/MDN/Community/Contributing/Translated_content)
- [Help fix known platform issues](https://github.com/mdn/yari/issues)
- [Help us keep browser compatibility data up to date.](https://github.com/mdn/browser-compat-data)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ tags:
- governance
---

{{MDNSidebar}}

We are always interested in hearing from our community about new content or feature suggestions you may have for MDN Web Docs. However, even though we are open to suggestions, we have to keep the following in mind:

- MDN Web Docs is run and managed by a small internal team. We also rely heavily on our partners and community to help us keep MDN Web Docs the best resource for web developers on the web. As such, we will sometimes have to say no to new content or features because we will simply not be unable to maintain them long-term.
Expand Down
6 changes: 4 additions & 2 deletions files/en-us/mdn/community/issues/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ tags:
- governance
---

[Issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues) are used to track all bugs and work that has a clear actionable outcome. If you have found a bug with either our content or the platform, please search current open issues against the [relavant repository](../contributing/our-repositories/) to ensure someone has not already reported the issue. If the issue is new, please file an issue using the relavant template available in the repository.
{{MDNSidebar}}

[Issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues) are used to track all bugs and work that has a clear actionable outcome. If you have found a bug with either our content or the platform, please search current open issues against the [relavant repository](/en_US/docs/MDN/Community/Contributing/Our_repositories/) to ensure someone has not already reported the issue. If the issue is new, please file an issue using the relavant template available in the repository.

> NOTE: If an issue has a triage label, we haven't reviewed it yet, and you shouldn't begin work on it.

Expand Down Expand Up @@ -79,7 +81,7 @@ Most issues need some investigation before work can start, if you need to ask qu

If you take on an issue we expect work to happen in a timely manner. If you can no longer take on the task, leave a comment and unassign yourself.

Fork and branch the repository, do your work and open a [pull request](../pull_requests/index.md).
Fork and branch the repository, do your work and open a [pull request](/en_US/docs/MDN/Community/Pull_requests).

_(more stuff)_

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/mdn/community/issues/issue_triage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This document looks at the process for triaging content bugs and getting them re

Anyone can report a content bug by writing an issue at <https://github.com/mdn/content/issues/new> using the "Content bug" issue template, or by using the "Report a problem with this content on GitHub" link at the bottom of each MDN page.

Once reported, content bugs are listed at <https://github.com/mdn/content/issues>, and are designed to be done by individuals with minimal process requirements. Anyone is welcome to work on a content bug, using the process outlined at [Fixing MDN content bugs](/en-US/docs/MDN/Contribute/Fixing_MDN_content_bugs).
Once reported, content bugs are listed at <https://github.com/mdn/content/issues>, and are designed to be done by individuals with minimal process requirements. Anyone is welcome to work on a content bug, using the process outlined at [Fixing MDN content bugs](/en_US/docs/MDN/Community/Issues).

## Overall triage process

Expand Down
7 changes: 4 additions & 3 deletions files/en-us/mdn/community/learn_forum/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ tags:
- governance
---

{{MDNSidebar}}

Our [Learn web development](/en-US/docs/Learn) pages get over a million views per month, and have [active forums](https://discourse.mozilla.org/c/mdn/learn/250) where people go to ask for general help, or request that their assessments be marked. We'd love some help with answering posts, and growing our learning community.

## What do we need help with?
Expand All @@ -30,9 +32,8 @@ In the [MDN learning forum](https://discourse.mozilla.org/c/mdn/learn/250), ther

## How to help

1. First of all, [sign up for an MDN account](/en-US/docs/MDN/Contribute/Getting_started#step_1_create_an_account_on_mdn), if you don't already have one. You don't absolutely need to do this to help in the learning area, but it will be useful in the long run.
2. Also sign up for [Mozilla Discourse](https://discourse.mozilla.org/), if you haven't already.
3. Have a look at [Learn web development](/en-US/docs/Learn) section and gain a basic level of familiarity with what's there, if you haven't already (see the [Structure of the MDN Learning Area](#structure_of_the_mdn_learning_area) section below for help).
1. Sign up for [Mozilla Discourse](https://discourse.mozilla.org/), if you haven't already.
2. Have a look at [Learn web development](/en-US/docs/Learn) section and gain a basic level of familiarity with what's there, if you haven't already (see the [Structure of the MDN Learning Area](#structure_of_the_mdn_learning_area) section below for help).

### Once you are set up

Expand Down
3 changes: 2 additions & 1 deletion files/en-us/mdn/community/mdn_content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ tags:
- mdn-content
---

{{MDNSidebar}}

Problems with MDN docs are reported as [content repo issues](https://github.com/mdn/content/issues). This article helps you find the _best_ issues to work on, based on your expertise and how much time you have available, and outlines the main steps to fixing them.

> **Note:** We get a lot of content bugs — any help you can give in fixing them is very much appreciated!
Expand Down Expand Up @@ -50,4 +52,3 @@ If you'd prefer to browse your tasks and choose by technology category instead,
3. Once you've fixed an issue, ask the submitter for a review and, hopefully, they will tell you whether they think more work is required. We will get involved if needed.
4. Once the issue is verified fixed, it can be closed. The person closing the issue can be either the original issue submitter, or an MDN staff member.

> **Note:** When choosing and working on an issue, you might also find our [GitHub best practices](/en-US/docs/MDN/Contribute/GitHub_best_practices) and [Getting started on MDN](/en-US/docs/MDN/Contribute/Getting_started) guides useful.
2 changes: 2 additions & 0 deletions files/en-us/mdn/community/mdn_content/issues/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ tags:
- mdn-content
---

{{MDNSidebar}}

TBD
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should avoid placeholders. Most of the time, we forget about them forever.

2 changes: 2 additions & 0 deletions files/en-us/mdn/community/mdn_content/pull_requests/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ tags:
- mdn-content
---

{{MDNSidebar}}

## Overall process

This section describes how contributors make changes on MDN Web Docs and how the changes are reviewed and land on the site.
Expand Down
8 changes: 5 additions & 3 deletions files/en-us/mdn/community/open_source_etiquette/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ tags:
- open-source
---

{{MDNSidebar}}

If you've not worked on an open source project (OSP) before, it is a good idea to read this article before starting to contribute to MDN Web Docs (or other open source projects). There are a few best practices to adopt that will help ensure that you and the other project contributors feel valued and safe, and stay productive.

This article won't teach you everything about contributing to open source; the aim here is more to give you some good starting points to think about as you get started with open source contributions.
Expand Down Expand Up @@ -64,7 +66,7 @@ If you receive anything that makes you feel uncomfortable, you should always rep

Think about what you want to do on the project. For example, we have a large list of issues filed at on the [contributtors task board](https://github.com/orgs/mdn/projects/25/views/1), broken up by various task types.

You could also contribute by opening [pull requests](../pull-requests/) to fix problems that you come across while reading MDN articles.
You could also contribute by opening [pull requests](/en_US/docs/MDN/Community/Pull_requests) to fix problems that you come across while reading MDN articles.

A lot of the work on MDN revolves around writing documentation and code examples, but there are other ways to contribute too:

Expand All @@ -85,15 +87,15 @@ In many cases, things are like they are on OSPs for a reason. You should read th

## Read the manual

Good OSPs will always make contributor documentation readily available. On GitHub projects, it is usually in the repo's CONTRIBUTING.md file, or sometimes in the project's README.md file. Being a documentation project, MDN content has a [README](https://github.com/mdn/content/blob/main/README.md) and a decent set of contributor docs on the site itself (see [Contributing to MDN](/en-US/docs/MDN/Contribute)).
Good OSPs will always make contributor documentation readily available. On GitHub projects, it is usually in the repo's CONTRIBUTING.md file, or sometimes in the project's README.md file. Being a documentation project, MDN content has a [README](https://github.com/mdn/content/blob/main/README.md) and a decent set of contributor docs on the site itself (see [Contributing to MDN](/en-US/docs/MDN/Community)).

Don't be afraid to ask for help, but ALWAYS try to find the answer to your question first before asking. This way you build up your knowledge of the project and become more independent, and don't put unnecessary burden on the other contributors.

Of course, the docs won't always be perfect. If an explanation is hard to find or not described very well, file an issue, or create a pull request to try to fix it yourself.

## Find out where to ask questions

Always find out where the best place is to ask questions. Good OSPs will always make this clear in their docs (see [ask for help on MDN](/en-US/docs/MDN/Contribute/Getting_started#step_4_ask_for_help)). If you want to ask general questions, then always make use of these channels. Don't just file an issue on GitHub for every question, as it adds noise to the project (see "Make progress, not noise" below).
Always find out where the best place is to ask questions. Good OSPs will always make this clear in their docs (see [ask for help on MDN](/en-US/docs/MDN/Community)). If you want to ask general questions, then always make use of these channels. Don't just file an issue on GitHub for every question, as it adds noise to the project (see "Make progress, not noise" below).

## Make progress, not noise

Expand Down
Loading