Skip to content

Commit

Permalink
chore: meta docs tidy
Browse files Browse the repository at this point in the history
  • Loading branch information
bsmth committed Jan 3, 2025
1 parent 7950cb0 commit b2877a7
Show file tree
Hide file tree
Showing 19 changed files with 47 additions and 58 deletions.
Binary file not shown.
Binary file removed files/en-us/mdn/at_ten/history_of_mdn/a2sheppy.png
Binary file not shown.
Binary file not shown.
Binary file removed files/en-us/mdn/at_ten/history_of_mdn/darkwing.png
Binary file not shown.
Binary file removed files/en-us/mdn/at_ten/history_of_mdn/devedge.png
Binary file not shown.
Binary file removed files/en-us/mdn/at_ten/history_of_mdn/elchi3.jpg
Binary file not shown.
Binary file removed files/en-us/mdn/at_ten/history_of_mdn/ensemble.png
Binary file not shown.
Binary file not shown.
Binary file removed files/en-us/mdn/at_ten/history_of_mdn/hoosteeno.jpg
Binary file not shown.
Binary file removed files/en-us/mdn/at_ten/history_of_mdn/iyqi3qpv.jpg
Binary file not shown.
Binary file removed files/en-us/mdn/at_ten/history_of_mdn/jeremiepat.jpg
Binary file not shown.
Binary file not shown.
Binary file removed files/en-us/mdn/at_ten/history_of_mdn/kuma.png
Binary file not shown.
Binary file removed files/en-us/mdn/at_ten/history_of_mdn/mediawiki.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed files/en-us/mdn/at_ten/history_of_mdn/yaacgvya.jpg
Binary file not shown.
105 changes: 47 additions & 58 deletions files/en-us/mdn/community/our_repositories/index.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,69 @@
---
title: MDN Web Docs Repositories
title: MDN GitHub repositories
slug: MDN/Community/Our_repositories
page-type: mdn-community-guide
---

{{MDNSidebar}}

[MDN Web Docs](/) 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.
MDN Web Docs is a complex project with lots of moving parts.
It's a good idea to get familiar with the projects different repositories.
This document describes the repositories (repos) you may need when contributing to MDN Web Docs.

## Repository tiers
## Main repositories

### Tier 1
Code in these repositories is core to the MDN Web Docs project:

Code in these repositories is core to the MDN Web Docs project and runs on Mozilla-owned domains.

- [mdn/content](https://github.com/mdn/content)
- [Yari](https://github.com/mdn/yari)
- [rumba](https://github.com/mdn/rumba)
- [content](https://github.com/mdn/content)
- : This is where all the English content of the site is maintained, and where you'll make all changes to page content, prose, and in-page code examples.
- [yari](https://github.com/mdn/yari)
- : This is the MDN Web Docs platform, where you'll go if you want to make changes to page structures, styles, or rendering machinery.
- [browser-compat-data](https://github.com/mdn/browser-compat-data)
- : Data used to generate the browser compatibility tables found on our reference pages.
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)
- [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).
- [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
- : The example code at the top of many of our reference pages (the code inside the ["Try it" section](/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis)).

These repositories are mainly concentrated on supporting content such as code examples, the MDN Web Docs learn area, localization, and examples projects. Examples include:
### Infrastructure

- [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.
- [bob](https://github.com/mdn/bob)
- : The rendering system that produces the editable, copyable examples found at the top of many of our reference pages.
This project builds the examples from the source code stored in the `interactive-examples` repository.
- [rumba](https://github.com/mdn/rumba)
- : MDN's back-end system that mainly powers MDN Plus.
- [workflows](https://github.com/mdn/workflows)
- : A collection of reusable GitHub Actions for use on MDN Web Docs repositories.

### Tier 3
### Planning and coordination

These are repository used for project planning, documenting the project itself, and community engagement. Examples include:
These are repository used for project planning, documenting the project itself, and community projects.

- [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
- : Project proposals and planning issues are maintained here.
- [mdn-community](https://github.com/mdn/mdn-community)
- : This repository hosts GitHub Discussions when writers and contributors need to decide how to proceed with writing or technical decisions.

[//]: # "TODO: UPDATE WITH REPO TRIAGE"
## Code examples

The MDN Web Docs GitHub org contains a huge number of example repos. These generally contain freestanding code examples that are too big or can not be rendered using the [`EmbedLiveSample`](/en-US/docs/MDN/Writing_guidelines/Page_structures/Live_samples#live_sample_macros) macro. These examples are embedded into the content pages using a macro call like this — `\{{EmbedGHLiveSample("css-examples/learn/tasks/grid/grid1.html", '100%', 700)}}`.
These generally contain standalone code examples that are too big or cannot be rendered using the [`EmbedLiveSample`](/en-US/docs/MDN/Writing_guidelines/Page_structures/Live_samples#live_sample_macros) macro.

Always remember, if you are updating the code on any given page, you'll need to update the corresponding example repo as well.
> [!NOTE]
> If you are updating the code on any given page, check if it's referenced in a corresponding example repo and, if so, make sure you've updated the 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)
- [**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)
- [learning-area](https://github.com/mdn/learning-area)
- [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)
- [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)

0 comments on commit b2877a7

Please sign in to comment.