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

[Markdown] Convert Web/Media to Markdown - DO NOT SQUASH MERGE #9818

Merged
merged 3 commits into from
Oct 15, 2021

Conversation

wbamberg
Copy link
Collaborator

This PR converts https://developer.mozilla.org/en-US/docs/Web/Media to Markdown.

Preparation PR: #9809.

Conversion report summary:


All unhandled elements

  • tr (676)
  • th[scope="row"] (628)
  • table.standard-table (103)
  • td (77)
  • th[scope="col"] (60)
  • td[style="vertical-align: top;"] (47)
  • th[rowSpan="2"][scope="row"][style="vertical-align: bottom;"] (16)
  • th[colSpan="4"][scope="col"][style="text-align: center;"] (15)
  • td[style="vertical-align: top; border-right: 2px solid #d4dde4;"] (10)
  • th[scope="row"][style="vertical-align: top;"] (7)
  • th[rowSpan="2"][scope="row"] (4)
  • th[scope="col"][style="vertical-align: bottom;"] (4)
  • table.standard-table[style="max-width: 42rem;"] (4)
  • td[rowSpan="2"][style="vertical-align: top;"] (3)
  • th[scope="col"][style="width: 216px;"] (3)
  • table.standard-table[style="margin-left: 4em; max-width: 30em;"] (2)
  • th[scope="col"][style="vertical-align: bottom; border-right: 2px solid #d4dde4;"] (2)
  • th[colSpan="3"][scope="col"][style="text-align: center; border-right: 2px solid #d4dde4;"] (1)
  • th[colSpan="3"][scope="col"][style="text-align: center;"] (1)
  • th[scope="row"][style="vertical-align: bottom;"] (1)
  • th[rowSpan="2"][scope="row"][style="vertical-align: top;"] (1)
  • th[colSpan="3"][style="font: italic 0.9em Arial, x-locale-body, sans-serif; vertical-align: middle;"] (1)
  • table.standard-table[style="max-width: 46em;"] (1)

Full conversion report: https://gist.github.com/wbamberg/fdf49a295a131dee7fa70aa16f6d9a2d

...these pages contain a lot of rather complicated tables, which are not getting converted. Apart form tables there are zero unconverted elements.

Apart from the usual randomness, the main changes here are:

  • removing elements like <a id="AAC"></a>, that are used to provide link targets, and updating any links that use those targets to use heading IDs instead.
  • removing elements like <a name="aac-foot-1">[1]</a>, that are used to provide targets for footnotes linked from the tables, and doing something else with the footnote (usually just copying it into the table).

After this PR there will be lots of unconverted tables, but nothing else.

There is good content in this bit of the docs, but I think it would be much more approachable if it were split up into more pages.

@wbamberg wbamberg requested a review from a team as a code owner October 15, 2021 00:07
@wbamberg wbamberg requested review from Rumyra and removed request for a team October 15, 2021 00:07
@github-actions github-actions bot added the Content:Media Media docs label Oct 15, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Oct 15, 2021

Preview URLs

Flaws

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

URL: /en-US/docs/Web/Media/Autoplay_guide
Title: Autoplay guide for media and Web Audio APIs
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/HTMLMediaElement/allowedToPlay does not exist

URL: /en-US/docs/Web/Media/Formats/WebRTC_codecs
Title: Codecs used by WebRTC
on GitHub
Flaw count: 3

  • macros:
    • /en-US/docs/Web/API/MediaStreamTrack/track does not exist
    • /en-US/docs/Web/API/RTCRtpParameters/codecs does not exist
    • /en-US/docs/Web/API/RTCRtpCodecParameters/payloadType does not exist

External URLs

URL: /en-US/docs/Web/Media
Title: Web media technologies
on GitHub

No new external URLs


URL: /en-US/docs/Web/Media/Autoplay_guide
Title: Autoplay guide for media and Web Audio APIs
on GitHub


URL: /en-US/docs/Web/Media/images
Title: Using images in HTML
on GitHub

No new external URLs


URL: /en-US/docs/Web/Media/images/aspect_ratio_mapping
Title: Mapping the width and height attributes of media container elements to their aspect-ratio
on GitHub


URL: /en-US/docs/Web/Media/DASH_Adaptive_Streaming_for_HTML_5_Video
Title: DASH Adaptive Streaming for HTML 5 Video
on GitHub


URL: /en-US/docs/Web/Media/Formats
Title: Media type and format guide: image, audio, and video content
on GitHub

No new external URLs


URL: /en-US/docs/Web/Media/Formats/WebRTC_codecs
Title: Codecs used by WebRTC
on GitHub


URL: /en-US/docs/Web/Media/Formats/Audio_concepts
Title: Digital audio concepts
on GitHub

No new external URLs


URL: /en-US/docs/Web/Media/Formats/Containers
Title: Media container formats (file types)
on GitHub


URL: /en-US/docs/Web/Media/Formats/Support_issues
Title: Handling media support issues in web content
on GitHub

No new external URLs


URL: /en-US/docs/Web/Media/Formats/Video_codecs
Title: Web video codec guide
on GitHub


URL: /en-US/docs/Web/Media/Formats/Video_concepts
Title: Digital video concepts
on GitHub

No new external URLs


URL: /en-US/docs/Web/Media/Formats/Image_types
Title: Image file type and format guide
on GitHub


URL: /en-US/docs/Web/Media/Formats/Audio_codecs
Title: Web audio codec guide
on GitHub


URL: /en-US/docs/Web/Media/Formats/codecs_parameter
Title: The "codecs" parameter in common media types
on GitHub


URL: /en-US/docs/Web/Media/Streaming
Title: Guide to streaming audio and video
on GitHub

No new external URLs


URL: /en-US/docs/Web/Media/HTML_media
Title: Using audio and video in HTML
on GitHub

No new external URLs

(this comment was updated 2021-10-15 17:44:10.028940)

Copy link
Collaborator

@Rumyra Rumyra left a comment

Choose a reason for hiding this comment

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

Added a couple of amends but it all looks good to me

@Rumyra Rumyra merged commit a188202 into mdn:main Oct 15, 2021
@wbamberg wbamberg deleted the media-to-markdown branch October 15, 2022 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Media Media docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants