diff --git a/files/en-us/_redirects.txt b/files/en-us/_redirects.txt index fd35d75c2334fdd..571a6092341d4bf 100644 --- a/files/en-us/_redirects.txt +++ b/files/en-us/_redirects.txt @@ -2676,7 +2676,7 @@ /en-US/docs/Detecting_device_orientation /en-US/docs/Web/API/Device_orientation_events/Detecting_device_orientation /en-US/docs/Determining_the_dimensions_of_elements /en-US/docs/Web/API/CSS_Object_Model/Determining_the_dimensions_of_elements /en-US/docs/DeviceAcceleration /en-US/docs/Web/API/DeviceMotionEventAcceleration -/en-US/docs/Devmo:How_to_Help /en-US/docs/MDN/Community/Contributing/Getting_started +/en-US/docs/Devmo:How_to_Help /en-US/docs/MDN/Community/Getting_started /en-US/docs/Distribution_options https://extensionworkshop.com/documentation/publish/signing-and-distribution-overview/ /en-US/docs/Distribution_options/Add-ons_for_desktop_apps https://extensionworkshop.com/documentation/publish/distribute-for-desktop-apps/ /en-US/docs/Distribution_options/Add-ons_in_the_enterprise https://extensionworkshop.com/documentation/enterprise/ @@ -3543,7 +3543,7 @@ /en-US/docs/Games/Workflows/Touch_Event_Horizon /en-US/docs/Games/Tutorials /en-US/docs/Games/visual_typescript_game_engine /en-US/docs/Games /en-US/docs/Getting_Started_With_NSS https://firefox-source-docs.mozilla.org/security/nss/index.html -/en-US/docs/Getting_started_on_MDN /en-US/docs/MDN/Community/Contributing/Getting_started +/en-US/docs/Getting_started_on_MDN /en-US/docs/MDN/Community/Getting_started /en-US/docs/Glossary/404 /en-US/docs/Web/HTTP/Status/404 /en-US/docs/Glossary/502 /en-US/docs/Web/HTTP/Status/502 /en-US/docs/Glossary/AOM /en-US/docs/Glossary/Accessibility_tree @@ -3983,7 +3983,7 @@ /en-US/docs/How_to_Turn_Off_Form_Autocompletion /en-US/docs/Web/Security/Practical_implementation_guides/Turning_off_form_autocompletion /en-US/docs/How_to_check_the_security_state_of_an_XMLHTTPRequest_over_SSL /en-US/docs/Web/API/XMLHttpRequest /en-US/docs/How_to_create_a_DOM_tree /en-US/docs/Web/API/Document_Object_Model/Using_the_Document_Object_Model -/en-US/docs/How_to_start_contributions_to_Mozilla /en-US/docs/MDN/Community/Contributing/Getting_started +/en-US/docs/How_to_start_contributions_to_Mozilla /en-US/docs/MDN/Community/Getting_started /en-US/docs/ICC_color_correction_in_Firefox /en-US/docs/Mozilla/Firefox/Releases/3.5/ICC_color_correction_in_Firefox /en-US/docs/IMAP /en-US/docs/Glossary/IMAP /en-US/docs/IPv6 /en-US/docs/Glossary/IPv6 @@ -5788,14 +5788,20 @@ /en-US/docs/Localization /en-US/docs/Glossary/Localization /en-US/docs/MDC:How_to_Help /en-US/docs/MDN/Community/Contributing /en-US/docs/MDN/About /en-US/docs/MDN/Writing_guidelines +/en-US/docs/MDN/At_ten https://developer.mozilla.org/en-US/about#our_journey /en-US/docs/MDN/At_ten/Contributing_to_MDN /en-US/docs/MDN/Community/Contributing +/en-US/docs/MDN/At_ten/History_of_MDN https://developer.mozilla.org/en-US/about#our_journey +/en-US/docs/MDN/Changelog /en-US/docs/MDN/Writing_guidelines/Changelog +/en-US/docs/MDN/Community/Contributing/Getting_started /en-US/docs/MDN/Community/Getting_started +/en-US/docs/MDN/Community/Contributing/Security_vulnerability_response /en-US/docs/MDN/Community/Security_vulnerability_response +/en-US/docs/MDN/Community/Contributing/Translated_content /en-US/docs/MDN/Community/Translated_content /en-US/docs/MDN/Community/Issues/Issue_triage /en-US/docs/MDN/Community/Issues /en-US/docs/MDN/Community/MDN_content /en-US/docs/MDN/Community/Contributing /en-US/docs/MDN/Community/MDN_content/Issues /en-US/docs/MDN/Community/Issues /en-US/docs/MDN/Community/MDN_content/Pull_requests /en-US/docs/MDN/Community/Pull_requests /en-US/docs/MDN/Community/Users_teams /en-US/docs/MDN/Community/Roles_teams /en-US/docs/MDN/Contribute /en-US/docs/MDN/Community/Contributing -/en-US/docs/MDN/Contribute/Changelog /en-US/docs/MDN/Changelog +/en-US/docs/MDN/Contribute/Changelog /en-US/docs/MDN/Writing_guidelines/Changelog /en-US/docs/MDN/Contribute/Code_sample_guidelines /en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide /en-US/docs/MDN/Contribute/Content /en-US/docs/MDN/Writing_guidelines /en-US/docs/MDN/Contribute/Content/Content_blocks /en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN @@ -5813,8 +5819,8 @@ /en-US/docs/MDN/Contribute/FAQ /en-US/docs/MDN/Community/Contributing /en-US/docs/MDN/Contribute/Feedback /en-US/docs/MDN/Community /en-US/docs/MDN/Contribute/Fixing_MDN_content_bugs /en-US/docs/MDN/Community/Contributing -/en-US/docs/MDN/Contribute/Getting_started /en-US/docs/MDN/Community/Contributing/Getting_started -/en-US/docs/MDN/Contribute/GitHub_beginners /en-US/docs/MDN/Community/Contributing/Getting_started +/en-US/docs/MDN/Contribute/Getting_started /en-US/docs/MDN/Community/Getting_started +/en-US/docs/MDN/Contribute/GitHub_beginners /en-US/docs/MDN/Community/Getting_started /en-US/docs/MDN/Contribute/GitHub_best_practices /en-US/docs/MDN/Community/Issues /en-US/docs/MDN/Contribute/GitHub_cheatsheet /en-US/docs/MDN/Community/Issues /en-US/docs/MDN/Contribute/Guidelines /en-US/docs/MDN/Writing_guidelines @@ -5864,7 +5870,7 @@ /en-US/docs/MDN/Contribute/Howto/Write_an_API_reference/Information_contained_in_a_WebIDL_file /en-US/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/Information_contained_in_a_WebIDL_file /en-US/docs/MDN/Contribute/Howto/Write_an_API_reference/Sidebars /en-US/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/Sidebars /en-US/docs/MDN/Contribute/Howto/Write_for_SEO /en-US/docs/MDN/Writing_guidelines/Writing_style_guide -/en-US/docs/MDN/Contribute/Localize /en-US/docs/MDN/Community/Contributing/Translated_content +/en-US/docs/MDN/Contribute/Localize /en-US/docs/MDN/Community/Translated_content /en-US/docs/MDN/Contribute/Markdown_in_MDN /en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN /en-US/docs/MDN/Contribute/Open_source_etiquette /en-US/docs/MDN/Community/Open_source_etiquette /en-US/docs/MDN/Contribute/Processes /en-US/docs/MDN/Community/Contributing @@ -5914,16 +5920,16 @@ /en-US/docs/MDN/Contribute/Style_guide/Quicklinks /en-US/docs/MDN/Writing_guidelines/Page_structures/Sidebars /en-US/docs/MDN/Contribute/Style_guide/Specification_tables /en-US/docs/MDN/Writing_guidelines/Page_structures/Specification_tables /en-US/docs/MDN/Contribute/Tagging /en-US/docs/MDN/Writing_guidelines/Howto -/en-US/docs/MDN/Contribute/Tasks /en-US/docs/MDN/Community/Contributing/Getting_started +/en-US/docs/MDN/Contribute/Tasks /en-US/docs/MDN/Community/Getting_started /en-US/docs/MDN/Contribute/Tools https://github.com/mdn/yari/tree/main/docs /en-US/docs/MDN/Contribute/Tools/Document_parameters /en-US/docs/MDN /en-US/docs/MDN/Contribute/Tools/KumaScript https://github.com/mdn/yari/tree/main/docs/kumascript /en-US/docs/MDN/Contribute/Tools/KumaScript/Troubleshooting https://github.com/mdn/yari/tree/main/docs/kumascript/troubleshooting-errors.md /en-US/docs/MDN/Contribute/Tools/Sample_server /en-US/docs/MDN -/en-US/docs/MDN/Contribute/Where_is_everything /en-US/docs/MDN/Community/Contributing/Our_repositories +/en-US/docs/MDN/Contribute/Where_is_everything /en-US/docs/MDN/Community/Our_repositories /en-US/docs/MDN/Doc_status/NSPR https://firefox-source-docs.mozilla.org/nspr/index.html /en-US/docs/MDN/Feedback /en-US/docs/MDN/Community -/en-US/docs/MDN/Getting_started /en-US/docs/MDN/Community/Contributing/Getting_started +/en-US/docs/MDN/Getting_started /en-US/docs/MDN/Community/Getting_started /en-US/docs/MDN/Guidelines /en-US/docs/MDN/Writing_guidelines /en-US/docs/MDN/Guidelines/CSS_style_guide /en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN /en-US/docs/MDN/Guidelines/Code_guidelines /en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide @@ -5949,11 +5955,13 @@ /en-US/docs/MDN/Kuma/Introduction_to_KumaScript https://github.com/mdn/yari/tree/main/docs/kumascript /en-US/docs/MDN/Kuma/Tools https://github.com/mdn/yari/tree/main/docs /en-US/docs/MDN/Kuma/Troubleshooting_KumaScript_errors https://github.com/mdn/yari/tree/main/docs/kumascript/troubleshooting-errors.md -/en-US/docs/MDN/MDN_Product_Advisory_Board/Members /en-US/docs/MDN/MDN_Product_Advisory_Board -/en-US/docs/MDN/MDN_Product_Avisory_Board /en-US/docs/MDN/MDN_Product_Advisory_Board -/en-US/docs/MDN/MDN_Product_Avisory_Board/Members /en-US/docs/MDN/MDN_Product_Advisory_Board -/en-US/docs/MDN/MDN_Product_Avisory_Board/Membership /en-US/docs/MDN/MDN_Product_Advisory_Board/Membership -/en-US/docs/MDN/Quick_start /en-US/docs/MDN/Community/Contributing/Getting_started +/en-US/docs/MDN/MDN_Product_Advisory_Board https://developer.mozilla.org/en-US/about#our_partners +/en-US/docs/MDN/MDN_Product_Advisory_Board/Members https://developer.mozilla.org/en-US/about#our_partners +/en-US/docs/MDN/MDN_Product_Advisory_Board/Membership https://developer.mozilla.org/en-US/about#our_partners +/en-US/docs/MDN/MDN_Product_Avisory_Board https://developer.mozilla.org/en-US/about#our_partners +/en-US/docs/MDN/MDN_Product_Avisory_Board/Members https://developer.mozilla.org/en-US/about#our_partners +/en-US/docs/MDN/MDN_Product_Avisory_Board/Membership https://developer.mozilla.org/en-US/about#our_partners +/en-US/docs/MDN/Quick_start /en-US/docs/MDN/Community/Getting_started /en-US/docs/MDN/Structures /en-US/docs/MDN/Writing_guidelines/Page_structures /en-US/docs/MDN/Structures/:-ms-input-placeholder_pseudo-class /en-US/docs/Web/CSS/:placeholder-shown /en-US/docs/MDN/Structures/API_references/API_reference_sidebars /en-US/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference/Sidebars @@ -5996,10 +6004,10 @@ /en-US/docs/MDN/Writing_guidelines/Research_technology /en-US/docs/MDN/Writing_guidelines/Howto/Research_technology /en-US/docs/MDN/Writing_guidelines/What_we_write/Inclusion_criteria /en-US/docs/MDN/Writing_guidelines/What_we_write/Criteria_for_inclusion /en-US/docs/MDN/Yari https://github.com/mdn/yari/tree/main/docs -/en-US/docs/MDN_at_ten /en-US/docs/MDN/At_ten +/en-US/docs/MDN_at_ten https://developer.mozilla.org/en-US/about#our_journey /en-US/docs/MDN_at_ten/Contributing_to_MDN /en-US/docs/MDN/Community/Contributing -/en-US/docs/MDN_at_ten/History /en-US/docs/MDN/At_ten/History_of_MDN -/en-US/docs/MDN_at_ten/History_of_MDN /en-US/docs/MDN/At_ten/History_of_MDN +/en-US/docs/MDN_at_ten/History https://developer.mozilla.org/en-US/about#our_journey +/en-US/docs/MDN_at_ten/History_of_MDN https://developer.mozilla.org/en-US/about#our_journey /en-US/docs/Main_page /en-US/ /en-US/docs/Managing_screen_orientation /en-US/docs/Web/API/CSS_Object_Model/Managing_screen_orientation /en-US/docs/Manipulating_video_using_canvas /en-US/docs/Web/API/Canvas_API/Manipulating_video_using_canvas diff --git a/files/en-us/_wikihistory.json b/files/en-us/_wikihistory.json index 1bd39aedcbd63d8..4e5765f17d7a6af 100644 --- a/files/en-us/_wikihistory.json +++ b/files/en-us/_wikihistory.json @@ -11237,54 +11237,6 @@ "ziyunfei" ] }, - "MDN/At_ten": { - "modified": "2020-12-14T11:30:31.427Z", - "contributors": [ - "fscholz", - "nasimrja", - "chandan987", - "stephaniehobson", - "jsx", - "daniellascandles", - "h8erofthem8tixs", - "jswisher", - "chrisdavidmills", - "wkforever", - "Sheppy" - ] - }, - "MDN/At_ten/History_of_MDN": { - "modified": "2020-12-12T07:24:50.578Z", - "contributors": [ - "bershanskiy", - "Sheppy", - "jswisher", - "jwhitlock", - "stephaniehobson", - "groovecoder" - ] - }, - "MDN/MDN_Product_Advisory_Board": { - "modified": "2019-06-05T12:41:23.682Z", - "contributors": [ - "Sheppy", - "wbamberg", - "alispivak", - "stephaniehobson", - "chrisdavidmills", - "KadirTopal" - ] - }, - "MDN/MDN_Product_Advisory_Board/Membership": { - "modified": "2020-08-24T15:00:45.099Z", - "contributors": [ - "chrisdavidmills", - "wbamberg", - "alispivak", - "Sheppy", - "KadirTopal" - ] - }, "MDN/Writing_guidelines/Howto/Document_a_CSS_property": { "modified": "2020-02-18T19:54:27.563Z", "contributors": [ diff --git a/files/en-us/learn_web_development/howto/design_and_accessibility/common_web_layouts/index.md b/files/en-us/learn_web_development/howto/design_and_accessibility/common_web_layouts/index.md index 4713df53059cb35..1fa00696d232d19 100644 --- a/files/en-us/learn_web_development/howto/design_and_accessibility/common_web_layouts/index.md +++ b/files/en-us/learn_web_development/howto/design_and_accessibility/common_web_layouts/index.md @@ -68,7 +68,7 @@ These are rules of thumb you can draw on. There are complex designs and exceptio ## Active learning -_There is no active learning available yet. [Please, consider contributing](/en-US/docs/MDN/Community/Contributing/Getting_started)._ +_There is no active learning available yet. [Please, consider contributing](/en-US/docs/MDN/Community/Getting_started)._ ## Deeper dive diff --git a/files/en-us/learn_web_development/howto/design_and_accessibility/design_for_all_types_of_users/index.md b/files/en-us/learn_web_development/howto/design_and_accessibility/design_for_all_types_of_users/index.md index 6c9144167128e51..d27822f7a10804d 100644 --- a/files/en-us/learn_web_development/howto/design_and_accessibility/design_for_all_types_of_users/index.md +++ b/files/en-us/learn_web_development/howto/design_and_accessibility/design_for_all_types_of_users/index.md @@ -36,7 +36,7 @@ When you're building a website, one top issue to consider is [Universal Design]( ## Active Learning -_There is no active learning available yet. [Please, consider contributing](/en-US/docs/MDN/Community/Contributing/Getting_started)._ +_There is no active learning available yet. [Please, consider contributing](/en-US/docs/MDN/Community/Getting_started)._ ## Dig deeper diff --git a/files/en-us/learn_web_development/howto/design_and_accessibility/thinking_before_coding/index.md b/files/en-us/learn_web_development/howto/design_and_accessibility/thinking_before_coding/index.md index 49a501dc93f34b7..2d0c134d1212317 100644 --- a/files/en-us/learn_web_development/howto/design_and_accessibility/thinking_before_coding/index.md +++ b/files/en-us/learn_web_development/howto/design_and_accessibility/thinking_before_coding/index.md @@ -35,7 +35,7 @@ All of this is called _project ideation_ and is a necessary first step to reach ## Active Learning -_There is no active learning available yet. [Please, consider contributing](/en-US/docs/MDN/Community/Contributing/Getting_started)._ +_There is no active learning available yet. [Please, consider contributing](/en-US/docs/MDN/Community/Getting_started)._ ## Deeper dive diff --git a/files/en-us/learn_web_development/howto/design_and_accessibility/what_is_accessibility/index.md b/files/en-us/learn_web_development/howto/design_and_accessibility/what_is_accessibility/index.md index 0f246166cf6ca72..0b404a6aa3ef8b4 100644 --- a/files/en-us/learn_web_development/howto/design_and_accessibility/what_is_accessibility/index.md +++ b/files/en-us/learn_web_development/howto/design_and_accessibility/what_is_accessibility/index.md @@ -27,7 +27,7 @@ Because of physical or technical limitations, maybe your visitors can't experien ## Active learning -_There is no active learning available yet. [Please, consider contributing](/en-US/docs/MDN/Community/Contributing/Getting_started)._ +_There is no active learning available yet. [Please, consider contributing](/en-US/docs/MDN/Community/Getting_started)._ ## Dig deeper diff --git a/files/en-us/learn_web_development/howto/tools_and_setup/checking_that_your_web_site_is_working_properly/index.md b/files/en-us/learn_web_development/howto/tools_and_setup/checking_that_your_web_site_is_working_properly/index.md index 6b004f5bdff8f2f..568937a479234cd 100644 --- a/files/en-us/learn_web_development/howto/tools_and_setup/checking_that_your_web_site_is_working_properly/index.md +++ b/files/en-us/learn_web_development/howto/tools_and_setup/checking_that_your_web_site_is_working_properly/index.md @@ -38,7 +38,7 @@ Let's see how to diagnose and solve those problems. ## Active Learning -_There is no active learning available yet. [Please, consider contributing](/en-US/docs/MDN/Community/Contributing/Getting_started)._ +_There is no active learning available yet. [Please, consider contributing](/en-US/docs/MDN/Community/Getting_started)._ ## Dig deeper diff --git a/files/en-us/learn_web_development/howto/tools_and_setup/what_software_do_i_need/index.md b/files/en-us/learn_web_development/howto/tools_and_setup/what_software_do_i_need/index.md index 02abe208b77145c..9855860d15e5d3b 100644 --- a/files/en-us/learn_web_development/howto/tools_and_setup/what_software_do_i_need/index.md +++ b/files/en-us/learn_web_development/howto/tools_and_setup/what_software_do_i_need/index.md @@ -45,7 +45,7 @@ Nearly all operating systems by default include a text editor and a browser, whi ## Active Learning -_There is no active learning available yet. [Please, consider contributing](/en-US/docs/MDN/Community/Contributing/Getting_started)._ +_There is no active learning available yet. [Please, consider contributing](/en-US/docs/MDN/Community/Getting_started)._ ## Dig deeper diff --git a/files/en-us/learn_web_development/index.md b/files/en-us/learn_web_development/index.md index 3b4884719f7cfa4..6504acf1e3ceedf 100644 --- a/files/en-us/learn_web_development/index.md +++ b/files/en-us/learn_web_development/index.md @@ -43,7 +43,7 @@ The code examples you'll encounter in the Learning Area are all [available on Gi If you want to get in touch with us about anything, use the [communication channels](/en-US/docs/MDN/Community/Communication_channels). We'd love to hear from you about anything you think is wrong or missing on the site, requests for new learning topics, requests for help with items you don't understand, or any other questions or concerns. -If you're interested in helping develop/improve the content, take a look at [how you can help](/en-US/docs/MDN/Community/Contributing) and get in touch! We are more than happy to talk to you, whether you are a learner, teacher, experienced web developer, or someone else interested in helping to improve the learning experience. +If you're interested in helping develop/improve the content, take a look at [how you can help](/en-US/docs/MDN/Community) and get in touch! We are more than happy to talk to you, whether you are a learner, teacher, experienced web developer, or someone else interested in helping to improve the learning experience. ## See also diff --git a/files/en-us/mdn/at_ten/history_of_mdn/11073502_781006205281080_8135317797319228200_o-600x400.jpg b/files/en-us/mdn/at_ten/history_of_mdn/11073502_781006205281080_8135317797319228200_o-600x400.jpg deleted file mode 100644 index cef1ed09c193dd2..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/11073502_781006205281080_8135317797319228200_o-600x400.jpg and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/a2sheppy.png b/files/en-us/mdn/at_ten/history_of_mdn/a2sheppy.png deleted file mode 100644 index 32b93537e71b951..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/a2sheppy.png and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/birajkarmakar.png b/files/en-us/mdn/at_ten/history_of_mdn/birajkarmakar.png deleted file mode 100644 index 53f38c638dc61a9..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/birajkarmakar.png and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/darkwing.png b/files/en-us/mdn/at_ten/history_of_mdn/darkwing.png deleted file mode 100644 index 4fcc6bf8cc96a60..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/darkwing.png and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/devedge.png b/files/en-us/mdn/at_ten/history_of_mdn/devedge.png deleted file mode 100644 index 01e8f58e5e32ca8..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/devedge.png and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/elchi3.jpg b/files/en-us/mdn/at_ten/history_of_mdn/elchi3.jpg deleted file mode 100644 index 1d5543afdef2ff2..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/elchi3.jpg and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/ensemble.png b/files/en-us/mdn/at_ten/history_of_mdn/ensemble.png deleted file mode 100644 index f12c96a315e341c..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/ensemble.png and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/groovecoder.png b/files/en-us/mdn/at_ten/history_of_mdn/groovecoder.png deleted file mode 100644 index e70b37fa9533a81..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/groovecoder.png and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/hoosteeno.jpg b/files/en-us/mdn/at_ten/history_of_mdn/hoosteeno.jpg deleted file mode 100644 index 7c94f1b5d934cba..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/hoosteeno.jpg and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/index.md b/files/en-us/mdn/at_ten/history_of_mdn/index.md deleted file mode 100644 index 6717fa1a441443c..000000000000000 --- a/files/en-us/mdn/at_ten/history_of_mdn/index.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -title: The history of MDN -slug: MDN/At_ten/History_of_MDN -page-type: guide ---- - -{{MDNSidebar}} - -In this talk from 2015, several contributors of the MDN project look at the past ten years of [developer.mozilla.org](/), and at the decade to come. You will hear the story of different wiki software migrations, how a documentation community was built, and many more highlights of the history of the site. The group then also talks about current challenges and projects the MDN community is working on this year. - -
- -{{ EmbedLiveSample('audio', '100%', '70px') }} - -![The Berlin Office](11073502_781006205281080_8135317797319228200_o-600x400.jpg) - -The [2015 Berlin "Hack on MDN"](https://blog.mozilla.org/community/2015/04/17/a-highly-productive-hack-on-mdn-weekend-in-berlin/), where this talk was recorded. - -## Topics - -Here's an overview of what was discussed, with timestamps and some additional details: - -### What is MDN and who is it for?
A place for the Open Web community - -Time: _0:00:00 - 0:07:15_ - -MDN provides useful information for Web technologies, and encourages learning, sharing, and teaching in the open Web community. On MDN, you come together and make things for yourself and for others. - -MDN is also a place for Mozilla engineers, such as Gecko or Firefox hackers, add-on developers, and Firefox OS contributors. - -### The history of MDN: Pre-wiki era – Netscape DevEdge - -Time: _0:07:15 - 0:08:17_ - -In the early days there was _DevEdge_, the developer documentation from Netscape which formed the basis of some of MDN's documentation. Have a look at the past on [archive.org](https://web.archive.org/web/20020819120942/http://devedge.netscape.com/): - -[![Netscape DevEdge](devedge.png)](https://web.archive.org/web/20020819120942/http://devedge.netscape.com/) - -On October 12, 2004, this popular developer website was shut down by AOL, Netscape's parent company. Only a few months later, in February 2005, [Mitchell Baker](https://blog.lizardwrangler.com/) was able [to rescue DevEdge](https://blog.lizardwrangler.com/2005/02/23/devmo-and-devedge-updates/) and reached an agreement with AOL that allowed Mozilla to post, modify, and create new documents based on the former Netscape DevEdge materials. In other words, what happened to the Mozilla source in 1998 finally happened for Netscape's developer documentation as well: **It became open source**. - -Deb Richardson joined the Mozilla Foundation as a Technical Editor and lead the new _DevMo_ project for community driven developer documentation. - -### MediaWiki
The first wiki engine - -Time: _0:08:17 - 0:14:55_ - -With MediaWiki as the new underlying project platform, the Mozilla developer documentation has been made editable for anyone starting in July 2005. A new collaborative element in Mozilla was established and since then anyone is welcome to help making it better and to share knowledge. A new international community began to grow and to translate developer contents into other languages. - -[![MDC MediaWiki](mediawiki.png)](https://web.archive.org/web/20051226031957/https://developer.mozilla.org/en/docs/Main_Page) - -### DekiWiki
The second wiki engine - -Time: _0:14:55 - 0:26:08_ - -In August 2008, the Mozilla Developer Center switched to [MindTouch DekiWiki](https://sourceforge.net/projects/dekiwiki/), a powerful and new content management system and wiki system for technical documentation. This platform change was quite controversial in the community that was used to MediaWiki from 2005 on and built tools around it. During this phase, we started Doc Sprints to re-engage with the community. - -[![MDC DekiWiki](screenshot_2018-07-24_16.06.55.png)](https://web.archive.org/web/20080907231611/https://developer.mozilla.org/en) - -### Kuma
The third and current wiki engine - -Time: _0:26:08 - 0:31:50_ and _0:43:52 - 0:51:35_ - -[Kuma](https://github.com/mdn/kuma), forked from [Kitsune](https://github.com/mozilla/kitsune) in early 2011 and launched on August 3, 2012, is a Mozilla-built wiki platform based on Django with its own [KumaScript](https://github.com/mdn/yari/tree/main/docs/kumascript) macro system which uses Node.js. - -With the code living on GitHub, the community started to contribute to MDN's CMS as well. From now on, hacking on MDN includes both writing documentation and Kuma coding. - -[![MDN KUMA](kuma.png)](https://web.archive.org/web/20121003233220/https://developer.mozilla.org/en-US/) - -### Redesigning MDN
Kuma with the refreshed design - -Time: _0:31:50 - 0:32:22_ and _0:51:35 - 0:58:05_ - -The redesign of MDN was a big project. [Sean Martell](https://www.seanmartell.com/) designed the new MDN visual identity. It was then an iterative process with a beta user group of 3000 MDNers during several months. The new look was behind a "Waffle flag" (MDN's feature flag system). Major shout-outs also to [David Walsh](https://davidwalsh.name/) who was really championing the entire redesign and gave MDN the front-end that it deserves. - -![Waffle flag](waffle-flag.jpg) - -### Community around Open Web docs
Community-driven, browser-agnostic Open Web documentation - -Time: _0:32:22 - 0:36:55_ - -At some point in 2010, especially when [community members and Technical Writers met in Paris](https://hacks.mozilla.org/2010/10/web-standards-doc-sprint-finis/), it became more obvious that MDN's focus is clearly shifting from "Let's document all things Firefox!" to "Let's document the Web!". Documentation has been cleaned up and restructured over the last few years, so that MDN's open Web documentation is browser-agnostic. This material, useful for anyone developing for the Web, is our most popular and most widely used content. - -Different browser vendors have joined every once in a while to help shape this part of MDN. This cross-browser collaboration has been very successful and is appreciated by MDN's readers. - -### Localization communities
MDN serves a global audience in many languages - -Time: _0:36:55 - 0:43:52_ - -Localization is a big part of the Mozilla community; it is a component of almost every project and product. Using Kuma, MDN is also very localizable and suited for the needs of [our l10n community](/en-US/docs/MDN/Community/Contributing/Translated_content). The W3C specifications and other resources describing the Web's functionality have no direct goals, and have communities that provide specs in multiple languages. Especially for beginners, MDN is the first step to explore web technologies, so it's our aim to be there for everyone. MDN has a broad audience and aims to include not only native English speakers. It is appreciated all around the globe. - -### Learning Area - -Time: _0:58:05 - 1:02:46_ - -The MDN [Learning Area](/en-US/docs/Learn_web_development) is a new effort to teach basic web skills. Over the last 10 years, MDN added a lot of advanced material, serving experts with valuable information. This project is focused on materials for beginners, and tries to fill in a lot of knowledge gaps. - -### The future of MDN
What will be different when we celebrate 20 years of MDN? - -Time: _1:02:46 - 1:11:39_ - -Everyone involved with MDN really cares about the web being open and accessible, and that's why we have the localization teams and all of the people contributing. MDN hopes to continue to be a key player in keeping the Web the way we feel it should be. - -One big part of this future is going to be learning resources. There will be a lot more Web developers over the next ten years. - -Another big part of our job is maintaining and updating the information we already have, so we can always serve relevant content to Web developers. - -What is changing and will likely change more in the future, is how information is consumed. Today people searching for information and looking up documentation. In the future, MDN documentation might be delivered directly in code editors, Firefox Developer Tools, and many other developer tools and services. - -## Speakers - -These are the people who are sharing their memories and thoughts, in the order they appear: - -### Justin Crawford
Product Manager, MDN - -![Justin Crawford](hoosteeno.jpg) - -Justin moderates this talk and makes things with code, words, bike parts, and lumber. He is [@hoosteeno](https://mastodon.social/@hoosteeno) on Mastodon.social. - -### Eric "Sheppy" Shepherd
Technical Writer, MDN - -![Eric Shepherd](a2sheppy.png) - -Sheppy has been here documenting for Mozilla since 2006, and has a lot of history (and crazy ideas) when it comes to MDC and MDN over the years. He is [@sheppy](https://x.com/sheppy) on X. - -### Jérémie Patonnier
Technical Writer, MDN - -![Jérémie Patonnier](jeremiepat.jpg) - -Jérémie is a long time contributor to the Mozilla Developer Network, and a professional web developer since 2000. He's advocating web standards and write documentation about web technologies with the will to make them accessible to everybody. He is [@JeremiePat](https://github.com/JeremiePat) on GitHub. - -### Janet Swisher
Community Manager, MDN - -![Janet Swisher](jmswisher.jpg) - -Janet is a Mozilla Community Manager for Mozilla Developer Network. She joined Mozilla in 2010, and has been involved in open source software since 2004 and in technical communication since the 20th century. She is [@jmswisher](https://mastodon.social/@jmswisher) on Mastodon.social. - -### Stormy Peters - -![Stormy Peters](yaacgvya.jpg) - -You can find Stormy at [StormysCorner.com](https://stormyscorner.com/). - -### Ali Spivak
Herder of awesome MDN cats - -![Ali Spivak](iyqi3qpv.jpg) - -Ali Spivak manages content & community on the Mozilla Developer Network and spends her time thinking of ways to help make the Web even more awesome. She is passionate about maintaining a free and open Web, and, after jumping into open source when she joined Mozilla in 2012, has focused on building and participating in the developer communities at Mozilla. She is [@alispivak](https://x.com/alispivak) on X. - -### Jean-Yves Perrier
Technical Writer, MDN - -![Jean-Yves Perrier](teoli2003.png) - -Jean-Yves has been a Technical Writer on MDN since 2010 and joined Mozilla full-time at the end of 2011. He is passionate about the open Web, with 15 years of C++ experience. He is Swiss but lives in London, UK. His Erdös number is 5 and he is [@teoli2003](https://github.com/teoli2003) on GitHub. - -### Florian Scholz
Technical Writer, MDN - -![Florian Scholz](elchi3.jpg) - -Florian is a Technical Writer at Mozilla focused on open web technologies. He is a wiki gnome, gardening the documentation as if it were flowers, and he likes to work with the community toward the goal of documenting the Web and making it accessible to everyone. Florian is passionate about open source, he is based in Bremen, Germany, and commits as [@Elchi3](https://github.com/Elchi3) on GitHub. - -### David Walsh
Web developer, MDN - -![David Walsh](darkwing.png) - -Mozilla Sr. Web Developer, Front-End Engineer, MooTools Core Developer, JavaScript Fanatic, CSS Tinkerer, PHP Hacker, web and open source lover. David's home on the web is [davidwalsh.name](https://davidwalsh.name/). - -### Luke Crouch
Web developer, MDN - -![Luke Crouch](groovecoder.png) - -Luke Crouch is a home-brewer, soccer fan and web developer for Mozilla. He's been developing on the web since 1996, using Firefox since 2004, writing open source software since 2006, and joined Mozilla as the first staff MDN web dev in 2010. Luke is [@groovecoder](https://github.com/groovecoder) on GitHub. - -### Julien (a.k.a. Sphinx)
French localization, MDN - -![Julien](ensemble.png) - -Julien spent many nights and weekends over several month, translating JavaScript articles into French. He is not a developer, but has a background in IT and wants to learn more about new technologies. He contributes to MDN instead of watching TV. - -### Biraj Karmakar
Mozilla Reps Mentor - -![Biraj Karmakar](birajkarmakar.png) - -Biraj is an Open Source Contributor, interested in the FOSS movement and Localizations. - -## Our awesome contributors - -Many more people have done amazing work on MDN: - -- Les Orchard -- John Karahalis -- David Walsh -- Jannis Leidel -- Stephanie Hobson -- James Bennett -- Isac Lagerblad -- Piotrek Koszuliński -- Craig Cook -- Rob Hudson -- John Whitlock -- … - And many more [Kuma contributors.](https://github.com/mdn/kuma/graphs/contributors) - - - -- Chris Mills -- Will Bamberg -- David Bruant -- Thierry Régagnon -- ethertank -- Saurabh Nair -- Deb Richardson -- Sebastian Zartner -- Tooru Fujisawa -- Karen Scarfone -- Niklas Barning -- … - And hundreds more wiki collaborators. diff --git a/files/en-us/mdn/at_ten/history_of_mdn/iyqi3qpv.jpg b/files/en-us/mdn/at_ten/history_of_mdn/iyqi3qpv.jpg deleted file mode 100644 index 527fc31664f388a..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/iyqi3qpv.jpg and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/jeremiepat.jpg b/files/en-us/mdn/at_ten/history_of_mdn/jeremiepat.jpg deleted file mode 100644 index 6f9306d6fe81a31..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/jeremiepat.jpg and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/jmswisher.jpg b/files/en-us/mdn/at_ten/history_of_mdn/jmswisher.jpg deleted file mode 100644 index 7aaac74d4b564a0..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/jmswisher.jpg and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/kuma.png b/files/en-us/mdn/at_ten/history_of_mdn/kuma.png deleted file mode 100644 index c129f645e3f3a60..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/kuma.png and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/mediawiki.png b/files/en-us/mdn/at_ten/history_of_mdn/mediawiki.png deleted file mode 100644 index d745940dcac8e25..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/mediawiki.png and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/screenshot_2018-07-24_16.06.55.png b/files/en-us/mdn/at_ten/history_of_mdn/screenshot_2018-07-24_16.06.55.png deleted file mode 100644 index 2159582e3bb8daa..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/screenshot_2018-07-24_16.06.55.png and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/teoli2003.png b/files/en-us/mdn/at_ten/history_of_mdn/teoli2003.png deleted file mode 100644 index 0d21c76e3ec13bb..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/teoli2003.png and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/waffle-flag.jpg b/files/en-us/mdn/at_ten/history_of_mdn/waffle-flag.jpg deleted file mode 100644 index 5d70d6010093d81..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/waffle-flag.jpg and /dev/null differ diff --git a/files/en-us/mdn/at_ten/history_of_mdn/yaacgvya.jpg b/files/en-us/mdn/at_ten/history_of_mdn/yaacgvya.jpg deleted file mode 100644 index 39483d374af666f..000000000000000 Binary files a/files/en-us/mdn/at_ten/history_of_mdn/yaacgvya.jpg and /dev/null differ diff --git a/files/en-us/mdn/at_ten/index.md b/files/en-us/mdn/at_ten/index.md deleted file mode 100644 index 692816098260763..000000000000000 --- a/files/en-us/mdn/at_ten/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: MDN at 10 -slug: MDN/At_ten -page-type: guide ---- - -{{MDNSidebar}} - -Celebrate 10 years of documenting your Web. - -## The history of MDN - -In early 2005, a small team of idealists set out to create a new, free, community-built online resource for all Web developers. Their brilliant but offbeat idea grew into today's Mozilla Developer Network—the premier resource for all open Web technologies. Ten years later, our global community is bigger than ever, and together we're still creating documentation, sample code and learning resources for all open Web technologies, including CSS, HTML, JavaScript and everything else that makes the open Web as powerful as it is. - -[Learn more about the history](/en-US/docs/MDN/At_ten/History_of_MDN) - -## Contributing to MDN - -For ten years, the MDN community has been documenting the open Web. From fixing simple typos to writing entire suites of an entirely new API, everyone has something to offer and no contribution is too large or too small. We have over 90,000 pages of content that have been written or translated by members of our outstanding community of Mozillians. You can become one of them. - -[Learn more about contributing](/en-US/docs/MDN/Community/Contributing) - -## See also - -- [The history of MDN](/en-US/docs/MDN/At_ten/History_of_MDN) diff --git a/files/en-us/mdn/community/communication_channels/index.md b/files/en-us/mdn/community/communication_channels/index.md index 9c8406a2fc9a10a..3d27b8da13c3d80 100644 --- a/files/en-us/mdn/community/communication_channels/index.md +++ b/files/en-us/mdn/community/communication_channels/index.md @@ -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 @@ -56,7 +55,7 @@ You can use the forums listed below for discussing code problems. ## Localization channels -Each localization team has its own [method of communication](/en-US/docs/MDN/Community/Contributing/Translated_content). +Each localization team has its own [method of communication](/en-US/docs/MDN/Community/Translated_content). ## Email diff --git a/files/en-us/mdn/community/contributing/getting_started/index.md b/files/en-us/mdn/community/contributing/getting_started/index.md deleted file mode 100644 index 08a86c7e000c942..000000000000000 --- a/files/en-us/mdn/community/contributing/getting_started/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Getting started with MDN Web Docs -slug: MDN/Community/Contributing/Getting_started -page-type: mdn-community-guide ---- - -{{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!](/en-US/docs/MDN/Community/Communication_channels) - -## 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 you're unsure what to do, you can always ask for help in one of [our communication channels](/en-US/docs/MDN/Community/Communication_channels). -> 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. - -### 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 without the burden of learning 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/getting-started-with-git/set-up-git) -- [GitHub workflow](https://docs.github.com/en/get-started/using-github/github-flow) -- [Using Markdown](https://github.com/skills/communicate-using-markdown) - -### Additional reading and learning material - -- [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](/en-US/docs/Learn_web_development): 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/public-domain/cc0/) (a Public Domain dedication). - -> If you have any questions or concerns about anything discussed here, please [contact us](/en-US/docs/MDN/Community/Communication_channels). diff --git a/files/en-us/mdn/community/contributing/index.md b/files/en-us/mdn/community/contributing/index.md index 1fa9be19512a725..564a7bc617e2d0c 100644 --- a/files/en-us/mdn/community/contributing/index.md +++ b/files/en-us/mdn/community/contributing/index.md @@ -1,12 +1,11 @@ --- title: Contributing to MDN Web Docs -slug: MDN/Community/Contributing +slug: MDN/Community page-type: mdn-community-guide +sidebar: mdnsidebar --- -{{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) +- [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) +- [Security vulnerability response](/en-US/docs/MDN/Community/Security_vulnerability_response) diff --git a/files/en-us/mdn/community/contributing/our_repositories/index.md b/files/en-us/mdn/community/contributing/our_repositories/index.md index c097dd17f332cc9..97f0eae34742e24 100644 --- a/files/en-us/mdn/community/contributing/our_repositories/index.md +++ b/files/en-us/mdn/community/contributing/our_repositories/index.md @@ -1,11 +1,10 @@ --- title: MDN Web Docs Repositories -slug: MDN/Community/Contributing/Our_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 diff --git a/files/en-us/mdn/community/discussions/index.md b/files/en-us/mdn/community/discussions/index.md index c14fb0d74e9a545..92ff8f7c98ef435 100644 --- a/files/en-us/mdn/community/discussions/index.md +++ b/files/en-us/mdn/community/discussions/index.md @@ -1,20 +1,23 @@ --- -title: Community discussions +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. -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] +> Don't report bugs in `mdn/mdn-community`. +> If you see something wrong on MDN Web Docs, open a GitHub issue in the [relevant MDN GitHub repository](https://github.com/mdn/). -**Note:** `mdn-community/discussions` is not the place to report problems. -If you see something wrong on MDN Web Docs, it's best to open a GitHub issue in the [relevant MDN GitHub repository](https://github.com/mdn/). -If you're not sure whether to open an issue or start discussion, consider the following guidelines: +If you're not sure whether to open a GitHub issue or discussion, here's what each are for: -- Issues should be used for reporting a bug or a work item with clearly defined and actionable tasks and outcomes. -- Use Discussions when an issue requires a dialogue to agree upon a course of action or define an actionable piece of work. -- If your discussion doesn't progress or you're unsure of the next steps, refer to the [Guidelines for managing and resolving discussions](/en-US/docs/MDN/Community/Discussions/Managing_and_resolving_discussions) for advice on moving forward, including expectations on timelines. +- **Issues** are for reporting bugs or tracking a work item with defined and actionable tasks and outcomes. +- **Discussions** are for reaching consensus about how we're working and for defining tasks. + +If your discussion doesn't progress or you're unsure of the next steps, refer to the [Guidelines for managing and resolving discussions](/en-US/docs/MDN/Community/Discussions/Managing_and_resolving_discussions) for advice on moving forward, including expectations on timelines. Check out the subject of each discussion category below so that you can start your discussion in the proper place. @@ -72,44 +75,12 @@ Check out the subject of each discussion category below so that you can start yo Learn Web Development area. - - - 🎨 - Design system - - - Discussions related to design improvements. Design is subjective, but we - are always open to suggestions from the community. Any improvement that - can help the MDN Web Docs experience even better for a wider audience is - welcome. If you have constructive feedback around the design, user - experience, and accessibility of MDN Web Docs, we'd love to hear from - you. - - - - - 👩‍💻 - Code examples - - - Discussions related to all code examples on MDN Web Docs. This includes - interactive examples, live samples and static code examples. For help - with general coding challenges on MDN Web Docs, see our - Communication channels. - - 🌐 Translated contentLocalization @@ -174,20 +145,5 @@ Check out the subject of each discussion category below so that you can start yo There is a separate discussion category for MDN Plus. - - - 🤖 - Polls - - - This category is meant for use by the MDN Web Docs staff. We will use - this category to run polls around topics where we need your input. So, - keep your eyes peeled. 👀 - - - diff --git a/files/en-us/mdn/community/discussions/managing_and_resolving_discussions/index.md b/files/en-us/mdn/community/discussions/managing_and_resolving_discussions/index.md index cea4e2ba7ab75ca..4e522d7b07abf8e 100644 --- a/files/en-us/mdn/community/discussions/managing_and_resolving_discussions/index.md +++ b/files/en-us/mdn/community/discussions/managing_and_resolving_discussions/index.md @@ -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 diff --git a/files/en-us/mdn/community/getting_started/index.md b/files/en-us/mdn/community/getting_started/index.md new file mode 100644 index 000000000000000..b958ede1684ecae --- /dev/null +++ b/files/en-us/mdn/community/getting_started/index.md @@ -0,0 +1,72 @@ +--- +title: Getting started with MDN Web Docs +short-title: Getting started +slug: MDN/Community/Getting_started +page-type: mdn-community-guide +sidebar: 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. + +## 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 you're unsure what to do, you can always ask for help in one of [our communication channels](/en-US/docs/MDN/Community/Communication_channels). + +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. +Note that our small but mighty docs team maintains this repo. +To preserve our bandwidth, off-topic conversations will be closed. + +## What do I need to get started? + +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 without the burden of learning a new tool at the same time. + +- [Introduction to GitHub](https://github.com/skills/introduction-to-github) +- [Setting up Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git) +- [GitHub workflow](https://docs.github.com/en/get-started/using-github/github-flow) +- [Using Markdown](https://github.com/skills/communicate-using-markdown) + +> [!NOTE] +> The "Introduction to GitHub" course should be enough to get you started. +> Feel free to jump forward and return to the other documents later on. + +We also recommend reading the following learning material: + +- [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](/en-US/docs/Learn_web_development): 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, don't worry if your grammar isn't perfect: we have a team of people who will review your writing and help improve it. +We need your technical expertise, and we'll help polish your English in order to get it. + +## Choosing what to work on and getting started + +Once you've decided what sort 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 with some comments, hints, or guidance. + +Make sure you're not working on something that's already in-progress - it can be frustrating to duplicate or lose work. +If in doubt, ask questions on the issue. + +## Ways to contribute + +Here's a list of ways you can contribute to MDN Web Docs: + +- [Fixing known high impact issues](https://github.com/orgs/mdn/projects/25/views/1) +- [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](/en-US/docs/MDN/Community/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) + +## 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/public-domain/cc0/) (a Public Domain dedication). + +If you have any questions or concerns about anything discussed here, please [contact us](/en-US/docs/MDN/Community/Communication_channels). diff --git a/files/en-us/mdn/community/index.md b/files/en-us/mdn/community/index.md index 1dae4b8f160212d..41f2e7f3dc4cf7d 100644 --- a/files/en-us/mdn/community/index.md +++ b/files/en-us/mdn/community/index.md @@ -1,70 +1,42 @@ --- -title: Community guidelines +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. -## Ways to contribute - -Here's a list of ways you can contribute to MDN Web Docs: - -- [Fixing known high impact issues](https://github.com/orgs/mdn/projects/25/views/1) -- [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](/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) - -## Community resources - -- [Communication channels](/en-US/docs/MDN/Community/Communication_channels) - - - : This page lists communication channels used by the MDN team and our community, with hints on which might be best for you. - -- [Contributing](/en-US/docs/MDN/Community/Contributing) - +- [Getting started](/en-US/docs/MDN/Community/Getting_started) - : This section explains how you can start contributing and the type of contributions we accept. - It covers [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), and [Security vulnerability response steps](/en-US/docs/MDN/Community/Contributing/Security_vulnerability_response). - -- [Open source etiquette](/en-US/docs/MDN/Community/Open_source_etiquette) - - - : This article gives guidance on how to behave when contributing to our open source project including rules for contributing, etiquette, and how to handle conflicts. - -- [Issues](/en-US/docs/MDN/Community/Issues) - + 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. +- [Our repositories](/en-US/docs/MDN/Community/Our_repositories) + - : This document describes the GitHub repositories (repos) you may need when contributing to MDN Web Docs. +- [GitHub Issues](/en-US/docs/MDN/Community/Issues) - : Issues are used to track all bugs and work that has a clear actionable outcome. - This article contains guidelines on opening and working on issues and also covers [Issue triage](/en-US/docs/MDN/Community/Issues) and [Content and feature suggestions](/en-US/docs/MDN/Community/Issues/Content_suggestions_feature_proposals). - + This article contains guidelines on opening and working on issues and also covers issue triage and content suggestions. - [Pull requests](/en-US/docs/MDN/Community/Pull_requests) - - : This section covers our guidelines for submitting pull requests and what you should expect from the review process. - - [Roles and teams](/en-US/docs/MDN/Community/Roles_teams) - - : This section provides an overview of the users and teams that are part of the MDN Web Docs project and details what it means to be part of a team. +- [Translated content](MDN/Community/Translated_content) + - : MDN Web Docs Localization information, with details about teams, communication channels, and how to get involved. +- [Open source etiquette](/en-US/docs/MDN/Community/Open_source_etiquette) + - : This article gives guidance on how to behave when contributing to our open source project including rules for contributing, etiquette, and how to handle conflicts. +- [Communication channels](/en-US/docs/MDN/Community/Communication_channels) + - : This page lists communication channels used by the MDN team and our community, with hints on which might be best for you. ## Code of conduct -By participating in and contributing to our projects and discussions, you acknowledge that you have read and agree to the [Mozilla community participation guidelines](https://github.com/mdn/mdn-community/blob/main/CODE_OF_CONDUCT.md). +By participating in and contributing to any of our projects in-person or online, you acknowledge that you have read and agree to the [Mozilla Community Participation Guidelines](https://github.com/mdn/mdn-community/blob/main/CODE_OF_CONDUCT.md) (CPG). -## Get in touch - -You can communicate with the MDN Web Docs team and community using the [communication channels](/en-US/docs/MDN/Community/Communication_channels). - -### General support +## General support We are a small team working hard to keep up with the documentation demands of a continuously changing web ecosystem. -Unfortunately, we can't help with general support questions. -If you're learning to code, you can refer to the following resources: - -- [Learn web development](/en-US/docs/Learn_web_development) -- [MDN Web Docs learn forum](https://discourse.mozilla.org/c/mdn/learn/250) -- [Stack Overflow](https://stackoverflow.com/questions/) +Unfortunately, we can't help with general support questions, such as troubleshooting code. +If you're learning, the [Learn web development](/en-US/docs/Learn_web_development) section is a great start, and you can post coding questions or search for answers on [Stack Overflow](https://stackoverflow.com/questions/). -Any issues, discussions, or pull requests opened on repositories asking for general support will be directed here and may be closed and locked. +Issues, discussions, or pull requests on MDN repositories asking for general support will be directed here and may be closed and locked. diff --git a/files/en-us/mdn/community/issues/content_suggestions_feature_proposals/index.md b/files/en-us/mdn/community/issues/content_suggestions_feature_proposals/index.md index ec78835697498f4..414c87876179606 100644 --- a/files/en-us/mdn/community/issues/content_suggestions_feature_proposals/index.md +++ b/files/en-us/mdn/community/issues/content_suggestions_feature_proposals/index.md @@ -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. diff --git a/files/en-us/mdn/community/issues/index.md b/files/en-us/mdn/community/issues/index.md index 5316815665c88df..cf66e5a423cbc41 100644 --- a/files/en-us/mdn/community/issues/index.md +++ b/files/en-us/mdn/community/issues/index.md @@ -1,13 +1,11 @@ --- -title: Guidelines to open and work on issues +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. ## General guidelines for participation @@ -32,7 +30,7 @@ Avoid doing the following: ### Before filing an issue -If you think you've found a bug with the content on MDN Web Docs or with the look and feel of the website, search the current open issues in the [relevant repository](/en-US/docs/MDN/Community/Contributing/Our_repositories) and make sure nobody else has reported the issue. +If you think you've found a bug with the content on MDN Web Docs or with the look and feel of the website, search the current open issues in the [relevant repository](/en-US/docs/MDN/Community/Our_repositories) and make sure nobody else has reported the issue. ### Reporting an issue diff --git a/files/en-us/mdn/community/learn_forum/index.md b/files/en-us/mdn/community/learn_forum/index.md index 32d5e21058a0355..4671b8410f8a6b0 100644 --- a/files/en-us/mdn/community/learn_forum/index.md +++ b/files/en-us/mdn/community/learn_forum/index.md @@ -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. diff --git a/files/en-us/mdn/community/open_source_etiquette/index.md b/files/en-us/mdn/community/open_source_etiquette/index.md index 481039d357f6e07..75fc729a71b3386 100644 --- a/files/en-us/mdn/community/open_source_etiquette/index.md +++ b/files/en-us/mdn/community/open_source_etiquette/index.md @@ -2,99 +2,96 @@ 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 (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. +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. ## Think about why you are contributing to an OSP -Before you start contributing to an open source project, ask yourself why you want to do that. It is fine if the answer to this question is just "I'm bored and I want to find something productive to do with my time", but you can probably go deeper than that. - -Even better reasons might include: +Before you start contributing to an open source project, ask yourself why you want to do that. +It's fine if the answer to this question is "I want something to do with my time", but even better reasons might include: -- I use this tool all the time and found a bug in it/want to help make it better. +- I want to improve my skills. +- I use this tool all the time and found a bug in it or I want to help make it better. - I want to help other people use the tool more successfully. - I want to help other people contribute to the project more successfully. -- I want to improve my own skills. -- I want to publicly demonstrate my own skills as part of my college or university course. -- I want to publicly demonstrate my own skills to improve my chances of getting a job. +- I want to publicly demonstrate my own skills for my college or university course or to improve my chances of getting a job. -Some of these reasons are self-serving, and that's OK — if you are spending your time working on a project for free, then it is fair to expect to get something out of it. In addition, having a clear set of reasons for contributing will make it easier to decide what to work on first. - -Your presence on the project should be productive, and it shouldn't stop others from being so too. +Some of these reasons are self-serving, and that's fine! +Having a clear set of reasons for contributing will make you more productive and make it easier to work with the community. ## Be polite, be kind, avoid incendiary or offensive language -We could abbreviate this to "be kind". This is our number one bit of advice for anyone starting open source contributions. - -Be kind to the other contributors on the project, and it will be a happier and more productive place. This includes: +We could abbreviate this to "be kind". +This is our number one bit of advice for anyone starting open source contributions. +Be kind to the other contributors on the project, and it will be a happier and more productive place. -- Thanking people if they help you. -- Congratulating people where appropriate (for example if they land their first ever pull request, or fix a particularly difficult bug). -- Always responding respectfully to people, even if you feel like the answer to their question was a bit obvious, or that they are repeating themselves. -- Trying to help people to do better next time, in a supportive way, e.g. during pull request reviews or as you answer their questions. Saying "this is wrong" or "here is the answer" is nowhere near as helpful as saying "This is OK, but I feel that this would be better if you tried doing it more like this, here's a blog post for more ideas" or "you can find the answer here; also check out this link for more common answers". +- Thank people if they help you. +- Congratulate people where appropriate, like if they land a pull request, or fix a difficult bug. +- Always respond respectfully, even if you feel like the answer to a question was obvious or that someone is repeating themselves. +- Try to help people to do better in a supportive way. + For example, saying "this is wrong" or "here is the answer" is not as helpful as saying "This is OK, but I feel that it would be better if we did it more like this, here's a blog post for more ideas" or "you can find the answer here; also check out this link for more common answers". -You and the other contributors are (or should be) here because they want to make a positive contribution to the project, but beyond that, you can't assume anything about them. This includes their: +Contributors are here because they want to make a positive impact on the project. +Beyond that, don't make assumptions, such as: - Knowledge of the project and the technologies used to build it - Gender, sexuality, age, languages spoken, location, political views, religion, or other personal attributes - Experience with open source projects -- Confidence +- Confidence level - Expectations - Sense of humor -You should therefore keep what you write on topic as much as possible, staying away from potential controversial off-topic subjects like religion or politics, and being supportive and respectful even if you disagree with someone, or don't like a decision they've made. +You should keep what you write on topic and avoid controversial subjects, such as religion or politics. +Refrain from swearing or potentially offensive language. +It rarely improves communication, and can make it harder for others to participate. -Also, you should refrain from any swearing / offensive language, even if it is not directed at anyone in particular. It is not needed for participation, and some people are really sensitive to it. +Be supportive and respectful even if you disagree with someone, or don't like a decision they've made. +Be aware that there are rules in place in any good OSP to protect its contributors against being made to feel uncomfortable while contributing. +This usually can be found in a `CODE_OF_CONDUCT.md` file on GitHub (see [`mdn/content` CODE_OF_CONDUCT](https://github.com/mdn/content/blob/main/CODE_OF_CONDUCT.md) for an example). -Be aware that there are rules in place in any good OSP to protect its contributors against being made to feel uncomfortable while contributing. This usually comes in the form of a CODE_OF_CONDUCT.md file on GitHub. - -For example, MDN's repos are governed by the wide-reaching [Mozilla Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/). Usually mildly offensive behavior on MDN Web Docs repos (such as constantly being off-topic/disruptive, or being rude) will usually be first responded to by a warning on the repo, followed by a final warning, then a temporary or permanent ban. More serious behavioral problems such as hate speech or threats against another contributor will not be tolerated, and will likely result in an instant ban. +MDN's repos are governed by the wide-reaching [Mozilla Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/) (CPG). +Usually mildly offensive behavior on MDN Web Docs repos (such as constantly being off-topic/disruptive, or being rude) will be first responded to with a warning, followed by a final warning, then a temporary or permanent ban. +More serious behavioral problems such as hate speech or threats against another contributor will not be tolerated, and will likely result in an instant ban. If you receive anything that makes you feel uncomfortable, you should always report it using the mechanism provided on the code of conduct. ## Choose effective contributions Think about what you want to do on the project. For example, we have a large list of issues filed at on the [contributors 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](/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: - -- Help to triage issues that come in. -- Help fix typos. -- Help to improve grammar and make pages more understandable. -- Help to mentor people that are trying to make fixes. +A lot of the work on MDN revolves around writing documentation and code examples, but there are other ways to contribute too. +This could be helping to triage issues that come in, fixing typos, fixing grammar to make pages more understandable, or mentoring people that are trying to make fixes. +Every fix is useful, no matter how small, and we won't turn any away. +Nevertheless, try to make sure your fixes are productive. We'd like to advise against these kinds of contributions: -Every fix is useful, no matter how small, and we won't turn any fix away. Nevertheless, try to make sure your fixes are productive. We'd like to advise against these kinds of contributions: - -- Updating code styling just because "you like that style better". -- Updating language style just because "you like that style better". +- Updating code style, language in prose, or testing framework because you like it better. - Changing pages from US English to British English. -- Adding or removing a bunch of punctuation when there's not really anything wrong. -- Changing the testing framework we are using for something else because you prefer it. +- Adding or removing punctuation when the original is correct. -In many cases, things are like they are on OSPs for a reason. You should read their style guides if they have one, and if in doubt about whether something is productive, always ask first! +In many cases, things are like they are on OSPs for a reason. +You should read style guides if they have one, and if in doubt about whether something is productive, always ask first! ## 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 Web Docs](/en-US/docs/MDN/Community/Contributing)). - -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. +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 [Community resources](/en-US/docs/MDN/Community)). -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. +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. +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 [Get in touch](/en-US/docs/MDN/Community#get_in_touch)). 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). +Find out where the best place is to ask questions. Good OSPs will always make this clear in their docs (see [Get in touch](/en-US/docs/MDN/Community/Communication_channels)). If you want to ask general questions, then always make use of these channels. Don't file an issue on GitHub for every question, as it adds noise to the project (see the next section). ## Make progress, not noise -Think carefully about the way you handle communication in the project — make sure it is useful, and that it doesn't make other contributor's jobs harder. Submitting pull requests to fix bugs is great, but are they truly useful, and easy to review? Filing issues and joining in other conversations is fine, but are your issues and comments on topic, or are they just adding noise? +Think carefully about the way you handle communication in the project — make sure it is useful, and that it doesn't make other contributor's jobs harder. Submitting pull requests to fix bugs is great, but be sure they are useful or easy to review. +Filing issues and joining in other conversations is fine, but are your issues and comments on topic, or are they adding noise? As a rule, do: @@ -125,7 +122,7 @@ Bear in mind that many people working on OSPs are doing it in their free time, w It is reasonable to wait a few days and then ping someone politely to ask if they've had time to look at it. If they happen to be too busy, it may be best to wait a further week and try following up with them then. -It is NOT reasonable to start demanding things, like a quick reply. +It is **not** reasonable or polite to demand things like a quick reply. If someone is waiting for you to do something for them, you should be extended the same courtesy, but at the same time, try to respond as promptly as you can. If you really can't find the time, let them know, and ask the maintainers to help you find someone else to do the task. @@ -134,3 +131,4 @@ If someone is waiting for you to do something for them, you should be extended t - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) - [More general freeCodeCamp "How to contribute to open source" list](https://github.com/freeCodeCamp/how-to-contribute-to-open-source) - [Getting started with contributing to open source](https://stackoverflow.blog/2020/08/03/getting-started-with-contributing-to-open-source/) +- [Google Engineering Practices Documentation](https://google.github.io/eng-practices/) on google.github.io/eng-practices diff --git a/files/en-us/mdn/community/our_repositories/index.md b/files/en-us/mdn/community/our_repositories/index.md new file mode 100644 index 000000000000000..691f0a7e4bd08f1 --- /dev/null +++ b/files/en-us/mdn/community/our_repositories/index.md @@ -0,0 +1,69 @@ +--- +title: MDN GitHub repositories +short-title: GitHub repositories +slug: MDN/Community/Our_repositories +page-type: mdn-community-guide +sidebar: 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. + +## Main repositories + +- [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. +- [rari](https://github.com/mdn/rari) + - : This is the backend part of the MDN Web Docs platform, where you'll go if you want to make changes to page structures and rendering machinery. +- [yari](https://github.com/mdn/yari) + - : This is the frontend part of the MDN Web Docs platform, where you'll find styles, design, and layout functionality. +- [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) + - : 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)). + +### Infrastructure + +- [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. + +### Planning and coordination + +These are repository used for project planning, documenting the project itself, and community projects. + +- [mdn/mdn](https://github.com/mdn/mdn) + - : 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. + +## Code examples + +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. + +> [!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. + +- [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) diff --git a/files/en-us/mdn/community/pull_requests/index.md b/files/en-us/mdn/community/pull_requests/index.md index bc75f4ffe3626e7..6f138c9eeda8171 100644 --- a/files/en-us/mdn/community/pull_requests/index.md +++ b/files/en-us/mdn/community/pull_requests/index.md @@ -1,11 +1,10 @@ --- -title: Pull request submission and review guidelines +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: @@ -70,7 +69,6 @@ When you're ready to open a pull request, follow these guidelines: - **Don't make grammar-only changes:** MDN Web Docs contains technical documentation; you should not suggest prose style changes except where grammar is incorrect. - **Don't unnecessarily add or remove line breaks** on pages that follow a certain formatting style. -- **Don't enable auto-merge.** ### After you open a pull request @@ -202,3 +200,4 @@ Reviewers are encouraged to read the following articles for help with common tas - [The Art of Closing](https://blog.jessfraz.com/post/the-art-of-closing/) explains how to close an unfinished or rejected pull request - [Kindness and Code Reviews: Improving the Way We Give Feedback](https://product.voxmedia.com/2018/8/21/17549400/kindness-and-code-reviews-improving-the-way-we-give-feedback) gives useful hints to give feedback - [Code Review Guidelines for the Reviewer](https://phauer.com/2018/code-review-guidelines/#code-reviews-guidelines-for-the-reviewer) provides examples of good and bad feedback +- [How to do a code review](https://google.github.io/eng-practices/review/reviewer/) on google.github.io/eng-practices diff --git a/files/en-us/mdn/community/roles_teams/index.md b/files/en-us/mdn/community/roles_teams/index.md index e1f0fcffb741572..36556197f6a60c0 100644 --- a/files/en-us/mdn/community/roles_teams/index.md +++ b/files/en-us/mdn/community/roles_teams/index.md @@ -1,12 +1,12 @@ --- 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 members can be [found here](https://github.com/orgs/mdn/people). +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. Contributors can use their work on MDN Web Docs to show their writing, technical, and collaboration skills, and the ability to work with people from diverse backgrounds. This section describes the roles you can take on while volunteering on the MDN Web Docs project. diff --git a/files/en-us/mdn/community/contributing/security_vulnerability_response/index.md b/files/en-us/mdn/community/security_vulnerability_response/index.md similarity index 97% rename from files/en-us/mdn/community/contributing/security_vulnerability_response/index.md rename to files/en-us/mdn/community/security_vulnerability_response/index.md index 8b09171dafa4755..95c2339b23cfd4a 100644 --- a/files/en-us/mdn/community/contributing/security_vulnerability_response/index.md +++ b/files/en-us/mdn/community/security_vulnerability_response/index.md @@ -1,11 +1,10 @@ --- title: Security vulnerability response steps -slug: MDN/Community/Contributing/Security_vulnerability_response +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. diff --git a/files/en-us/mdn/community/contributing/translated_content/index.md b/files/en-us/mdn/community/translated_content/index.md similarity index 92% rename from files/en-us/mdn/community/contributing/translated_content/index.md rename to files/en-us/mdn/community/translated_content/index.md index 49354c4514d1449..6b727ebe03cbac9 100644 --- a/files/en-us/mdn/community/contributing/translated_content/index.md +++ b/files/en-us/mdn/community/translated_content/index.md @@ -1,14 +1,14 @@ --- -title: MDN Web Docs Localization -slug: MDN/Community/Contributing/Translated_content +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. +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. ## How to contribute diff --git a/files/en-us/mdn/index.md b/files/en-us/mdn/index.md index 8675145a3e8156f..cd55ac59a9f7037 100644 --- a/files/en-us/mdn/index.md +++ b/files/en-us/mdn/index.md @@ -1,26 +1,22 @@ --- -title: The MDN Web Docs project +title: MDN Web Docs slug: MDN page-type: landing-page +sidebar: mdnsidebar --- -{{MDNSidebar}} - -**MDN Web Docs** is free-to-use resource on which we document the open web platform. Our mission is to provide _developers_ with the _information_ they need to _easily_ build projects on the _web platform_. - -This is the landing page for the MDN Web Docs project itself. Here you'll find guides on how the site works, how we do our documentation, the guidelines and conventions we adhere to, and how you can help. - -We invite everyone to help! MDN Web Docs is an open-source project and accepts contributions. There are many different tasks you can help with, from the simple (proofreading and correcting typos) to the complex (writing API documentation). - -To find out how to help, visit our [Getting started](/en-US/docs/MDN/Community/Contributing/Getting_started) page. If you want to talk to us and ask questions, join the discussion on the [MDN Web Docs chat rooms](/en-US/docs/MDN/Community/Communication_channels#chat_rooms). - -- [Community guidelines](/en-US/docs/MDN/Community) - - - : These guides help you get started with contributing to MDN Web Docs. They also cover topics such as how you can help with tasks and issues, open discussions, and suggest content. If you need help or want to contact us, you'll find the information here. +**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. +- [MDN Web Docs Community](/en-US/docs/MDN/Community) + - : These pages describe how to get started contributing to MDN Web Docs. + You can find out where to look for answers, how to work on GitHub issues, open discussions, or suggest new content. + If you need help or want to get in touch with us, you'll find all the information here. - [Writing guidelines](/en-US/docs/MDN/Writing_guidelines) - - - : These guides provide all the information about how to write for MDN Web Docs. They outline the policies for the type of content we write and the type of content we don't write. You'll also find our writing style guide here, how-to guides to perform various content tasks, and also information about the structure of our different pages. - -- [MDN Product Advisory Board](/en-US/docs/MDN/MDN_Product_Advisory_Board) - - : The MDN Product Advisory Board's mission is to build collaboration between Mozilla, its documentation team, and the key collaborating organizations that help the MDN community collectively maintain MDN Web Docs. + - : These guides describe how to write for MDN Web Docs. + They contain the editorial policies defining the types of content we write and the types of content we don't write. + You'll find our writing style guide, how-to guides for specific tasks, and information about the structure of different types of pages. +- [About MDN Web Docs](/en-US/about) + - : MDN Web Docs serves millions of readers every month and connects developers with the tools and information they need to easily build projects on the open web. + Learn about the history of MDN, the team working on MDN Web Docs, our values, and our partners. diff --git a/files/en-us/mdn/mdn_product_advisory_board/index.md b/files/en-us/mdn/mdn_product_advisory_board/index.md deleted file mode 100644 index 7faf86d0ef2519b..000000000000000 --- a/files/en-us/mdn/mdn_product_advisory_board/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: MDN Product Advisory Board -slug: MDN/MDN_Product_Advisory_Board -page-type: guide ---- - -{{MDNSidebar}} - -MDN Web Docs is a trusted source of technical documentation for web developers, built on an open-source web development documentation platform based on wiki technology, which allows virtually anyone to write and edit content. - -The MDN Product Advisory Board's mission is to build collaboration between Mozilla, its documentation team, and the key collaborating organizations that help the MDN community collectively maintain MDN as the most comprehensive, complete, and trusted reference documenting the most important aspects of modern browsers and web standards. - -The Product Advisory Board provides advice from external leaders, helping MDN in its mission to provide unbiased, browser-agnostic documentation of HTML, CSS, JavaScript, and Web APIs to ensure that it's the top reference for standards-based web development. - -## Members - -Current members of the MDN Product Advisory Board are: - -- **Reeza Ali** - Principal Program Manager, Microsoft Edge Developer Experiences - - : Reeza Ali is a Program Manager at Microsoft, who leads the content strategy on the Edge developer relations team. Throughout his Microsoft career, he's been a strong advocate for developer success. Over the past 7+ years, he's led several web content documentation teams and projects at Microsoft. He believes that product content and learning experiences play a pivotal role in creating successful outcomes for developers. He's passionate about content strategy, technology, and technical communication. -- **Sukriti Chadha** - Product Manager, Spotify - - : Sukriti Chadha is a mobile developer-turned-product manager at Spotify where she leads efforts in cross-platform accessibility and developer experience on mobile. She also serves as an Invited Expert at the [W3C WCAG (Web Content Accessibility Guidelines) Working Group](https://www.w3.org/WAI/standards-guidelines/wcag/) and the [Mobile Accessibility Task Force (MATF)](https://www.w3.org/WAI/standards-guidelines/mobile/), where she contributes to industry guidelines for accessible web and mobile applications. She built a new way of making data visualization accessible for visually impaired users, and [open-sourced the Android solution in 2019](https://developer.yahoo.com/blogs/612790529269366784/). Sukriti's product role entails managing developer experience roadmaps, automated testing, and embedding accessibility in the product lifecycle. -- **Hermina Condei** - Head of Product CE, Marketing Operations, Mozilla - - : Hermina Condei leads product management and engineering for MDN Web Docs and platform engineering for SUMO at Mozilla. Over the past years, she's driven company-wide projects focused on access and identity management for employees and the community. She also led the product team in the **Open Innovation Group**, with a focus on managing internal and external stakeholders for the team's portfolio of projects. -- **Dominique Hazael-Massieux** - W3C Web Technology Expert including [Telecommunications Vertical champion](https://www.w3.org/Telco/), [Web Real-Time Communications Working Group](https://www.w3.org/groups/wg/webrtc), [Device and Sensors Working Group](https://www.w3.org/das/) - - : Dominique Hazael-Massieux is part of the W3C staff, leading W3C efforts in developer relations. Dom has been working for W3C since 2000, and in addition to devrel, is currently involved in the standardization of WebRTC, device APIs and WebVR. -- **Brian Kardell** - Developer Advocate, Igalia - - : Brian is a Developer Advocate at Igalia. He participates in W3C where he is Igalia's Advisory Committee Representative and participates in various working groups and community groups. He also has represented the Open JS Foundation there. -- **Eric Meyer** - Developer Advocate, Igalia - - : [Eric](https://meyerweb.com/) ([@meyerweb](https://mastodon.social/@Meyerweb)) is an [author](https://meyerweb.com/eric/writing.html), speaker, blogger, sometimes teacher and consultant, Developer Advocate at [Igalia](https://www.igalia.com/), and co-founder of [An Event Apart](https://aneventapart.com/). He's been working on the Web since 1993 and still finds it deeply compelling. -- **Laura Morinigo** - Web Developer Advocate, Samsung - - : Laura is a software developer, advocate, and mentor. She is passionate about sharing her knowledge and connecting with different tech communities worldwide. Thanks to her contributions, she has been recognized as a Google Developer Expert and a Woman Techmakers Ambassador. As a mentor, she helped startups participating in accelerator programs like Google Launchpad and the World Food Programme by the United Nations. Currently, she is a web developer advocate for Samsung Internet. She contributes to web standards and spreads the word about advanced web features, helping developers create great and more inclusive web apps. -- **Sheila Moussavi** - Principal, Bocoup - - : Sheila is a Principal at [Bocoup](https://www.bocoup.com/about), where she leads a team working on web standards like HTML and CSS, and no-code programming tools like [Scratch](https://www.scratchfoundation.org/). Sheila oversees Bocoup's web standards strategy at the W3C, and is passionate about building more equitable spaces in web standards and stronger connections between the standards process and web developer education. Throughout her career in tech (and previously in health equity and disability justice), she has been focused on cultivating effective, justice-oriented organizations and work spaces. -- **Robert Nyman** - Global Lead for Programs & Initiatives, Web Developer Relations, at Google - - : Robert Nyman is the Global Lead for Developer Feedback & Communities, Web Platform at Google. In his role, he works to make the web the best platform for developers. Prior to Google, Robert was a technical evangelist at Mozilla, focused on the Open Web and the company's various products and initiatives. He lives in Stockholm, and has a passion for traveling and meeting people. He claims the title of "Most Well-Traveled Speaker" on Lanyrd, having presented in 42 countries. -- **Kyle Pflug** - Senior Program Manager, Microsoft Edge Developer Experiences - - : Kyle Pflug is a Program Manager at Microsoft, leading developer relations and community outreach for Microsoft Edge. Over the past five years, he has worked to champion web developer and partner perspectives within Microsoft. He is passionate about making the web more inclusive and accessible to developers across platforms and devices. - -**MDN Product Advisory Board Alumni:** - -- Ali Spivak, Okta -- Daniel Appelquist, Samsung -- Jory Burson, Bocoup -- Joe Medley, Formerly Google -- Meggin Kearney, Google -- Erika Doyle Navara, Microsoft -- Patrick Kettner, Microsoft -- Travis Leithead, Microsoft -- Chris Mills, Mozilla -- Kadir Topal, Mozilla - -## See also - -- [Product Advisory Board Charter & Membership](/en-US/docs/MDN/MDN_Product_Advisory_Board/Membership) diff --git a/files/en-us/mdn/mdn_product_advisory_board/membership/index.md b/files/en-us/mdn/mdn_product_advisory_board/membership/index.md deleted file mode 100644 index 07a9bb2869d9401..000000000000000 --- a/files/en-us/mdn/mdn_product_advisory_board/membership/index.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: Product Advisory Board Charter & Membership -slug: MDN/MDN_Product_Advisory_Board/Membership -page-type: guide ---- - -{{MDNSidebar}} - -## 1. Purpose and Objectives - -The primary purpose of the PAB is to provide advice, input, and feedback on content strategy, content prioritization, strategic direction, and platform/site features to MDN's Product Manager and Content Lead. Mozilla will consider input and advice from the PAB; however PAB input and recommendations are non-binding. The primary objectives of the PAB are: - -- Provide feedback into content strategy and prioritization of standards documentation -- Help define product strategy, roadmap, and priorities including: - - - Suggest and comment on Objectives and Key Results (OKRs) - - Suggest and comment on yearly and quarterly content roadmaps - -- Make organizational and individual commitments to contribute to MDN based on the defined strategies, roadmaps and priorities -- Represent and promote user requirements, ensuring that MDN continues to evolve and meet users' needs and challenges -- Suggest and give feedback on new opportunities -- Provide feedback on recruiting and retaining contributors (both corporate and individual) -- Share experience and best practices - -## 2. Membership Selection and Termination - -a. The PAB shall consist of 10 to 12 Members (as defined in the MDN Product Advisory Board Agreement and including those individuals representing a Member organization), to be selected by Mozilla. - -b. There are two types of membership: organizational and individual. Organizations who meet the membership criteria and are accepted as member organizations may nominate up to 2 individuals to serve as their representatives ("Member Representatives" as defined in the MDN Product Advisory Board Agreement) on the PAB. - -c. Organizations/individuals who wish to become PAB members must submit a MDN Product Advisory Board Interest Form. Membership will be subject to review and approval by Mozilla, and notification will be sent to the applicant within 30 days of application. - -d. Membership start dates will be based upon review meeting schedules; any new Members will begin their term on the PAB at the next scheduled review meeting. - -e. Members of the PAB will serve terms of 1 year, renewed automatically for up to 3 years (unless terminated by either party). At the end of the 1-year term, the PAB Member and Mozilla will review membership and decide whether to continue Member participation. - -f. Members may resign in writing, via email to the PAB mailing list. Member organizations can nominate replacements for resigned members before the start of the next review meeting. - -g. Mozilla may terminate a Member in the case of violation of the MDN Advisory Board Agreement, violation of the MDN PAB Code of Conduct, violation of the Antitrust Policy, or if the Member fails to participate in two consecutive review meetings without notice. At that time, a notice will be sent to the principal contact stating that they have been removed as a Member. - -## 3. PAB Membership Qualifications - -a. PAB Members have in-depth industry knowledge and expertise. Members will be knowledgeable about web standards, with the ability and experience to align MDN's overall strategic goals and content plans with evolution of web standards, industry direction, and the needs of developers using MDN's documentation. - -b. Membership in the PAB is limited to organizations and individuals who make significant contributions to MDN and/or the advancement, development, and implementation of web standards. - -c. Member organizations must play a significant role in the creation, implementation, or adoption of Web standards and guidelines. It is also preferred that PAB Member organizations be members of an established Web standards group, such as W3C. Member organizations may nominate up to 2 individual representatives to serve on the board. - -d. Individual Members of the PAB must have at least one of the following qualifications: - -- Plays a significant role in the creation, implementation, or adoption of Web standards; -- Participates in a Web standards group dedicated to the development of specifications for features implemented in a Web browser or used in Web content that is sent to browsers. Participation in W3C or a similar standards group is preferred but not required. Individual Members may also meet this qualification by having served on a standards working group or as an invited expert on an established Web standards working group; -- Is a member of a Web-focused Developer Relations team; -- Works as part of a group doing technical documentation of Web standards; or -- Makes significant, sustained contributions to MDN Web standards documentation as a volunteer. - -## 4. Member Responsibilities and Commitments - -a. Members are expected to provide feedback and responses in a timely manner, and attend a minimum number of review meetings. Participation is welcome from all over the world. Members' expectations include: - -Provide feedback on scheduling annual and quarterly meetings; - -- Attend annual meeting; -- Attend at least 2 quarterly reviews per year; -- Review proposals and provide feedback; -- Join the PAB mailing list; -- and Agree not to promote a specific corporate or individual agenda, particularly in the creation or editing of content on MDN. - -b. Members may be required to provide personal information and material (bios, etc.) for analyst, press, and/or trade publications and press releases. - -c. All Members must sign the MDN Product Advisory Board Agreement and agree to the MDN PAB [Code of Conduct](https://www.mozilla.org/en-US/about/governance/policies/participation/) and Antitrust Policy. - -## 5. MDN PAB Member Benefits - -It is anticipated that PAB membership will have the following benefits: - -- Impact content strategy and priorities for MDN; -- Influence the strategic direction of MDN; Have advance knowledge of MDN plans and development; -- Make suggestions for features and platform improvements to grow MDN audience and contribution; and -- Provide feedback and technical reviews of content. - -## 6. Scheduled and Ad Hoc Meetings - -a. Members will be invited to the following meetings: - -- Annual Product Strategy review meetings to take place between October and December of each calendar year; -- Quarterly content strategy and prioritization review meetings ("Quarterly Reviews); and -- Ad hoc product review/check-in meetings, which can be initiated by Mozilla or any Member as needed ("Ad Hoc Meetings"). - -b. Annual Product Strategy review meetings will review the previous year's progress and make recommendations for MDN's strategy and objectives for the following year. - -c. Annual Product Strategy review meetings can take place in Mozilla headquarters or worldwide office, the offices of a Member, or external locations, as determined by vote of the PAB. Virtual attendance will be accommodated for Members who are unable to attend in person. - -d. Quarterly Reviews and Ad Hoc Meetings will primarily be held via video/conference call, although in-person attendance will be possible at the discretion of Members. - -e. Ad Hoc Meeting dates will depend upon the work in development. Review points will have a specific emphasis such as coordination around product release dates and major features or new specs and standards reaching broad release that require more in-depth coordination and planning beyond the Quarterly Review. - -## 7. Time Commitment and Costs - -a. Members are asked to make a commitment to the PAB for at least 12 months. - -b. Members are asked to commit the time to prepare for, attend (sometimes in person), and participate in regularly scheduled and ad hoc PAB meetings. - -c. Costs for participant travel and living expenses or other involvement are to be paid by the individual board member or the sponsoring organization. - -## See also - -- [Product Advisory Board home](/en-US/docs/MDN/MDN_Product_Advisory_Board) diff --git a/files/en-us/mdn/writing_guidelines/attrib_copyright_license/index.md b/files/en-us/mdn/writing_guidelines/attrib_copyright_license/index.md index fe472125059770e..08f3f3922507aa0 100644 --- a/files/en-us/mdn/writing_guidelines/attrib_copyright_license/index.md +++ b/files/en-us/mdn/writing_guidelines/attrib_copyright_license/index.md @@ -2,11 +2,10 @@ title: Attribution and copyright licensing slug: MDN/Writing_guidelines/Attrib_copyright_license page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - -MDN Web Doc's content is available free of charge and is available under various open-source licenses. +MDN Web Docs content is available free of charge and is available under various open-source licenses. ## Using MDN Web Docs content diff --git a/files/en-us/mdn/changelog/index.md b/files/en-us/mdn/writing_guidelines/changelog/index.md similarity index 98% rename from files/en-us/mdn/changelog/index.md rename to files/en-us/mdn/writing_guidelines/changelog/index.md index 0cd3765e74ab63f..71920a2f08b0368 100644 --- a/files/en-us/mdn/changelog/index.md +++ b/files/en-us/mdn/writing_guidelines/changelog/index.md @@ -1,11 +1,10 @@ --- title: MDN Web Docs changelog -slug: MDN/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 diff --git a/files/en-us/mdn/writing_guidelines/experimental_deprecated_obsolete/index.md b/files/en-us/mdn/writing_guidelines/experimental_deprecated_obsolete/index.md index 1024af1dd659816..5c5fc6a01c91d50 100644 --- a/files/en-us/mdn/writing_guidelines/experimental_deprecated_obsolete/index.md +++ b/files/en-us/mdn/writing_guidelines/experimental_deprecated_obsolete/index.md @@ -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. diff --git a/files/en-us/mdn/writing_guidelines/howto/creating_moving_deleting/index.md b/files/en-us/mdn/writing_guidelines/howto/creating_moving_deleting/index.md index 87238a1c67dbefb..5fb738cfbf0b3fe 100644 --- a/files/en-us/mdn/writing_guidelines/howto/creating_moving_deleting/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/creating_moving_deleting/index.md @@ -1,12 +1,13 @@ --- -title: How to create, move, delete, and edit pages +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 MDN Web Docs team on the [MDN Web Docs chat rooms](/en-US/docs/MDN/Community/Communication_channels#chat_rooms) before proceeding. +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. ## Creating pages @@ -55,8 +56,8 @@ yarn content move [locale] ``` You just have to specify the slug of the existing document that you'd like -to move (e.g., `Learn_web_development/Core/Accessibility`), as well as the slug of its new -location (e.g., `Learn/A11y`), optionally followed by the locale of the +to move (e.g., `Web/HTTP/Authentication`), as well as the slug of its new +location (e.g., `Web/HTTP/Auth`), optionally followed by the locale of the existing document (defaults to `en-US`). If the existing document that you'd like to move has child documents (i.e., @@ -64,7 +65,7 @@ it represents a document tree), the `yarn content move` command will move the entire tree. For example, let's say you want to move the entire -`/en-US/Learn_web_development/Core/Accessibility` tree to `/en-US/Learn_web_development/A11y`, you'd perform the following steps: +`/en-US/Web/HTTP/Authentication` tree to `/en-US/Web/HTTP/Auth`, you'd perform the following steps: 1. You'll start a fresh branch to work in. @@ -81,7 +82,7 @@ For example, let's say you want to move the entire 2. Perform the move (which will delete and modify existing files as well as create new files). ```bash - yarn content move Learn_web_development/Core/Accessibility Learn_web_development/A11y + yarn content move Web/HTTP/Authentication Web/HTTP/Auth ``` 3. Once files are moved we need to update references to those files in the other content files as well. Use following command to update all the references automatically in one go: @@ -94,13 +95,14 @@ For example, let's say you want to move the entire ```bash git add . - git commit -m "Move Learn_web_development/Core/Accessibility to Learn_web_development/A11y" + git commit -m "Move Web/HTTP/Authentication to Web/HTTP/Auth" git push -u origin my-move ``` 5. Create your pull request. -> **Note:** `yarn content move` automatically adds the necessary redirect information to the `_redirects.txt` file so that the old location will redirect to the new one. Don't edit the `_redirects.txt` file manually! Mistakes can easily creep in if you do. If you need to add a redirect without moving a file, talk to the MDN Web Docs team on the [MDN Web Docs chat rooms](/en-US/docs/MDN/Community/Communication_channels#chat_rooms) about it. +> [!NOTE] +> The `yarn content move` command adds required redirects in the `_redirects.txt` file so that the old location will redirect to the new one. Don't edit the `_redirects.txt` file manually! Mistakes can easily creep in if you do. If you need to add a redirect without moving a file, talk to the MDN Web Docs team on the [MDN Web Docs Communication channels](/en-US/docs/MDN/Community/Communication_channels) about it. ## Deleting pages @@ -117,7 +119,7 @@ yarn content delete [locale] > You need to use the `yarn content delete` command to delete pages from MDN Web Docs. Don't just delete their directories from the repo. The `yarn content delete` command also handles other necessary changes such as updating the `_wikihistory.json` file. You just have to specify the slug of the existing document that you'd like -to delete (e.g., `Learn_web_development/Core/Accessibility`), optionally followed by the locale +to delete (e.g., `Web/HTTP/Authentication`), optionally followed by the locale of the existing document (defaults to `en-US`). If the existing document that you'd like to delete has child documents (i.e., it represents a @@ -125,7 +127,7 @@ document tree), you must also specify the `-r, --recursive` option, otherwise the command will fail. For example, if you want to delete the -entire `/en-US/Learn_web_development/Core/Accessibility` tree, you'd perform the following steps: +entire `/en-US/Web/HTTP/Authentication` tree, you'd perform the following steps: 1. You'll start a fresh branch to work in. @@ -142,7 +144,7 @@ entire `/en-US/Learn_web_development/Core/Accessibility` tree, you'd perform the 2. Perform the delete. ```bash - yarn content delete Learn_web_development/Core/Accessibility --recursive + yarn content delete Web/HTTP/Authentication --recursive ``` 3. Add a redirect. The target page can be an external URL or another page on MDN Web Docs. diff --git a/files/en-us/mdn/writing_guidelines/howto/document_a_css_property/index.md b/files/en-us/mdn/writing_guidelines/howto/document_a_css_property/index.md index 1576163eb447258..6b7c98d64e6a440 100644 --- a/files/en-us/mdn/writing_guidelines/howto/document_a_css_property/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/document_a_css_property/index.md @@ -1,11 +1,11 @@ --- 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. diff --git a/files/en-us/mdn/writing_guidelines/howto/document_an_http_header/index.md b/files/en-us/mdn/writing_guidelines/howto/document_an_http_header/index.md index b3ff3f7d894f539..00753858b0c21ce 100644 --- a/files/en-us/mdn/writing_guidelines/howto/document_an_http_header/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/document_an_http_header/index.md @@ -1,14 +1,13 @@ --- 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) on MDN Web Docs documents HTTP header fields. These are components of the header section of request and response messages in the Hypertext Transfer Protocol ([HTTP](/en-US/docs/Web/HTTP)). They define the operating parameters of an HTTP transaction. This article explains how to create a new reference page for an HTTP header. - -You will need to know or be able to dive into some [HTTP](/en-US/docs/Web/HTTP). +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. ## Step 1 – Determine the HTTP header to document @@ -26,7 +25,7 @@ You will need to know or be able to dive into some [HTTP](/en-US/docs/Web/HTTP). ## Step 3 – Create the HTTP header page -- All header pages live under this tree: [/docs/Web/HTTP/Headers/](/en-US/docs/Web/HTTP/Headers) +- All header pages live under this tree: [`files/en-us/web/http/headers`](https://github.com/mdn/content/tree/main/files/en-us/web/http/headers) - To create a new page, see the instructions in our [how to create a page](/en-US/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting) guide. ## Step 4 – Write the content diff --git a/files/en-us/mdn/writing_guidelines/howto/document_web_errors/index.md b/files/en-us/mdn/writing_guidelines/howto/document_web_errors/index.md index 1569b15f66375e3..9c3ee81430dc018 100644 --- a/files/en-us/mdn/writing_guidelines/howto/document_web_errors/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/document_web_errors/index.md @@ -1,11 +1,11 @@ --- 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). diff --git a/files/en-us/mdn/writing_guidelines/howto/images_media/index.md b/files/en-us/mdn/writing_guidelines/howto/images_media/index.md index a95aa982b7c4c9e..fa4ac4cb3f45c58 100644 --- a/files/en-us/mdn/writing_guidelines/howto/images_media/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/images_media/index.md @@ -1,11 +1,11 @@ --- 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 `` element. diff --git a/files/en-us/mdn/writing_guidelines/howto/index.md b/files/en-us/mdn/writing_guidelines/howto/index.md index 8b43137735ce181..e03343276118289 100644 --- a/files/en-us/mdn/writing_guidelines/howto/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/index.md @@ -1,14 +1,13 @@ --- -title: How-to guides +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 all the step-by-step information 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 more about _how to contribute_ (which happens through GitHub), see our [contribution guidelines](/en-US/docs/MDN/Community/Contributing). - -> [!NOTE] -> All the way through this section, we assume that you've read the contribution guidelines, are familiar with the `mdn/content` repository, and know how to use git and GitHub. +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. {{SubpagesWithSummaries}} diff --git a/files/en-us/mdn/writing_guidelines/howto/json_structured_data/index.md b/files/en-us/mdn/writing_guidelines/howto/json_structured_data/index.md index c74f9933ef30fbd..2f20a07279872f6 100644 --- a/files/en-us/mdn/writing_guidelines/howto/json_structured_data/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/json_structured_data/index.md @@ -1,11 +1,11 @@ --- 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. diff --git a/files/en-us/mdn/writing_guidelines/howto/markdown_in_mdn/index.md b/files/en-us/mdn/writing_guidelines/howto/markdown_in_mdn/index.md index c98ab71d56b8162..f9944de28ef05c9 100644 --- a/files/en-us/mdn/writing_guidelines/howto/markdown_in_mdn/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/markdown_in_mdn/index.md @@ -1,11 +1,11 @@ --- 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 diff --git a/files/en-us/mdn/writing_guidelines/howto/research_technology/index.md b/files/en-us/mdn/writing_guidelines/howto/research_technology/index.md index c1d631f2df38cbf..9337723b645e014 100644 --- a/files/en-us/mdn/writing_guidelines/howto/research_technology/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/research_technology/index.md @@ -1,11 +1,11 @@ --- 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 diff --git a/files/en-us/mdn/writing_guidelines/howto/write_a_new_entry_in_the_glossary/index.md b/files/en-us/mdn/writing_guidelines/howto/write_a_new_entry_in_the_glossary/index.md index 4adfd565b91fd2e..d18a0c9cae3e1a2 100644 --- a/files/en-us/mdn/writing_guidelines/howto/write_a_new_entry_in_the_glossary/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/write_a_new_entry_in_the_glossary/index.md @@ -1,11 +1,11 @@ --- -title: How to write an entry in the glossary +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. diff --git a/files/en-us/mdn/writing_guidelines/howto/write_an_api_reference/index.md b/files/en-us/mdn/writing_guidelines/howto/write_an_api_reference/index.md index dd543648e4d5a3e..c87cfffb9f4a8f5 100644 --- a/files/en-us/mdn/writing_guidelines/howto/write_an_api_reference/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/write_an_api_reference/index.md @@ -1,11 +1,11 @@ --- 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 diff --git a/files/en-us/mdn/writing_guidelines/howto/write_an_api_reference/information_contained_in_a_webidl_file/index.md b/files/en-us/mdn/writing_guidelines/howto/write_an_api_reference/information_contained_in_a_webidl_file/index.md index 4847eb330365092..3fecbaf1fb98300 100644 --- a/files/en-us/mdn/writing_guidelines/howto/write_an_api_reference/information_contained_in_a_webidl_file/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/write_an_api_reference/information_contained_in_a_webidl_file/index.md @@ -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. diff --git a/files/en-us/mdn/writing_guidelines/howto/write_an_api_reference/sidebars/index.md b/files/en-us/mdn/writing_guidelines/howto/write_an_api_reference/sidebars/index.md index 5173fe44de0ef70..93735d4620853f4 100644 --- a/files/en-us/mdn/writing_guidelines/howto/write_an_api_reference/sidebars/index.md +++ b/files/en-us/mdn/writing_guidelines/howto/write_an_api_reference/sidebars/index.md @@ -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. diff --git a/files/en-us/mdn/writing_guidelines/index.md b/files/en-us/mdn/writing_guidelines/index.md index 6dc73bf75f3cafc..9dd4182cd34398e 100644 --- a/files/en-us/mdn/writing_guidelines/index.md +++ b/files/en-us/mdn/writing_guidelines/index.md @@ -2,10 +2,9 @@ title: Writing guidelines slug: MDN/Writing_guidelines page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - MDN Web Docs is an open-source project. The sections outlined below describe our guidelines for _what_ we document and _how_ we do it on MDN Web Docs. To learn about _how to contribute_, see our [contribution guidelines](/en-US/docs/MDN/Community). - [What we write](/en-US/docs/MDN/Writing_guidelines/What_we_write) diff --git a/files/en-us/mdn/writing_guidelines/page_structures/banners_and_notices/index.md b/files/en-us/mdn/writing_guidelines/page_structures/banners_and_notices/index.md index a8a8a8841d640f6..c4676a7b15a8add 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/banners_and_notices/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/banners_and_notices/index.md @@ -2,10 +2,9 @@ title: Banners and notices slug: MDN/Writing_guidelines/Page_structures/Banners_and_notices page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - Banners and notices are displayed in some pages, in particular API reference, in order to highlight important factors that will affect how the described content is used. For example, banners are used to highlight when a particular interface, method or property is deprecated, and should not be used in production code, or can only be used in a secure context. diff --git a/files/en-us/mdn/writing_guidelines/page_structures/code_examples/index.md b/files/en-us/mdn/writing_guidelines/page_structures/code_examples/index.md index 7fcb3a1d208bb44..e47b815f72b7509 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/code_examples/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/code_examples/index.md @@ -2,10 +2,9 @@ title: Code examples slug: MDN/Writing_guidelines/Page_structures/Code_examples page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - On MDN, you'll see numerous code examples inserted throughout the pages to demonstrate usage of web platform features. This article discusses the different mechanisms available for adding code examples to pages, along with which ones you should use and when. > [!NOTE] diff --git a/files/en-us/mdn/writing_guidelines/page_structures/compatibility_tables/index.md b/files/en-us/mdn/writing_guidelines/page_structures/compatibility_tables/index.md index 55c8a6f319b0197..7f23e41aafdf521 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/compatibility_tables/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/compatibility_tables/index.md @@ -3,10 +3,9 @@ title: Compatibility tables and the browser compatibility data repository (BCD) slug: MDN/Writing_guidelines/Page_structures/Compatibility_tables page-type: mdn-writing-guide browser-compat: api.AbortController +sidebar: mdnsidebar --- -{{MDNSidebar}} - MDN has a standard format for tables that illustrate compatibility of shared technologies across all browsers, such as DOM, HTML, CSS, JavaScript, SVG, etc. To make this data available in multiple projects programmatically, a Node.js package is built from the [browser-compat-data repository](https://github.com/mdn/browser-compat-data) and published to npm. diff --git a/files/en-us/mdn/writing_guidelines/page_structures/feature_status/index.md b/files/en-us/mdn/writing_guidelines/page_structures/feature_status/index.md index 4bfbe227ee214c8..c1ffa9ba5434efd 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/feature_status/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/feature_status/index.md @@ -2,10 +2,9 @@ title: Feature status slug: MDN/Writing_guidelines/Page_structures/Feature_status page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - A feature status provides developers with information about the implementation stage of the feature among browser vendors and is one of the following: - [`experimental`](https://github.com/mdn/browser-compat-data/blob/main/docs/data-guidelines/index.md#setting-experimental) diff --git a/files/en-us/mdn/writing_guidelines/page_structures/index.md b/files/en-us/mdn/writing_guidelines/page_structures/index.md index 58a3d9b87d0d864..048390e003692f8 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/index.md @@ -2,10 +2,9 @@ title: Page structures slug: MDN/Writing_guidelines/Page_structures page-type: landing-page +sidebar: mdnsidebar --- -{{MDNSidebar}} - Throughout MDN there are document structures that are used to provide consistent presentation of information in MDN articles. This page lists articles describing these structures so that you can modify page content appropriately for the documents you write, edit, or translate. diff --git a/files/en-us/mdn/writing_guidelines/page_structures/links/index.md b/files/en-us/mdn/writing_guidelines/page_structures/links/index.md index c038fbe868a518a..db8a353ed521482 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/links/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/links/index.md @@ -2,10 +2,9 @@ title: Link macros slug: MDN/Writing_guidelines/Page_structures/Links page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - MDN provides numerous macros to create always up-to-date links to MDN content. In this guide, you will learn about MDN cross-reference macros that you can use to include a single link to another page or a list of links to all of a document's subpages. ## Lists of links diff --git a/files/en-us/mdn/writing_guidelines/page_structures/live_samples/index.md b/files/en-us/mdn/writing_guidelines/page_structures/live_samples/index.md index e24e63d044139c0..ce51b60eedfe247 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/live_samples/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/live_samples/index.md @@ -2,10 +2,9 @@ title: Live examples slug: MDN/Writing_guidelines/Page_structures/Live_samples page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - MDN supports displaying code blocks within the articles as _live samples_, enabling readers to see both the code and its output as it would look on a web page. This feature allows readers to understand exactly what the executed code would produce, making the documentation dynamic and instructive. It also allows authors to be absolutely sure that the code blocks in documentation have the expected output, and work appropriately when used with different browsers. diff --git a/files/en-us/mdn/writing_guidelines/page_structures/macros/commonly_used_macros/index.md b/files/en-us/mdn/writing_guidelines/page_structures/macros/commonly_used_macros/index.md index cef410e3683fd26..e166c3afc8ce18b 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/macros/commonly_used_macros/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/macros/commonly_used_macros/index.md @@ -2,10 +2,9 @@ title: Commonly-used macros slug: MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - This page lists many of the general-purpose macros created for use on MDN. For additional how-to information on using these macros, see [Using macros](/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros). diff --git a/files/en-us/mdn/writing_guidelines/page_structures/macros/index.md b/files/en-us/mdn/writing_guidelines/page_structures/macros/index.md index 480f52264531267..4fb6fac3bb4a384 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/macros/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/macros/index.md @@ -2,10 +2,9 @@ title: Using macros slug: MDN/Writing_guidelines/Page_structures/Macros page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - The [Yari](https://github.com/mdn/yari) platform on which MDN runs provides a macro system, [KumaScript](https://github.com/mdn/yari/tree/main/docs/kumascript), which makes it possible to automate certain tasks. This article provides information on how to invoke MDN's macros within articles. The [KumaScript guide](https://github.com/mdn/yari/blob/main/docs/kumascript/README.md) provides an in-depth look at how to use macros on MDN, so this section is more of a brief overview. diff --git a/files/en-us/mdn/writing_guidelines/page_structures/macros/other/index.md b/files/en-us/mdn/writing_guidelines/page_structures/macros/other/index.md index 32e06cbe981bba1..f904838a58e6b90 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/macros/other/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/macros/other/index.md @@ -2,10 +2,9 @@ title: Other macros slug: MDN/Writing_guidelines/Page_structures/Macros/Other page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - In contrast to the macros listed in [Commonly-used macros](/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros), the macros documented in this article are used infrequently or only in specific contexts, or are deprecated. ## Special contexts diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_constructor_subpage_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_constructor_subpage_template/index.md index 746b185469e1d90..e5442f628afe28f 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_constructor_subpage_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_constructor_subpage_template/index.md @@ -2,10 +2,9 @@ title: API constructor subpage template slug: MDN/Writing_guidelines/Page_structures/Page_types/API_constructor_subpage_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this whole explanatory note before publishing_ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_event_subpage_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_event_subpage_template/index.md index 1ab27ce87532110..55565ad2bc9f981 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_event_subpage_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_event_subpage_template/index.md @@ -2,10 +2,9 @@ title: API event subpage template slug: MDN/Writing_guidelines/Page_structures/Page_types/API_event_subpage_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this whole explanatory note before publishing._ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md index ce5dcbd03bf9113..07c9f024b09a6f0 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md @@ -2,10 +2,9 @@ title: API landing page template slug: MDN/Writing_guidelines/Page_structures/Page_types/API_landing_page_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this whole explanatory note before publishing_ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md index ad9e1f090cf433d..3447459a8540192 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md @@ -2,10 +2,9 @@ title: API method subpage template slug: MDN/Writing_guidelines/Page_structures/Page_types/API_method_subpage_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this whole explanatory note before publishing._ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_property_subpage_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_property_subpage_template/index.md index cfc96467b610bfa..52ab37a27990782 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_property_subpage_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_property_subpage_template/index.md @@ -2,10 +2,9 @@ title: API property subpage template slug: MDN/Writing_guidelines/Page_structures/Page_types/API_property_subpage_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this whole explanatory note before publishing._ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_reference_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_reference_page_template/index.md index ad2a762483c4b76..0fd8362b0cae2e2 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_reference_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_reference_page_template/index.md @@ -2,10 +2,9 @@ title: API reference page template slug: MDN/Writing_guidelines/Page_structures/Page_types/API_reference_page_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this whole explanatory note before publishing._ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/aria_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/aria_page_template/index.md index ed1bd7e7c0854ea..ef2216073023213 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/aria_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/aria_page_template/index.md @@ -2,10 +2,9 @@ title: ARIA page template slug: MDN/Writing_guidelines/Page_structures/Page_types/ARIA_Page_Template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - ## Page front matter ### Title and slug diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_function_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_function_page_template/index.md index 844a3c17aad236c..1f940ecb877b01f 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_function_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_function_page_template/index.md @@ -2,10 +2,9 @@ title: CSS function page template slug: MDN/Writing_guidelines/Page_structures/Page_types/CSS_function_page_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this note block before publishing._ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_module_landing_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_module_landing_page_template/index.md index 0e06f9cf50be5f2..0c96ba587ab4b95 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_module_landing_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_module_landing_page_template/index.md @@ -2,10 +2,9 @@ title: CSS module landing page template slug: MDN/Writing_guidelines/Page_structures/Page_types/CSS_module_landing_page_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remember to remove this note block before publishing._ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_property_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_property_page_template/index.md index 7f4d8a948333a04..d23b2484812c0bd 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_property_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_property_page_template/index.md @@ -2,10 +2,9 @@ title: CSS property page template slug: MDN/Writing_guidelines/Page_structures/Page_types/CSS_property_page_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this note block before publishing._ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_selector_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_selector_page_template/index.md index d82678690ea26d8..5bbdb888de5a9e3 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_selector_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/css_selector_page_template/index.md @@ -2,10 +2,9 @@ title: CSS selector page template slug: MDN/Writing_guidelines/Page_structures/Page_types/CSS_selector_page_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this whole explanatory note before publishing_ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/glossary_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/glossary_page_template/index.md index 157535574a122ff..43b6f5afdcef3fa 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/glossary_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/glossary_page_template/index.md @@ -2,10 +2,9 @@ title: Glossary page template slug: MDN/Writing_guidelines/Page_structures/Page_types/Glossary_page_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this whole explanatory note before publishing_ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/html_element_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/html_element_page_template/index.md index 7c1e5643ba20174..72d8c0e8410c2c4 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/html_element_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/html_element_page_template/index.md @@ -2,10 +2,9 @@ title: HTML element page template slug: MDN/Writing_guidelines/Page_structures/Page_types/HTML_element_page_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this whole explanatory note before publishing_ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/http_header_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/http_header_page_template/index.md index 02457e4a72b7708..9e49445a0d34173 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/http_header_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/http_header_page_template/index.md @@ -2,10 +2,9 @@ title: HTTP header page template slug: MDN/Writing_guidelines/Page_structures/Page_types/HTTP_header_page_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this whole explanatory note before publishing_ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/index.md index 48193181540302a..053713bbb406f3d 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/index.md @@ -2,10 +2,9 @@ title: Page types slug: MDN/Writing_guidelines/Page_structures/Page_types page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - There are a number of types of pages that are used repeatedly on MDN. This article describes these page types, their purpose, and gives examples of each and templates to use when creating a new page. @@ -242,7 +241,7 @@ The list of subpages can be generated automatically using the [`SubpagesWithSumm - [Web APIs](/en-US/docs/Web/API) - [JavaScript](/en-US/docs/Web/JavaScript) - [Learn web development](/en-US/docs/Learn_web_development) -- [Contributing to MDN](/en-US/docs/MDN/Community/Contributing) +- [Community resources](/en-US/docs/MDN/Community) ## See also diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/page_type_key/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/page_type_key/index.md index 2f7155887239e1f..1b1e4be3701f9df 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/page_type_key/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/page_type_key/index.md @@ -2,10 +2,9 @@ title: The page-type front matter key slug: MDN/Writing_guidelines/Page_structures/Page_types/Page_type_key page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - The `page-type` front matter key describes the type of an MDN page. This allows MDN content tools to better automate content checking and sidebar organization. diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/svg_element_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/svg_element_page_template/index.md index c51435954a47d29..62f6677a59dae11 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/svg_element_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/svg_element_page_template/index.md @@ -2,10 +2,9 @@ title: SVG element page template slug: MDN/Writing_guidelines/Page_structures/Page_types/SVG_element_page_template page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - > **Note:** _Remove this whole explanatory note before publishing_ > > --- diff --git a/files/en-us/mdn/writing_guidelines/page_structures/sidebars/index.md b/files/en-us/mdn/writing_guidelines/page_structures/sidebars/index.md index 776d61864358d9e..e5a8ed863776c58 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/sidebars/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/sidebars/index.md @@ -2,10 +2,9 @@ title: Sidebars slug: MDN/Writing_guidelines/Page_structures/Sidebars page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - MDN pages all include sidebars. Most of them are created using a standard system that defines data structures in YAML files, and includes sidebars on pages using macro calls. In this guide, you will learn how these sidebars work so you can edit existing sidebars and create new ones as required. We'll also detail those that don't yet use the standard system. @@ -141,11 +140,11 @@ sidebar: - title: contributing_to_mdn_web_docs details: closed children: - - /MDN/Community/Contributing - - /MDN/Community/Contributing/Getting_started - - /MDN/Community/Contributing/Our_repositories - - /MDN/Community/Contributing/Translated_content - - /MDN/Community/Contributing/Security_vulnerability_response + - /MDN/Community + - /MDN/Community/Getting_started + - /MDN/Community/Our_repositories + - /MDN/Community/Translated_content + - /MDN/Community/Security_vulnerability_response - /MDN/Community/Open_source_etiquette - /MDN/Community/Communication_channels - /MDN/Community/Discussions diff --git a/files/en-us/mdn/writing_guidelines/page_structures/specification_tables/index.md b/files/en-us/mdn/writing_guidelines/page_structures/specification_tables/index.md index 5fdb816a2d023ed..e39c2320a00ec16 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/specification_tables/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/specification_tables/index.md @@ -3,10 +3,9 @@ title: Specification tables slug: MDN/Writing_guidelines/Page_structures/Specification_tables page-type: mdn-writing-guide browser-compat: css.properties.text-align +sidebar: mdnsidebar --- -{{MDNSidebar}} - Every reference page on MDN should provide information about the specification or specifications in which that API or technology was defined. This article demonstrates what these tables look like and explains how to add them. The specifications section definition is similar to the [compatibility table](/en-US/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables) definition, is commonly generated from the same data source, and typically appears immediately before it in a page. diff --git a/files/en-us/mdn/writing_guidelines/page_structures/syntax_sections/index.md b/files/en-us/mdn/writing_guidelines/page_structures/syntax_sections/index.md index d05bd6f85bc1318..bdd8649384a3a3f 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/syntax_sections/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/syntax_sections/index.md @@ -2,10 +2,9 @@ title: Syntax sections slug: MDN/Writing_guidelines/Page_structures/Syntax_sections page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - The syntax section of an MDN reference page contains a syntax box defining the exact syntax that a feature has (e.g. what parameters can it accept, which ones are optional?) This article explains how to write syntax boxes for reference articles. ## API reference syntax diff --git a/files/en-us/mdn/writing_guidelines/what_we_write/criteria_for_inclusion/index.md b/files/en-us/mdn/writing_guidelines/what_we_write/criteria_for_inclusion/index.md index 9ce766a17650b46..61cd7f3bddab570 100644 --- a/files/en-us/mdn/writing_guidelines/what_we_write/criteria_for_inclusion/index.md +++ b/files/en-us/mdn/writing_guidelines/what_we_write/criteria_for_inclusion/index.md @@ -2,10 +2,9 @@ title: Criteria for inclusion on MDN Web Docs slug: MDN/Writing_guidelines/What_we_write/Criteria_for_inclusion page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - This article describes, in detail, criteria for content to be included on MDN Web Docs, the application process for including new documentation, and expectations and guidelines for a party applying. This is aimed at larger projects. To suggest a new page or article, please refer to the [Suggesting content](/en-US/docs/MDN/Writing_guidelines/What_we_write#suggesting_content) section on the "What we write" page. diff --git a/files/en-us/mdn/writing_guidelines/what_we_write/index.md b/files/en-us/mdn/writing_guidelines/what_we_write/index.md index 34a966659256e56..6dfebd2621646d2 100644 --- a/files/en-us/mdn/writing_guidelines/what_we_write/index.md +++ b/files/en-us/mdn/writing_guidelines/what_we_write/index.md @@ -2,10 +2,9 @@ title: What we write slug: MDN/Writing_guidelines/What_we_write page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - MDN Web Docs contains _browser-neutral_ documentation that enables web developers to write _browser-agnostic_ code. In this article, you'll find information about whether or not a given topic and/or type of content should be included on MDN Web Docs. ## Editorial Policies diff --git a/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/css/index.md b/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/css/index.md index 0b91f2d74477541..f2d84d3bd3ae9cb 100644 --- a/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/css/index.md +++ b/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/css/index.md @@ -2,10 +2,9 @@ title: Guidelines for writing CSS code examples slug: MDN/Writing_guidelines/Writing_style_guide/Code_style_guide/CSS page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - The following guidelines cover how to write CSS example code for MDN Web Docs. ## General guidelines for CSS code examples diff --git a/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/html/index.md b/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/html/index.md index 83794a636f28e20..aea592d80641f61 100644 --- a/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/html/index.md +++ b/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/html/index.md @@ -2,10 +2,9 @@ title: Guidelines for writing HTML code examples slug: MDN/Writing_guidelines/Writing_style_guide/Code_style_guide/HTML page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - The following guidelines cover how to write HTML example code for MDN Web Docs. ## General guidelines for HTML code examples diff --git a/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/index.md b/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/index.md index 887206f9afd81de..64d1c61d760bb5a 100644 --- a/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/index.md +++ b/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/index.md @@ -2,10 +2,9 @@ title: Guidelines for writing code examples slug: MDN/Writing_guidelines/Writing_style_guide/Code_style_guide page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - The guidelines described in this article apply to the styling and formatting of code examples, irrespective of the language. For guidelines about what content to include while writing the code examples, see the [writing style guide](/en-US/docs/MDN/Writing_guidelines/Writing_style_guide#code_examples). For technology-specific guidelines, see the following articles: diff --git a/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/javascript/index.md b/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/javascript/index.md index 1424f173b127f46..556adbecfe9db7a 100644 --- a/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/javascript/index.md +++ b/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/javascript/index.md @@ -2,10 +2,9 @@ title: Guidelines for writing JavaScript code examples slug: MDN/Writing_guidelines/Writing_style_guide/Code_style_guide/JavaScript page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - The following guidelines cover writing JavaScript example code for MDN Web Docs. This article is a list of rules for writing concise examples that will be understandable by as many people as possible. ## General guidelines for JavaScript code examples diff --git a/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/shell/index.md b/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/shell/index.md index c13aa8d6224541c..532bcd874d39886 100644 --- a/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/shell/index.md +++ b/files/en-us/mdn/writing_guidelines/writing_style_guide/code_style_guide/shell/index.md @@ -2,10 +2,9 @@ title: Guidelines for writing shell prompt code examples slug: MDN/Writing_guidelines/Writing_style_guide/Code_style_guide/Shell page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - The following guidelines cover how to write Shell prompt code examples for MDN Web Docs. ## What is a "shell" diff --git a/files/en-us/mdn/writing_guidelines/writing_style_guide/index.md b/files/en-us/mdn/writing_guidelines/writing_style_guide/index.md index b9bed4b5324909b..0f56a973678139a 100644 --- a/files/en-us/mdn/writing_guidelines/writing_style_guide/index.md +++ b/files/en-us/mdn/writing_guidelines/writing_style_guide/index.md @@ -1,11 +1,11 @@ --- title: Writing style guide +short-title: Style guide slug: MDN/Writing_guidelines/Writing_style_guide page-type: mdn-writing-guide +sidebar: mdnsidebar --- -{{MDNSidebar}} - This writing style guide describes how content should be written, organized, spelled, and formatted on MDN Web Docs. These guidelines are for ensuring language and style consistency across the website. That said, we are more interested in content rather than its formatting, so don't feel obligated to learn the entire writing style guide before contributing. Do not be upset or surprised, however, if another contributor later edits your work to conform to this guide. The reviewers might also point you to this style guide when you submit a content pull request. diff --git a/files/sidebars/cssref.yaml b/files/sidebars/cssref.yaml index b0c2fe42b237ab2..4636249ec503933 100644 --- a/files/sidebars/cssref.yaml +++ b/files/sidebars/cssref.yaml @@ -57,51 +57,51 @@ sidebar: link: /Web/CSS/Reference - type: listSubPages path: /Web/CSS - title: Modules tags: css-module + title: Modules details: closed - type: listSubPagesGrouped path: /Web/CSS - title: Properties tags: - css-property - css-shorthand-property + title: Properties details: closed - type: listSubPages path: /Web/CSS - title: Selectors tags: css-selector + title: Selectors details: closed - type: listSubPages path: /Web/CSS - title: Combinators tags: css-combinator + title: Combinators details: closed - type: listSubPages path: /Web/CSS - title: Pseudo-classes tags: css-pseudo-class + title: Pseudo-classes details: closed - type: listSubPages path: /Web/CSS - title: Pseudo-elements tags: css-pseudo-element + title: Pseudo-elements details: closed - type: listSubPages path: /Web/CSS - title: At-rules tags: css-at-rule + title: At-rules details: closed - type: listSubPages path: /Web/CSS - title: Functions tags: css-function - details: closed depth: 2 + title: Functions + details: closed - type: listSubPages path: /Web/CSS - title: Types tags: css-type + title: Types details: closed - type: section title: Guides diff --git a/files/sidebars/jssidebar.yaml b/files/sidebars/jssidebar.yaml index 78ce9026453f224..4e89223f9b318c5 100644 --- a/files/sidebars/jssidebar.yaml +++ b/files/sidebars/jssidebar.yaml @@ -89,39 +89,39 @@ sidebar: title: Reference - type: listSubPages path: /Web/JavaScript/Reference/Global_Objects + includeParent: true title: Global_Objects details: closed - includeParent: true - type: listSubPages path: /Web/JavaScript/Reference/Operators + includeParent: true title: Operators details: closed - includeParent: true - type: listSubPages path: /Web/JavaScript/Reference/Statements + includeParent: true title: Statements details: closed - includeParent: true - type: listSubPages path: /Web/JavaScript/Reference/Functions + includeParent: true title: Functions details: closed - includeParent: true - type: listSubPages path: /Web/JavaScript/Reference/Classes + includeParent: true title: Classes details: closed - includeParent: true - type: listSubPages path: /Web/JavaScript/Reference/Regular_expressions + includeParent: true title: Guide_RegExp details: closed - includeParent: true - type: listSubPages path: /Web/JavaScript/Reference/Errors + includeParent: true title: Errors details: closed - includeParent: true - title: More details: closed children: diff --git a/files/sidebars/mdnsidebar.yaml b/files/sidebars/mdnsidebar.yaml index 347ad7c5300bbfb..00038b9493891ee 100644 --- a/files/sidebars/mdnsidebar.yaml +++ b/files/sidebars/mdnsidebar.yaml @@ -3,150 +3,86 @@ sidebar: - type: section link: /MDN - - title: community_guidelines + - title: community_resources details: closed children: - /MDN/Community - - title: contributing_to_mdn_web_docs - details: closed - children: - - /MDN/Community/Contributing - - /MDN/Community/Contributing/Getting_started - - /MDN/Community/Contributing/Our_repositories - - /MDN/Community/Contributing/Translated_content - - /MDN/Community/Contributing/Security_vulnerability_response + - /MDN/Community/Getting_started + - /MDN/Community/Our_repositories - /MDN/Community/Open_source_etiquette - - /MDN/Community/Communication_channels - - /MDN/Community/Discussions - - /MDN/Community/Learn_forum - /MDN/Community/Issues - /MDN/Community/Pull_requests + - /MDN/Community/Discussions + - /MDN/Community/Translated_content - /MDN/Community/Roles_teams + - /MDN/Community/Communication_channels + - /MDN/Community/Learn_forum - title: writing_guide details: closed children: - /MDN/Writing_guidelines - /MDN/Writing_guidelines/What_we_write - /MDN/Writing_guidelines/Writing_style_guide - - title: how_to_guides + - /MDN/Writing_guidelines/Experimental_deprecated_obsolete + - /MDN/Writing_guidelines/Attrib_copyright_license + - type: listSubPages + path: /MDN/Writing_guidelines/Howto + includeParent: true + title: how_to_guides details: closed - children: - - /MDN/Writing_guidelines/Howto - - /MDN/Writing_guidelines/Howto/Images_media - - /MDN/Writing_guidelines/Howto/Creating_moving_deleting - - /MDN/Writing_guidelines/Howto/Document_a_CSS_property - - /MDN/Writing_guidelines/Howto/Document_an_HTTP_header - - /MDN/Writing_guidelines/Howto/Document_web_errors - - /MDN/Writing_guidelines/Howto/Research_technology - - /MDN/Writing_guidelines/Howto/JSON_Structured_data - - /MDN/Writing_guidelines/Howto/Write_an_api_reference - - /MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary - - /MDN/Writing_guidelines/Howto/Markdown_in_MDN - - title: page_structures + - type: listSubPages + path: /MDN/Writing_guidelines/Page_structures + includeParent: true + title: page_structures details: closed - children: - - /MDN/Writing_guidelines/Page_structures - - /MDN/Writing_guidelines/Page_structures/Banners_and_notices - - /MDN/Writing_guidelines/Page_structures/Code_examples - - /MDN/Writing_guidelines/Page_structures/Compatibility_tables - - /MDN/Writing_guidelines/Page_structures/Live_samples - - /MDN/Writing_guidelines/Page_structures/Page_types - - /MDN/Writing_guidelines/Page_structures/Sidebars - - /MDN/Writing_guidelines/Page_structures/Specification_tables - - /MDN/Writing_guidelines/Page_structures/Syntax_sections - - /MDN/Writing_guidelines/Page_structures/Macros - - /MDN/Writing_guidelines/Page_structures/Feature_status - - /MDN/Writing_guidelines/Attrib_copyright_license - - /MDN/Writing_guidelines/Experimental_deprecated_obsolete - - title: advisory_board - details: closed - children: - - /MDN/MDN_Product_Advisory_Board - - /MDN/MDN_Product_Advisory_Board/Membership - - title: history - details: closed - children: - - /MDN/At_ten - - /MDN/At_ten/History_of_MDN - - /MDN/Changelog l10n: de: - history: Geschichte - advisory_board: Product Advisory Board - community_guidelines: Gemeinschaftsrichtlinien - contributing_to_mdn_web_docs: Beiträge zu MDN Web Docs + community_resources: Gemeinschaftsrichtlinien writing_guide: Schreibanleitung how_to_guides: Anleitungen page_structures: Seitenstrukturen en-US: - history: History - advisory_board: Advisory Board - community_guidelines: Community guidelines - contributing_to_mdn_web_docs: Contributing to MDN Web Docs + community_resources: Community resources writing_guide: Writing guidelines how_to_guides: How-to guides page_structures: Page structures es: - history: History - advisory_board: Advisory Board - community_guidelines: Community guidelines - contributing_to_mdn_web_docs: Contributing to MDN Web Docs + community_resources: Community resources writing_guide: Writing guidelines how_to_guides: How-to guides page_structures: Page structures fr: - history: History - advisory_board: Advisory Board - community_guidelines: Règles de la communauté - contributing_to_mdn_web_docs: Contributing to MDN Web Docs + community_resources: Règles de la communauté writing_guide: Writing guidelines how_to_guides: How-to guides page_structures: Page structures ja: - history: History - advisory_board: Advisory Board - community_guidelines: Community guidelines - contributing_to_mdn_web_docs: Contributing to MDN Web Docs + community_resources: Community resources writing_guide: Writing guidelines how_to_guides: How-to guides page_structures: Page structures ko: - history: History - advisory_board: Advisory Board - community_guidelines: 커뮤니티 지침 - contributing_to_mdn_web_docs: MDN에 기여하기 + community_resources: 커뮤니티 지침 writing_guide: Writing guidelines how_to_guides: How-to guides page_structures: Page structures pt-BR: - history: History - advisory_board: Advisory Board - community_guidelines: Community guidelines - contributing_to_mdn_web_docs: Contributing to MDN Web Docs + community_resources: Community resources writing_guide: Writing guidelines how_to_guides: How-to guides page_structures: Page structures ru: - history: History - advisory_board: Advisory Board - community_guidelines: Community guidelines - contributing_to_mdn_web_docs: Contributing to MDN Web Docs + community_resources: Community resources writing_guide: Writing guidelines how_to_guides: How-to guides page_structures: Page structures zh-CN: - history: History - advisory_board: Advisory Board - community_guidelines: 社区指南 - contributing_to_mdn_web_docs: 为 MDN 做贡献 + community_resources: 社区指南 writing_guide: 撰写指南 how_to_guides: MDN 写作指南 page_structures: 页面结构 zh-TW: - history: History - advisory_board: Advisory Board - community_guidelines: Community guidelines - contributing_to_mdn_web_docs: Contributing to MDN Web Docs + community_resources: Community resources writing_guide: Writing guidelines how_to_guides: How-to guides page_structures: Page structures