Skip to content

Commit

Permalink
chore: fix mdnsidebars
Browse files Browse the repository at this point in the history
  • Loading branch information
bsmth committed Jan 31, 2025
1 parent f5558a9 commit 4815395
Show file tree
Hide file tree
Showing 72 changed files with 72 additions and 144 deletions.
3 changes: 1 addition & 2 deletions files/en-us/mdn/community/communication_channels/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Communication channels
slug: MDN/Community/Communication_channels
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

There are various communication channels that the community can use to contact MDN Web Docs staff and participate in discussions.

## Chat rooms
Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/community/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Contributing to MDN Web Docs
slug: MDN/Community
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

- [Getting started](/en-US/docs/MDN/Community/Getting_started)
- [Our repositories](/en-US/docs/MDN/Community/Our_repositories)
- [Translated content](/en-US/docs/MDN/Community/Translated_content)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: MDN Web Docs Repositories
slug: MDN/Community/Our_repositories
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{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.

## Repository tiers
Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/community/discussions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: GitHub Discussions
slug: MDN/Community/Discussions
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Managing and resolving discussions
slug: MDN/Community/Discussions/Managing_and_resolving_discussions
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

The MDN community is encouraged to [initiate and engage in discussions](/en-US/docs/MDN/Community/Discussions) related to the MDN Web Docs documentation. Some discussions don't need a resolution or agreement, but if they do, it is natural for those starting the discussion to expect their proposed ideas to reach a logical conclusion. Most of these discussions reach a broad agreement quickly. However, some discussions risk becoming stalled due to an unclear path to a resolution, often because of differing opinions. This document offers guidelines; suggesting processes and strategies to help you move toward a resolution within a reasonable timeframe without the conversation getting stalled.

## Moving a discussion to a resolution
Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/community/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: Getting started with MDN Web Docs
short-title: Getting started
slug: MDN/Community/Getting_started
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{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 has an impact on millions of readers.
Learn how to contribute and drive innovation on the Open Web.
Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: Community resources
short-title: Resources
slug: MDN/Community
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Proposing new content or features
slug: MDN/Community/Issues/Content_suggestions_feature_proposals
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{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 be unable to maintain them long-term.
Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/community/issues/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Creating and working on issues
slug: MDN/Community/Issues
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

As a contributor, you can [report](#guidelines_for_reporting_an_issue) and [work](#guidelines_for_working_on_an_issue) on issues.
After you report an issue, the issue gets triaged. Issue [triaging](#guidelines_for_triaging_issues) is typically done by people assigned the role of a maintainer or an owner.

Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/community/learn_forum/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Learn forum
slug: MDN/Community/Learn_forum
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

Our [Learn web development](/en-US/docs/Learn_web_development) pages get over a million views per month, and has an [active forum](https://discourse.mozilla.org/c/mdn/learn/250) where people go to ask for assistance.
We'd love some help with answering posts, and growing our learning community.

Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/community/open_source_etiquette/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Open source etiquette
slug: MDN/Community/Open_source_etiquette
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{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 and other open source projects.
There are a few behaviors to adopt that will help 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 is to cover foundational topics for taking part in open source communities.
Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/community/our_repositories/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: MDN GitHub repositories
short-title: GitHub repositories
slug: MDN/Community/Our_repositories
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

MDN Web Docs is a complex project with lots of moving parts.
It's a good idea to get familiar with the different code repositories.
This document describes the repositories (repos) you may need when contributing to MDN Web Docs.
Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/community/pull_requests/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Pull request submission and reviews
slug: MDN/Community/Pull_requests
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

This document describes how contributors make changes to MDN Web Docs and how the changes are reviewed and land on the site.
Content changes to MDN Web Docs include:

Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/community/roles_teams/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: MDN Web Docs roles and teams
short-title: Roles and teams
slug: MDN/Community/Roles_teams
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

The success and growth of the MDN Web Docs project is, in large part, due to our community of contributors. Some contributors have committed a portion of their time to assist with the daily tasks of running MDN Web Docs. Changes to the site, including maintenance tasks, are performed by employees, contractors, and a network of partners who are all dedicated to the health, growth, and maintenance of MDN Web Docs. The project relies heavily on [roles](#roles) and [teams](#teams) in the [MDN organization on GitHub](https://github.com/mdn) to manage and incorporate changes from these different groups. A list of the organization's current members can be found at [github.com/orgs/mdn](https://github.com/orgs/mdn/people).

Community contributions help this open source project immensely.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Security vulnerability response steps
slug: MDN/Community/Security_vulnerability_response
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

## 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.
Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/community/translated_content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: MDN Web Docs localization
short-title: Localization
slug: MDN/Community/Translated_content
page-type: mdn-community-guide
sidebar: mdnsidebar
---

{{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-English locales, and we want to manage it better in the future.

We have archived all locales, **except** for the ones listed below, meaning that they are read-only on GitHub and cannot be viewed on MDN. The active locales have dedicated teams taking responsibility for maintaining them.
Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: MDN Web Docs
slug: MDN
page-type: landing-page
sidebar: mdnsidebar
---

{{MDNSidebar}}

**MDN Web Docs** is a free-to-use resource that documents open web technologies.
Our mission is to provide developers with the information they need to easily build projects on the web platform.
The resources below describe how the site works, how we write documentation, the guidelines and conventions we follow, and how you can get involved.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Attribution and copyright licensing
slug: MDN/Writing_guidelines/Attrib_copyright_license
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

MDN Web Docs content is available free of charge and is available under various open-source licenses.

## Using MDN Web Docs content
Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/writing_guidelines/changelog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: MDN Web Docs changelog
slug: MDN/Writing_guidelines/Changelog
page-type: guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

This document provides a record of MDN content processes, constructs, and best practices that have changed, and when they changed. It is useful to allow regular contributors to check in and see what has changed about the process of creating content for MDN.

## October 2022
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Experimental, deprecated, and obsolete
slug: MDN/Writing_guidelines/Experimental_deprecated_obsolete
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

These terms are commonly associated with technologies and specifications and are used on MDN Web Docs to label the status of a technology. For the definition of these terms, MDN Web Docs align with the [Browser Compatibility Data (BCD)](https://github.com/mdn/browser-compat-data/blob/main/schemas/compat-data-schema.md#status-information) repository.
These terms are described below in the context of their use on MDN Web Docs.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: How to create, edit, move, or delete pages
short-title: Create, edit, move, or delete pages
slug: MDN/Writing_guidelines/Howto/Creating_moving_deleting
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

This article describes how to create, move, delete, or edit a page.
In all these instances, it's a good idea to check our guidelines for [What we write](/en-US/docs/MDN/Writing_guidelines/What_we_write) to confirm if any of these actions should be taken and discuss it with the team in one of the MDN Web Docs [communication channels](/en-US/docs/MDN/Community/Communication_channels) before proceeding.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: How to document a CSS property
short-title: Document a CSS property
slug: MDN/Writing_guidelines/Howto/Document_a_CSS_property
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

As the [CSS](/en-US/docs/Web/CSS) standards evolve, new properties are always being added. The [CSS Reference](/en-US/docs/Web/CSS/Reference) on MDN Web Docs needs to be kept up-to-date with these developments. This article provides step-by-step instructions for creating a CSS property reference page.

Each CSS property reference page follows the same structure. This helps readers find information more easily, especially after they are familiar with the standard reference page format.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: How to document an HTTP header
short-title: Document an HTTP header
slug: MDN/Writing_guidelines/Howto/Document_an_HTTP_header
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

The [HTTP headers reference](/en-US/docs/Web/HTTP/Headers) documents the header section of request and response messages in the Hypertext Transfer Protocol ([HTTP](/en-US/docs/Web/HTTP)).
This article explains how to create a new reference page for an HTTP header.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: How to document web errors
short-title: Document errors
slug: MDN/Writing_guidelines/Howto/Document_web_errors
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

The [JavaScript error reference](/en-US/docs/Web/JavaScript/Reference/Errors) on MDN Web Docs is a project to help web developers with errors occurring in the [Developer Console](https://firefox-source-docs.mozilla.org/devtools-user/web_console/index.html). For this project, we need to write more error documentation on MDN Web Docs so that we can add more links to the tools where the messages are thrown. This article explains how to document the web errors.

JavaScript errors contain a "Learn more" link that takes you to the JavaScript error reference containing additional advice for fixing issues. To be able to document the web errors, you will need to know or be able to dive into some [JavaScript](/en-US/docs/Web/JavaScript).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: How to add images and media
short-title: Add media
slug: MDN/Writing_guidelines/Howto/Images_media
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

## Adding images

To add an image to a document, add your image file to the document's folder, and then reference the image from within the document's `index.md` file using [Markdown image syntax](https://github.github.com/gfm/#images) or the equivalent HTML `<img>` element.
Expand Down
3 changes: 1 addition & 2 deletions files/en-us/mdn/writing_guidelines/howto/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: How-to guides for MDN contributors
short-title: How-to
slug: MDN/Writing_guidelines/Howto
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

This section of MDN Web Docs writing guidelines contains the step-by-step details for accomplishing specific tasks when contributing to MDN Web Docs: how we use markdown, how we add an entry to the glossary, how we move or delete pages, and more.
To find out about _how to contribute_, see our [contribution guidelines](/en-US/docs/MDN/Community).
These documents assume that you've read the contribution guidelines, are familiar with the `mdn/content` repository, and know how to use git and GitHub.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: How to use structured data
short-title: Use structured data
slug: MDN/Writing_guidelines/Howto/JSON_Structured_data
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

MDN stores data in well-defined structures when possible. This information is then centralized and can be updated once, while being used in numerous places.

There are several such files, and this document describes their purpose, structure, and maintenance process.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: How to write in Markdown
short-title: Write in Markdown
slug: MDN/Writing_guidelines/Howto/Markdown_in_MDN
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

This page describes how we use Markdown to write documentation on MDN Web Docs. We have chosen GitHub-Flavored Markdown (GFM) as a baseline, and added some extensions to support some of the things we need to do on MDN that aren't readily supported in GFM.

## Baseline: GitHub-Flavored Markdown
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: How to research a technology
short-title: Research a technology
slug: MDN/Writing_guidelines/Howto/Research_technology
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

This article gives you some handy information about approaching how to document technologies.

## Doing the prep work
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: How to add a glossary entry
short-title: Add a glossary entry
slug: MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

This article explains how to add and link to entries in the [MDN Web Docs glossary](/en-US/docs/Glossary).
It also provides guidelines about glossary entry layout and content.
The glossary provides definitions for all the terms, jargon, abbreviations, and acronyms you'll come across when reading MDN content about the web and web development.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: How to write an API reference
short-title: Write an API reference
slug: MDN/Writing_guidelines/Howto/Write_an_api_reference
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

This guide takes you through all you need to know to write an API reference on MDN.

## Getting prepared
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Information contained in a WebIDL file
slug: MDN/Writing_guidelines/Howto/Write_an_api_reference/Information_contained_in_a_WebIDL_file
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

When writing documentation about an API, the sources of information are many: the specifications describe what should be implemented as well as the model, and the implementations describe what has actually been put in the browsers. WebIDL files are a very condensed way of giving a lot, but not all, of the information about the API. This document provides a reference to help understand WebIDL syntax.

IDL stands for **_Interface Definition Language_** and it is designed to describe APIs. In the wider world of computing there are several kinds of IDL. In the world of browsers, the IDL we use is called _WebIDL_. Two kinds of WebIDL are available: the one given in the WebIDL spec, and the one implemented in browsers. The spec is the canonical reference, and the browser WebIDL describes what is actually implemented in a particular browser, and contains additional things such as annotations, information about non-standard elements, and browser-specific extensions to the IDL specification.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: API reference sidebars
slug: MDN/Writing_guidelines/Howto/Write_an_api_reference/Sidebars
page-type: mdn-writing-guide
sidebar: mdnsidebar
---

{{MDNSidebar}}

You are able to include a custom sidebar on API reference pages it so that it displays links to related Interfaces, tutorials, and other resources relevant just to that API.
This article explains how.

Expand Down
Loading

0 comments on commit 4815395

Please sign in to comment.