-
Notifications
You must be signed in to change notification settings - Fork 23.1k
docs: community docs #18787
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
docs: community docs #18787
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
53 changes: 53 additions & 0 deletions
53
files/en-us/mdn/community/contributing/getting-started/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| title: Getting started with MDN Web Docs | ||
| slug: MDN/Community/Contributing/Getting_started | ||
| page-type: mdn-community-guide | ||
| tags: | ||
| - meta | ||
| - community-guidelines | ||
| - governance | ||
| --- | ||
|
|
||
| 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/) | ||
|
|
||
| ## What can I do to help? | ||
|
|
||
| There are multiple avenues you can take to contribute to MDN, depending on your skill set and interests. Therefore, along with each task, we provide a short description and an approximate time each type of task typically takes. | ||
|
|
||
| > If unsure what to do, you are always welcome to [ask for help](https://github.com/mdn/mdn-community/). | ||
Rumyra marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| > Also note that our small, but mighty docs team maintains this repo, to preserve our bandwidth, off topic conversations will be closed. | ||
|
|
||
| ## Primary contribution types | ||
|
|
||
| We have created a [contributors task board](https://github.com/orgs/mdn/projects/25/views/1) to help you find contribution opportunities that will meaningfully impact the project. The board has an overview and separate views for specific contribution types. | ||
Rumyra marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Getting ready to contribute | ||
|
|
||
| To contribute, you will need a GitHub account. If you do not already have one, go ahead and [sign up](https://github.com/signup) for an account before continuing. If you are new to GitHub, we encourage you to take the following free, self-paced courses and reading material offered by GitHub. With this knowledge, you can focus on your contributions and not learn a new tool at the same time. | ||
|
|
||
| > NOTE: Do not feel overwhelmed or like you have to read through and complete _all_ of the course work. With the knowledge gained from the "Introduction to GitHub" course, you will be well on your way. | ||
|
|
||
| - [Introduction to GitHub](https://github.com/skills/introduction-to-github) | ||
| - [Setting up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) | ||
| - [GitHub workflow](https://docs.github.com/en/get-started/quickstart/github-flow) | ||
| - [Using Markdown](https://github.com/skills/communicate-using-markdown) | ||
|
|
||
| ### 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. | ||
| - [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) | ||
|
|
||
| Some writing-specific contribution opportunities will require a reasonable understanding of the English language. That said, do not let perfect be the enemy of “good enough.” Even if your grammar isn’t good, don’t worry about it! We have a team of people who aim to ensure that MDN’s contents are as good as possible. In addition, someone will be along to ensure your work is tidy and well-written. | ||
|
|
||
| Once you’ve decided what kind of task you want to work on, it is time to head over to the [contributors task board](https://github.com/orgs/mdn/projects/25/views/1), pick an issue, and let us know by commenting on the issue and tagging the `@mdn/mdn-community-engagement` team. Someone from the team will respond and assign the issue to you. | ||
|
|
||
| This ensures that two people do not work on the same issue, and you will know who to contact should you get stuck. | ||
|
|
||
| ### Contributions | ||
|
|
||
| When contributing, you agree to make your contributions available under the [Attribution-ShareAlike license](https://creativecommons.org/licenses/by-sa/4.0/) (or an alternative license already specified by the page you are editing). In addition, code samples are available under [Creative Commons CC-0](https://creativecommons.org/share-your-work/public-domain/cc0/) (a Public Domain dedication). | ||
|
|
||
| > If you have any questions or concerns about anything discussed here, please [open a discussion](https://github.com/mdn/mdn-community/discussions/categories/content) and let us know. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| title: Contributing to MDN Web Docs | ||
| slug: MDN/Community/Contributing | ||
| page-type: mdn-community-guide | ||
| tags: | ||
| - meta | ||
| - community-guidelines | ||
| - 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) |
84 changes: 84 additions & 0 deletions
84
files/en-us/mdn/community/contributing/our-repositories/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| --- | ||
| title: MDN Web Docs Repositories | ||
| slug: MDN/Community/Contributing/Our_repositories | ||
| page-type: mdn-community-guide | ||
| tags: | ||
| - meta | ||
| - community-guidelines | ||
| - governance | ||
| --- | ||
|
|
||
| [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 | ||
|
|
||
| ### Tier 1 | ||
|
|
||
| Code in these repositories are core to the MDN Web Docs project and runs on https://developer.mozilla.org, or another Mozilla owned domain. | ||
|
|
||
| - [mdn/content](https://github.com/mdn/content) | ||
| - [Yari](https://github.com/mdn/yari) | ||
| - [rumba](https://github.com/mdn/rumba) | ||
| - [browser-compat-data](https://github.com/mdn/browser-compat-data) | ||
| - [interactive-examples](https://github.com/mdn/interactive-examples) | ||
| - [bob](https://github.com/mdn/bob) | ||
|
|
||
| A Tier 1 project should have at least 3 members, including at least two with admin permissions. | ||
|
|
||
| ### Tier 2 | ||
|
|
||
| These repositories are mainly concentrated on supporting content such as code examples, the MDN Web Docs learn area, localisation, and examples projects. Examples include: | ||
|
|
||
| - [dom-examples](https://github.com/mdn/dom-examples) | ||
| - [translated-content](https://github.com/mdn/translated-content) | ||
| - [learning-area](https://github.com/mdn/learning-area) | ||
|
|
||
| A Tier 2 project should have at least 2 members, including at least one with admin permissions. | ||
|
|
||
| ### Tier 3 | ||
|
|
||
| These are repository used for project planning, documenting the project itself, and community engagement. Examples include: | ||
|
|
||
| - [mdn-community](https://github.com/mdn/mdn-community) | ||
| - [mdn/mdn](https://github.com/mdn/mdn) | ||
| - [content-team-projects](https://github.com/mdn/content-team-projects). | ||
|
|
||
| A Tier 3 project needs 1 admin. | ||
|
|
||
| ## Core repos | ||
|
|
||
| - **Core content**: <https://github.com/mdn/content>. The most important repo for MDN Web Docs content — this is where all the core English content of the site is stored, and where you'll make all standard changes to page content. | ||
| - **MDN Web Docs Platform**: <https://github.com/mdn/yari>. This is where the MDN Web Docs platform is stored, and where you'll go if you want to make changes to our high level page structure or rendering machinery. | ||
| - **Browser compatibility data**: <https://github.com/mdn/browser-compat-data>. This is where the data used to generate the browser compatibility tables found on our reference pages is stored ([example](/en-US/docs/Web/HTML/Element/progress#browser_compatibility)). If you have information about browser compatibility of Web features — or are willing and able to do some research and/or experimentation — you can help update MDN's [Browser Compatibility Data](https://github.com/mdn/browser-compat-data/blob/main/docs/contributing.md) | ||
| - **Interactive examples**: <https://github.com/mdn/interactive-examples>. This repo stores the example code blocks that are found at the top of many of our reference pages ([example](/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis)). Edit those examples here. | ||
| - **Bob** aka Builder of Bits: <https://github.com/mdn/bob> | ||
| This repo stores the rendering code that produce the nice editable, copyable examples found at the top of many of our reference pages ([example](/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis)). | ||
| - **Translated content**: <https://github.com/mdn/translated-content>. This is where localized content lives. Go here if you want to help translate pages into any of our [actively maintained locales](https://github.com/mdn/translated-content#locales). | ||
| - **Workflows**: <https://github.com/mdn/workflows> | ||
| A growing collection of reusable GitHub Actions for use on MDN Web Docs repositories. | ||
|
|
||
| ## Code example | ||
|
|
||
| ### Code examples and demos | ||
|
|
||
| [//]: # "TODO: UPDATE WITH REPO TRIAGE" | ||
|
|
||
| The MDN Web Docs GitHub org contains a huge number of example repos. These generally contain free-standing code examples that are often linked to from our pages, but occasionally you’ll find one of these examples embedded into a page using a macro call like this — `{{EmbedGHLiveSample("css-examples/learn/tasks/grid/grid1.html", '100%', 700)}}`. | ||
|
|
||
| Always remember, if you are updating the code on any given page, you'll need to update the corresponding example repo as well. | ||
|
|
||
| - [**dom-examples**](https://github.com/mdn/dom-examples) | ||
| - [**css-examples**](https://github.com/mdn/css-examples) | ||
| - [**webaudio-examples**](https://github.com/mdn/webaudio-examples) | ||
| - [**webassembly-examples**](https://github.com/mdn/webassembly-examples) | ||
| - [**indexeddb-examples**](https://github.com/mdn/indexeddb-examples) | ||
| - [**js-examples**](https://github.com/mdn/js-examples) | ||
| - [**html-examples**](https://github.com/mdn/html-examples) | ||
| - [**web-components-examples**](https://github.com/mdn/web-components-examples) | ||
| - [**webextension-examples**](https://github.com/mdn/webextensions-examples) | ||
| - [**webgl-examples**](https://github.com/mdn/webgl-examples) | ||
| - [**pwa-examples**](https://github.com/mdn/pwa-examples) | ||
| - [**houdini-examples**](https://github.com/mdn/houdini-examples) | ||
| - [**headless-examples**](https://github.com/mdn/headless-examples) | ||
| - [**perf-examples**](https://github.com/mdn/perf-examples) | ||
| - [**devtools-examples**](https://github.com/mdn/devtools-examples) |
41 changes: 41 additions & 0 deletions
41
files/en-us/mdn/community/contributing/security-vulnerability-response/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: Security Vulnerability Response Steps | ||
| slug: MDN/Community/Contributing/Security_vulnerability_response | ||
| page-type: mdn-community-guide | ||
| tags: | ||
| - meta | ||
| - community-guidelines | ||
| - governance | ||
| --- | ||
|
|
||
| ## A little history | ||
|
|
||
| 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. | ||
|
|
||
| Two of our projects, namely [interactive-examples](https://github.com/mdn/interactive-examples/) and [BoB](https://github.com/mdn/bob/), depend on an NPM package called [npm-run-all](https://www.npmjs.com/package/npm-run-all), which in turn depended on the event-stream package. | ||
|
|
||
| This meant that not only was staff at risk, but people who have forked either of these repositories might have been affected as well. Thankfully the maintainers of the affected package reacted swiftly and released an update to address the issue. Because we have the [Renovate bot](https://github.com/marketplace/renovate) running against these repositories, there was a [pull request](https://github.com/mdn/interactive-examples/pull/1239/) ready to merge. | ||
|
|
||
| This only resolved one part of the problem though. Our users still needed to be notified. | ||
|
|
||
| ## Steps taken | ||
|
|
||
| The community for especially the interactive-examples project was rather large, and not everyone active, but we still needed a way to reach out to everyone. The first step was then to open an issue against each of the repositories detailing the problem: | ||
|
|
||
| - [interactive-examples](https://github.com/mdn/interactive-examples/issues/1242) | ||
| - [bob](https://github.com/mdn/bob/issues/184) | ||
|
|
||
| That by itself is not enough as users do not necessarily actively monitor issues. We therefore, needed to look at all of the forks of the project, for example: https://github.com/mdn/interactive-examples/network/members | ||
|
|
||
| We then copied all of the usernames for these users and pinged them on the above issue, for example: https://github.com/mdn/interactive-examples/issues/1242#issuecomment-442110598 | ||
|
|
||
| This was very effective from the response we received in the issue, but we could not leave it there. The next step was to post a comment on each of the open pull requests informing the user of the problem, and what their next steps should be: | ||
| https://github.com/mdn/interactive-examples/pull/1144 | ||
|
|
||
| With this, we felt rather confident that between us reaching out, and coverage of the issue online by NPM and other channels, would ensure that we ensured our users are safe. | ||
|
|
||
| As a final step, @schalkneethling posted a message on Twitter which was in turn retweeted by the [MDN Web Docs Twitter account](https://twitter.com/schalkneethling/status/1067436637385179136). | ||
|
|
||
| ### In closing | ||
|
|
||
| Hopefully, these types of incidents will be few and far between. Should this happen again however, the above provides a solid guideline on how to respond. |
60 changes: 60 additions & 0 deletions
60
files/en-us/mdn/community/contributing/translated-content/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| title: MDN Web Docs Localisation | ||
| slug: MDN/Community/Contributing/Translated_content | ||
| page-type: mdn-community-guide | ||
| tags: | ||
| - meta | ||
| - community-guidelines | ||
| - governance | ||
| --- | ||
|
|
||
| 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. | ||
|
|
||
| ## Active locales | ||
|
|
||
| > **Note:** If you want to contribute to one of the existing active locales get in touch with one of the active members listed below, or [contact us for help](/en-US/docs/MDN/Contribute/Getting_started#step_4_ask_for_help). | ||
|
|
||
| ### Brazilian Portuguese (pt-BR) | ||
|
|
||
| - Discussions: [Telegram (MDN localization in Brazilian Portuguese)](https://t.me/mdn_l10n_pt_br) | ||
| - Current contributors: [Luisa Migueres](https://github.com/lumigueres), [Julio Sampaio](https://github.com/juliosampaio), [Josiel Rocha](https://github.com/josielrocha), [Clóvis Lima Júnior](https://github.com/clovislima) | ||
|
|
||
| ### Chinese (zh-CN, zh-TW) | ||
|
|
||
| - Discussions: [Telegram (MozTW L10n channel)](https://moztw.org/community/telegram/) | ||
| - Current contributors: [Irvin](https://github.com/irvin), [t7yang](https://github.com/t7yang), [dibery](https://github.com/dibery) | ||
|
|
||
| ### French (fr) | ||
|
|
||
| - Discussions : [Matrix (#l10n-fr channel)](https://chat.mozilla.org/#/room/#l10n-fr:mozilla.org) | ||
| - Current contributors: [cw118](https://github.com/cw118), [Jb Audras](https://github.com/audrasjb), [SphinxKnight](https://github.com/SphinxKnight), [tristantheb](https://github.com/tristantheb) | ||
|
|
||
| ### Japanese (ja) | ||
|
|
||
| - Discussions: [Slack (#translation channel)](https://mozillajp.slack.com/), [GitHub (mozilla-japan)](https://github.com/mozilla-japan/translation), [Google Group (Mozilla.translations.ja)](https://groups.google.com/forum/#!forum/mozilla-translations-ja) | ||
| - Current contributors: [mfuji09](https://github.com/mfuji09), [hmatrjp](https://github.com/hmatrjp), [potappo](https://github.com/potappo), [dynamis](https://github.com/dynamis), [kenji-yamasaki](https://github.com/kenji-yamasaki) | ||
|
|
||
| ### Korea (ko) | ||
|
|
||
| - Discussions: [Kakao Talk (#MDN Korea)](https://open.kakao.com/o/gdfG288c) | ||
| - Current contributors: [hochan222](https://github.com/hochan222), [yechoi42](https://github.com/yechoi42), [cos18](https://github.com/cos18), [GwangYeol-Im](https://github.com/GwangYeol-Im), [pje1740](https://github.com/pje1740), [nKiNk](https://github.com/nKiNk), [yujo11](https://github.com/yujo11) | ||
|
|
||
| ### Russian (ru) | ||
|
|
||
| - Discussions: [Matrix (#mdn-l10n-ru channel)](https://chat.mozilla.org/#/room/#mdn-l10n-ru:mozilla.org) | ||
| - Current contributors: [armanpwnz](https://github.com/armanpwnz), [captainspring](https://github.com/captainspring), [mpstv](https://github.com/mpstv), [myshov](https://github.com/myshov), [Saionaro](https://github.com/Saionaro), [sashasushko](https://github.com/sashasushko), [lex111](https://github.com/lex111) | ||
|
|
||
| ### Spanish (es) | ||
|
|
||
| - Discussions: [Matrix (#mdn-l10n-es channel)](https://chat.mozilla.org/#/room/#mdn-l10n-es:mozilla.org) | ||
| - Current maintainers: [@JuanVqz](https://github.com/JuanVqz), [@dacalderonp](https://github.com/dacalderonp), [@lasr21](https://github.com/lasr21), [@tuxxy](https://github.com/tuxxy) | ||
|
|
||
| > **Note:** If you want to discuss unfreezing a currently frozen locale, the [guidelines on what is required can be found here](https://github.com/mdn/translated-content/blob/main/PEERS_GUIDELINES.md#activating-a-locale). | ||
|
|
||
| ## See also | ||
|
|
||
| - [MDN localization update, February 2021](https://hacks.mozilla.org/2021/02/mdn-localization-update-february-2021/) — the latest state of localization on MDN | ||
| - [An update on MDN Web Docs' localization strategy](https://hacks.mozilla.org/2020/12/an-update-on-mdn-web-docs-localization-strategy/) — updated strategy based on community feedback | ||
| - [MDN Web Docs evolves! Lowdown on the upcoming new platform](https://hacks.mozilla.org/2020/10/mdn-web-docs-evolves-lowdown-on-the-upcoming-new-platform/) — more on the advantages of the new platform, and the rationale behind the localization changes. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.