Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DO NOT SQUASH MERGE] Mdn folder to markdown conversion #9589

Closed
wants to merge 23 commits into from

Conversation

Rumyra
Copy link
Collaborator

@Rumyra Rumyra commented Oct 5, 2021

Summary

The /mdn/ folder converted to markdown

Related issues

Fixes #9106

Metadata

  • Adds a new document
  • Rewrites (or significantly expands) a document
  • Fixes a typo, bug, or other error

I reviewed all the pages and they all render ok 👍

@Rumyra Rumyra requested a review from a team as a code owner October 5, 2021 16:59
@Rumyra Rumyra requested review from sideshowbarker and wbamberg and removed request for a team and sideshowbarker October 5, 2021 16:59
@github-actions github-actions bot added the Content:Other Any docs not covered by another "Content:" label label Oct 5, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2021

Preview URLs

Flaws

Note! 62 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/MDN/Guidelines/Code_guidelines/HTML
Title: HTML guidelines
on GitHub
Flaw count: 14

  • broken_links:
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page
    • and 9 more flaws omitted

URL: /en-US/docs/MDN/Guidelines/Code_guidelines/CSS
Title: CSS guidelines
on GitHub
Flaw count: 18

  • broken_links:
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page
    • and 13 more flaws omitted

URL: /en-US/docs/MDN/Guidelines/Code_guidelines/General
Title: General guidelines for all code
on GitHub
Flaw count: 10

  • broken_links:
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page
    • and 5 more flaws omitted

URL: /en-US/docs/MDN/Guidelines/Conventions_definitions
Title: MDN conventions and definitions
on GitHub
Flaw count: 5

  • broken_links:
    • Can't resolve /en-US/docs/Archive
    • Can't resolve /en-US/docs/Archive/B2G_OS
    • Can't resolve /en-US/docs/Web/API/SharedKeyframeList
    • Can't resolve /en-US/docs/Web/API/SharedKeyframeList/SharedKeyframeList
    • Can't resolve /en-US/docs/Archive

URL: /en-US/docs/MDN/Guidelines/Does_this_belong_on_MDN
Title: Does this belong on MDN Web Docs?
on GitHub
Flaw count: 3

  • broken_links:
    • Can't resolve /en-US/docs/Mozilla/Developer_guide/Build_Instructions
    • Can't resolve /en-US/docs/Mozilla/Gecko
    • Can't resolve /en-US/docs/Mozilla/Projects/SpiderMonkey

URL: /en-US/docs/MDN/Structures/Page_types/API_reference_page_template
Title: API reference page template
on GitHub
Flaw count: 10

  • macros:
    • /en-us/docs/web/api/mdn (url: /en-US/docs/Web/API/MDN) does not exist
    • /en-US/docs/Web/API/NameOfTheInterface/NameOfTheInterface does not exist
    • /en-US/docs/Web/API/NameOfTheInterface does not exist
    • /en-US/docs/Web/API/NameOfParentInterface does not exist
    • /en-US/docs/Web/API/NameOfTheInterface/property1 does not exist
    • and 4 more flaws omitted
  • bad_bcd_queries:
    • No BCD data for query: path.to.feature.NameOfTheInterface

URL: /en-US/docs/MDN/Structures/Macros/Other
Title: Other macros
on GitHub
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Mozilla/Developer_guide/Source_Code/CVS
    • Can't resolve /en-US/docs/Mozilla/Developer_guide/mozilla-central

URL: /en-US/docs/MDN/About
Title: About MDN Web Docs
on GitHub
Flaw count: 2

  • broken_links:
    • Link points to the page it's already on
    • Can't resolve /Archive/Meta_docs/Examples/Alternate_License_Block

URL: /en-US/docs/MDN/Contribute/Changelog
Title: MDN contribution changelog
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/MDN/Contribute/Documentation_priorities
Title: MDN documentation priority list
on GitHub
Flaw count: 4

  • broken_links:
    • Can't resolve /en-US/docs/Web/Houdini
    • Can't resolve /en-US/docs/Web/API/NavigatorLanguage
    • Can't resolve /en-US/docs/Web/API/NavigatorOnLine
    • Can't resolve /en-US/docs/Web/API/URLUtilsReadOnly

URL: /en-US/docs/MDN/Contribute/Howto/Write_an_API_reference/Sidebars
Title: API reference sidebars
on GitHub
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/API/Detecting_device_orientation
    • Can't resolve /en-US/docs/Web/API/RTCSessionDescriptionCallback

URL: /en-US/docs/MDN/Contribute/Howto/Write_an_API_reference/Information_contained_in_a_WebIDL_file
Title: Information contained in a WebIDL file
on GitHub
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Mozilla/WebIDL_bindings
    • Can't resolve /en-US/docs/Mozilla/WebIDL_bindings#Exposed

URL: /en-US/docs/MDN/Contribute/Howto/Write_for_SEO
Title: How to write with SEO in mind on MDN Web Docs
on GitHub
Flaw count: 2

  • broken_links:
    • No need for the pathname in anchor links if it's the same page
    • No need for the pathname in anchor links if it's the same page

URL: /en-US/docs/MDN/Contribute/Processes/Matching_features_to_browser_version
Title: Matching web features to browser release version numbers
on GitHub
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Archive/Mozilla/XPIDL

URL: /en-US/docs/MDN/Tools/KumaScript
Title: KumaScript
on GitHub
Flaw count: 2

  • sectioning:
    • Excess <h2> tag that is NOT at root-level (id='Tips_and_caveats', text='Tips and caveats')
    • Excess <h2> tag that is NOT at root-level (id='Cookbook', text='Cookbook')

URL: /en-US/docs/MDN/Tools/Unsupported_GET_API
Title: Unsupported GET API
on GitHub
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/API/Fetch_API/Using_Fetch/index.json

External URLs

URL: /en-US/docs/MDN
Title: The MDN project
on GitHub


URL: /en-US/docs/MDN/Yari
Title: Yari: MDN's rendering platform
on GitHub


URL: /en-US/docs/MDN/Guidelines
Title: Guidelines
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Guidelines/Writing_style_guide
Title: Writing style guide
on GitHub


URL: /en-US/docs/MDN/Guidelines/Code_guidelines
Title: Code example guidelines
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Guidelines/Code_guidelines/HTML
Title: HTML guidelines
on GitHub


URL: /en-US/docs/MDN/Guidelines/Code_guidelines/Shell
Title: Shell prompt guidelines
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Guidelines/Code_guidelines/CSS
Title: CSS guidelines
on GitHub


URL: /en-US/docs/MDN/Guidelines/Code_guidelines/General
Title: General guidelines for all code
on GitHub


URL: /en-US/docs/MDN/Guidelines/Code_guidelines/JavaScript
Title: JavaScript guidelines
on GitHub


URL: /en-US/docs/MDN/Guidelines/Conventions_definitions
Title: MDN conventions and definitions
on GitHub


URL: /en-US/docs/MDN/Guidelines/Video
Title: Video content on MDN
on GitHub


URL: /en-US/docs/MDN/Guidelines/Editorial
Title: Editorial policies
on GitHub


URL: /en-US/docs/MDN/Guidelines/CSS_style_guide
Title: Guide to classes and styles used in MDN content
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Guidelines/Does_this_belong_on_MDN
Title: Does this belong on MDN Web Docs?
on GitHub


URL: /en-US/docs/MDN/At_ten
Title: MDN at 10
on GitHub

No new external URLs


URL: /en-US/docs/MDN/At_ten/History_of_MDN
Title: The History of MDN
on GitHub


URL: /en-US/docs/MDN/Structures
Title: Document structures
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Structures/Code_examples
Title: Code examples
on GitHub


URL: /en-US/docs/MDN/Structures/Page_types
Title: Page types
on GitHub


URL: /en-US/docs/MDN/Structures/Page_types/API_reference_page_template
Title: API reference page template
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Structures/Page_types/Glossary_page_template
Title: Glossary page template
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Structures/Page_types/ARIA_Page_Template
Title: ARIA page template
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Structures/Specification_tables
Title: Specification tables
on GitHub


URL: /en-US/docs/MDN/Structures/Live_samples
Title: Live samples
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Structures/Compatibility_tables
Title: Compatibility tables and the browser compatibility data repository (BCD)
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Structures/Banners_and_notices
Title: Banners and notices
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Structures/Syntax_sections
Title: Syntax sections
on GitHub


URL: /en-US/docs/MDN/Structures/Quicklinks
Title: Quicklinks
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Structures/Macros
Title: Using macros
on GitHub


URL: /en-US/docs/MDN/Structures/Macros/Commonly-used_macros
Title: Commonly-used macros
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Structures/Macros/Other
Title: Other macros
on GitHub

No new external URLs


URL: /en-US/docs/MDN/MDN_Product_Advisory_Board
Title: MDN Product Advisory Board
on GitHub


URL: /en-US/docs/MDN/MDN_Product_Advisory_Board/Membership
Title: Product Advisory Board Charter & Membership
on GitHub


URL: /en-US/docs/MDN/MDN_Product_Advisory_Board/Members
Title: Product Advisory Board Members
on GitHub


URL: /en-US/docs/MDN/About
Title: About MDN Web Docs
on GitHub


URL: /en-US/docs/MDN/Contribute
Title: Contributing to MDN
on GitHub


URL: /en-US/docs/MDN/Contribute/Changelog
Title: MDN contribution changelog
on GitHub


URL: /en-US/docs/MDN/Contribute/GitHub_beginners
Title: GitHub for complete beginners
on GitHub


URL: /en-US/docs/MDN/Contribute/Open_source_etiquette
Title: Basic etiquette for open source projects
on GitHub


URL: /en-US/docs/MDN/Contribute/Localize
Title: Localizing MDN
on GitHub


URL: /en-US/docs/MDN/Contribute/Feedback
Title: Send feedback about MDN Web Docs
on GitHub


URL: /en-US/docs/MDN/Contribute/Help_beginners
Title: Help beginners to learn on MDN!
on GitHub


URL: /en-US/docs/MDN/Contribute/Documentation_priorities
Title: MDN documentation priority list
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Contribute/GitHub_cheatsheet
Title: GitHub cheatsheet
on GitHub


URL: /en-US/docs/MDN/Contribute/Howto
Title: MDN web docs: How-to guides
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Contribute/Howto/Report_a_problem
Title: How to report a problem on MDN
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Contribute/Howto/Convert_code_samples_to_be_live
Title: How to convert code samples to be "live"
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Contribute/Howto/Add_or_update_browser_compatibility_data
Title: How to add or update browser compatibility data
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Contribute/Howto/Document_an_HTTP_header
Title: How to document an HTTP header
on GitHub


URL: /en-US/docs/MDN/Contribute/Howto/Create_and_edit_pages
Title: How to create and edit pages
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Contribute/Howto/Update_the_CSS_JSON_DB
Title: How to update the CSS JSON DB
on GitHub


URL: /en-US/docs/MDN/Contribute/Howto/Write_an_API_reference
Title: How to write an API reference
on GitHub


URL: /en-US/docs/MDN/Contribute/Howto/Write_an_API_reference/Sidebars
Title: API reference sidebars
on GitHub


URL: /en-US/docs/MDN/Contribute/Howto/Write_an_API_reference/Information_contained_in_a_WebIDL_file
Title: Information contained in a WebIDL file
on GitHub


URL: /en-US/docs/MDN/Contribute/Howto/Write_for_SEO
Title: How to write with SEO in mind on MDN Web Docs
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Contribute/Howto/Tag
Title: How to properly tag pages
on GitHub


URL: /en-US/docs/MDN/Contribute/Howto/Migrate_external_content_to_MDN
Title: How to migrate external content to MDN Web Docs
on GitHub


URL: /en-US/docs/MDN/Contribute/Howto/Document_a_CSS_property
Title: How to document a CSS property
on GitHub


URL: /en-US/docs/MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary
Title: How to write and reference an entry in the glossary
on GitHub


URL: /en-US/docs/MDN/Contribute/Howto/Create_an_interactive_exercise_to_help_learning_the_web
Title: How to create an interactive learning exercise
on GitHub


URL: /en-US/docs/MDN/Contribute/Howto/Create_an_interactive_exercise_to_help_learning_the_web/distant_example
Title: distant example
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Contribute/Howto/Document_web_errors
Title: How to document web errors
on GitHub


URL: /en-US/docs/MDN/Contribute/Fixing_MDN_content_bugs
Title: Fixing MDN content bugs
on GitHub


URL: /en-US/docs/MDN/Contribute/Getting_started
Title: Getting started on MDN
on GitHub


URL: /en-US/docs/MDN/Contribute/Where_is_everything
Title: Where is everything on MDN? A guide to our repos
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Contribute/Processes
Title: Documentation processes
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Contribute/Processes/Matching_features_to_browser_version
Title: Matching web features to browser release version numbers
on GitHub


URL: /en-US/docs/MDN/Contribute/Processes/Short_surveys
Title: Process for running short surveys
on GitHub


URL: /en-US/docs/MDN/Contribute/Processes/Content_bug_triage
Title: Triage process for MDN content bugs
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Contribute/Processes/Workstream_assessment_project
Title: MDN Workstream assessment and project setup process
on GitHub


URL: /en-US/docs/MDN/Contribute/GitHub_best_practices
Title: GitHub best practices for MDN
on GitHub


URL: /en-US/docs/MDN/Contribute/Markdown_in_MDN
Title: Markdown in MDN
on GitHub


URL: /en-US/docs/MDN/Tools
Title: MDN tools
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Tools/KumaScript
Title: KumaScript
on GitHub


URL: /en-US/docs/MDN/Tools/KumaScript/Troubleshooting
Title: Troubleshooting KumaScript errors
on GitHub

No new external URLs


URL: /en-US/docs/MDN/Tools/Sample_server
Title: The MDN sample server
on GitHub


URL: /en-US/docs/MDN/Tools/Unsupported_GET_API
Title: Unsupported GET API
on GitHub

No new external URLs

@wbamberg
Copy link
Collaborator

wbamberg commented Oct 5, 2021

In this PR I only see 1 commit for the conversion (efc1210).

The conversion needs to be in 2 separate commits:

  • commit 1 is to rename all the files from HTML->MD
  • commit 2 does the conversion of the file contents

I'm reliably informed that this is the trick that enables us to preserve Git history across the files.

The converter h2m makes this easy for you by doing the rename, then staging, then doing the conversion. So you can do something like:

(from yari)

yarn md h2m mdn --mode==replace

...then (from content)

git commit -S -m "Rename HTML files to MD"
git add files/en-us/mdn
git commit -S -m "Convert file contents to Markdown"
git log --oneline             <- should show you 2 commits

Does that make sense?

@hamishwillee
Copy link
Collaborator

@Rumyra This appears to have the same problem as @wbamberg had a few builds ago - the bullets are all indented 2 spaces. I think he fixed using a more recent version of yari, but it might have been a separate run of prettify.

@@ -0,0 +1,131 @@
---
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a pity I didn't get through these templates - most of them I did manually and they are much better conversions than this - e.g. https://developer.mozilla.org/en-US/docs/MDN/Structures/Page_types/API_property_subpage_template

@wbamberg
Copy link
Collaborator

wbamberg commented Oct 6, 2021

@Rumyra This appears to have the same problem as @wbamberg had a few builds ago - the bullets are all indented 2 spaces. I think he fixed using a more recent version of yari, but it might have been a separate run of prettify.

Yes, I just updated my Yari and tried again.

@Rumyra
Copy link
Collaborator Author

Rumyra commented Oct 7, 2021

OK thanks both - I'll try it again 👍

@Rumyra Rumyra closed this Oct 7, 2021
@Rumyra Rumyra deleted the mdn-to-markdown branch October 15, 2021 16:16
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:Other Any docs not covered by another "Content:" label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Markdown] Prepare /mdn docs for markdowning
3 participants