From 10a7524dd4f7dbfb9597c2274155856a545b2985 Mon Sep 17 00:00:00 2001 From: Chris Mills Date: Mon, 8 Mar 2021 12:28:27 +0000 Subject: [PATCH 1/4] adding doc priorities explainer --- .../documentation_priorities/index.html | 331 ++++++++++++++++++ 1 file changed, 331 insertions(+) create mode 100644 files/en-us/mdn/contribute/documentation_priorities/index.html diff --git a/files/en-us/mdn/contribute/documentation_priorities/index.html b/files/en-us/mdn/contribute/documentation_priorities/index.html new file mode 100644 index 000000000000000..aa944c4c63cff6a --- /dev/null +++ b/files/en-us/mdn/contribute/documentation_priorities/index.html @@ -0,0 +1,331 @@ +--- +title: MDN documentation priority list +slug: MDN/Contribute/Documentation_priorities +tags: + - Best practices + - Community + - MDN + - Documentation + - Priorities +--- +

{{MDNSidebar}}

+ +

This document defines the different priority tiers on MDN, and states what documentation topics exist inside each tier — we are calling them Tier 1 and Tier 2.

+ +

The purpose of this document is two-fold:

+ + + +

Tier 1

+ +

Tier 1 content is the most important content on MDN — it has the most users, and is deemed to cover the most important technologies for the web platform.

+ + + +

Tier 2

+ +

Tier 2 content is less commonly-used, but useful nonetheless.

+ + + +

Other content

+ +

There is other content on MDN that is outside our web platform technology remit — such as archived content and Firefox-specific docs (e.g. DevTools, platform internals). This content has been deprioritised completely, and in most cases we are trying to find new homes for it, or delete it if it is no longer useful. We would not recommend that our community spends any time working on any areas not specifically listed on this page.

+ +

Tier 1 WebAPIs

+ +

The following API interface reference documents (and their child pages) are currently considered Tier 1. For more information on the rationale for these groupings and priorities, see the work done in https://github.com/mdn/sprints/issues/3327.

+ +

Canvas API

+ + + +

Clipboard API

+ + + +

DOM

+ + + +

DOM Events

+ + + +

Fetch API

+ + + +

File API

+ + + +

HTML DOM

+ + + +

URL API

+ + + +

Web Storage API

+ + + +

WebSockets API

+ + + +

XMLHttpRequest

+ + From a751f5b47a366fadd9a9480cbc93eb0db930e29a Mon Sep 17 00:00:00 2001 From: Chris Mills Date: Tue, 9 Mar 2021 18:05:40 +0000 Subject: [PATCH 2/4] updates based on wbamberg feedback --- .../documentation_priorities/index.html | 153 +++--------------- 1 file changed, 20 insertions(+), 133 deletions(-) diff --git a/files/en-us/mdn/contribute/documentation_priorities/index.html b/files/en-us/mdn/contribute/documentation_priorities/index.html index aa944c4c63cff6a..4322d265b9f6026 100644 --- a/files/en-us/mdn/contribute/documentation_priorities/index.html +++ b/files/en-us/mdn/contribute/documentation_priorities/index.html @@ -19,6 +19,10 @@
  • To help contributors that want to work on a specific topic area rather than a specific bug decide which one would be most useful to give their time to (for example, folks that like to run automated cleanup scripts on MDN).
    • +

    The relative importance of these docs has been decided purely by looking at page view figures. There are lots of measures we could have used, but page views is objective and still a good indicator — more important web technologies are looked up more often, and therefore fixing problems with those docs seems most critical.

    + +

    Also bear in mind that these Tiers are made up of isolated document trees (i.e. the linked page, plus all of the documents in the hierarchy below it). Sometimes a Tier 1 document will link to a Tier 2 document, or vice versa, and that is OK.

    +

    Tier 1

    Tier 1 content is the most important content on MDN — it has the most users, and is deemed to cover the most important technologies for the web platform.

    @@ -67,15 +71,9 @@

    Tier 2

  • The MDN Web Docs glossary
  • MDN meta-documentation
    • (this is important, but fixes would be mainly dealt with by the MDN core team)
  • WebExtensions
    • (not really web platform, but still important) -
  • Related
    • -
  • EXSLT
  • MathML
  • SVG
  • WebAPIs that aren't in the "Tier 1 WebAPIs" list
    • -
  • WebDriver
    • -
  • XML
    • -
  • XPath
    • -
  • XSLT

    • Other content

    @@ -112,6 +110,11 @@

    Clipboard API

    DOM

    +
    +

    Note

    +

    "DOM" is only a partial group — we only included the interface docs with the highest page views, to keep the size of Tier 1 down to a manageable number. Other DOM interfaces not in this list are in Tier 2.

    +
    +

    DOM Events

    +
    +

    Note

    +

    "DOM Events" is only a partial group — we only included the interface docs with the highest page views, to keep the size of Tier 1 down to a manageable number. Other DOM Events interfaces not in this list are in Tier 2.

    +
    +

    Fetch API

    @@ -199,10 +160,16 @@

    File API

  • File
  • FileList
  • FileReader
    • +
  • FileReaderSync

    • HTML DOM

    +
    +

    Note

    +

    "HTML DOM" is only a partial group — we only included the interface docs with the highest page views, to keep the size of Tier 1 down to a manageable number. Other HTML DOM interfaces not in this list are in Tier 2.

    +
    +

    URL API

    From c6940babc9af50c395f7f7ed5ce2d0709ebdc75a Mon Sep 17 00:00:00 2001 From: Chris Mills Date: Tue, 9 Mar 2021 19:30:41 +0000 Subject: [PATCH 3/4] add numbers of documents in each tree/tier --- .../documentation_priorities/index.html | 226 +++++++++--------- 1 file changed, 116 insertions(+), 110 deletions(-) diff --git a/files/en-us/mdn/contribute/documentation_priorities/index.html b/files/en-us/mdn/contribute/documentation_priorities/index.html index 4322d265b9f6026..00e4c0bf9117cbe 100644 --- a/files/en-us/mdn/contribute/documentation_priorities/index.html +++ b/files/en-us/mdn/contribute/documentation_priorities/index.html @@ -23,59 +23,65 @@

    Also bear in mind that these Tiers are made up of isolated document trees (i.e. the linked page, plus all of the documents in the hierarchy below it). Sometimes a Tier 1 document will link to a Tier 2 document, or vice versa, and that is OK.

    +

    The numbers in parentheses after each document tree represent the number of documents under that tree. These numbers will likely change over time, so may need revisiting before too long.

    +

    Tier 1

    Tier 1 content is the most important content on MDN — it has the most users, and is deemed to cover the most important technologies for the web platform.

    +

    Total Tier 1 pages: 4206

    +

    Tier 2

    Tier 2 content is less commonly-used, but useful nonetheless.

    +

    Total Tier 2 pages: 6446

    +

    Other content

    There is other content on MDN that is outside our web platform technology remit — such as archived content and Firefox-specific docs (e.g. DevTools, platform internals). This content has been deprioritised completely, and in most cases we are trying to find new homes for it, or delete it if it is no longer useful. We would not recommend that our community spends any time working on any areas not specifically listed on this page.

    @@ -84,31 +90,31 @@

    Tier 1 WebAPIs

    The following API interface reference documents (and their child pages) are currently considered Tier 1. For more information on the rationale for these groupings and priorities, see the work done in https://github.com/mdn/sprints/issues/3327.

    -

    Canvas API

    +

    Canvas API (112)

    -

    Clipboard API

    +

    Clipboard API (13)

    -

    DOM

    +

    DOM (439)

    Note

    @@ -116,23 +122,23 @@

    Note

    -

    DOM Events

    +

    DOM Events (22)

    Note

    @@ -140,30 +146,30 @@

    Note

    -

    Fetch API

    +

    Fetch API (47)

    -

    File API

    +

    File API (48)

    -

    HTML DOM

    +

    HTML DOM (371)

    Note

    @@ -171,48 +177,48 @@

    Note

    -

    URL API

    +

    URL API (43)

    -

    Web Storage API

    +

    Web Storage API (8)

    -

    WebSockets API

    +

    WebSockets API (28)

    -

    XMLHttpRequest

    +

    XMLHttpRequest (58)

    From d08382532932999e1e758dcc7e04bce5eb700bdf Mon Sep 17 00:00:00 2001 From: Chris Mills Date: Wed, 10 Mar 2021 07:57:10 +0000 Subject: [PATCH 4/4] alphabetize all the things --- .../documentation_priorities/index.html | 88 +++++++++---------- files/en-us/mdn/contribute/index.html | 7 ++ 2 files changed, 51 insertions(+), 44 deletions(-) diff --git a/files/en-us/mdn/contribute/documentation_priorities/index.html b/files/en-us/mdn/contribute/documentation_priorities/index.html index 00e4c0bf9117cbe..eca77a79ed7f611 100644 --- a/files/en-us/mdn/contribute/documentation_priorities/index.html +++ b/files/en-us/mdn/contribute/documentation_priorities/index.html @@ -30,9 +30,18 @@

    Tier 1

    Tier 1 content is the most important content on MDN — it has the most users, and is deemed to cover the most important technologies for the web platform.

    -

    Total Tier 1 pages: 4206

    +

    Total Tier 1 pages: 4150

    Tier 2

    Tier 2 content is less commonly-used, but useful nonetheless.

    -

    Total Tier 2 pages: 6446

    +

    Total Tier 2 pages: 6502

    Other content

    @@ -93,15 +93,15 @@

    Tier 1 WebAPIs

    Canvas API (112)

    @@ -122,20 +122,20 @@

    Note

    DOM Events (22)

    @@ -154,9 +154,9 @@

    Fetch API (47)

    File API (48)

    @@ -178,25 +178,25 @@

    Note

    URL API (43)

    @@ -210,9 +210,9 @@

    Web Storage API (8)

    WebSockets API (28)

    XMLHttpRequest (58)

    diff --git a/files/en-us/mdn/contribute/index.html b/files/en-us/mdn/contribute/index.html index 30902b91fcb2360..dd2320370e504f5 100644 --- a/files/en-us/mdn/contribute/index.html +++ b/files/en-us/mdn/contribute/index.html @@ -70,6 +70,13 @@

    Primary contribution types

    We will add more tasks here as time goes on.

    +

    Priority ratings

    + +

    You can also look at priority ratings to give you an idea of what the most important work is to work on — we've started giving content bug issues labels of P0, P1, P2, P3, and P4 to signify how important they are, with lower numbers being more important than higher numbers.

    + +

    These are figured out during the regular MDN bug triage process, based on the MDN documentation priority list.

    + +

    Other task types

    If our main priorities listed above don't interest you, you can find a number of other, more general task types to get involved with below, split up by skillset.