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

chore(ia): reorg Web/Media #37898

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from
Draft

chore(ia): reorg Web/Media #37898

wants to merge 17 commits into from

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented Jan 31, 2025

Description

Drafting a Media reorg PR. Directory now has this structure:

./files/en-us/web/media
└── guides
    ├── audio_and_video_delivery
    ├── audio_and_video_manipulation
    ├── autoplay
    ├── dash_adaptive_streaming_for_html_5_video
    ├── formats
    ├── images
    └── streaming

Changes:

Files to look at with actual content changes:

  • files/en-us/web/media/index.md
    • new landing page with macros for subpages
  • files/en-us/web/media/guides/index.md
    • New listing page with macro to list subpages
  • files/en-us/web/media/guides/formats/index.md
    • Uses macro to list subpages

Files with minor fixes:

  • files/en-us/web/media/guides/audio_and_video_delivery/cross-browser_audio_basics/index.md
    • audio "tag" -> "element"
  • files/en-us/web/media/guides/audio_and_video_delivery/index.md
    • audio "tag" -> "element"
    • <source> / other elements properly closed
    • tutorials -> guides
  • files/en-us/web/media/guides/audio_and_video_manipulation/index.md
    • tutorials -> guides
  • files/en-us/web/media/guides/dash_adaptive_streaming_for_html_5_video/index.md
    • proper See also

Everything else:

All other files change links to the section, nothing to look too closely at.

Motivation

Generating a preview for docs IA & maintenance tasks

@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs Content:HTML Hypertext Markup Language docs Content:WebAPI Web API docs Content:Learn Learning area docs Content:Other Any docs not covered by another "Content:" label Content:HTTP HTTP docs Content:Accessibility Accessibility docs Content:Media Media docs Content:Glossary Glossary entries Content:Guide Guide docs Content:Security Security docs Content:Firefox Content in the Mozilla/Firefox subtree Content:Manifest size/l [PR only] 501-1000 LoC changed labels Jan 31, 2025
Copy link
Contributor

github-actions bot commented Jan 31, 2025

Preview URLs (108 pages)
Flaws (94)

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

URL: /en-US/docs/Mozilla/Firefox/Releases/3
Title: Firefox 3 for developers
Flaw count: 21

  • broken_links:
    • Can't resolve /en-US/docs/CSS_improvements_in_Firefox_3
    • Can't resolve /en-US/docs/New_in_JavaScript_1.8
    • Can't resolve /en-US/docs/XUL_improvements_in_Firefox_3
    • Can't resolve /en-US/docs/Templates_in_Firefox_3
    • Can't resolve /en-US/docs/Extension_Versioning,_Update_and_Compatibility#securing_updates
    • and 16 more flaws omitted

URL: /en-US/docs/Mozilla/Firefox/Releases/96
Title: Firefox 96 for developers
Flaw count: 1

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

URL: /en-US/docs/Mozilla/Firefox/Releases/113
Title: Firefox 113 for developers
Flaw count: 1

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

URL: /en-US/docs/Mozilla/Firefox/Releases/4
Title: Firefox 4 for developers
Flaw count: 40

  • broken_links:
    • Can't resolve /en-US/docs/Optimizing_graphics_performance
    • Can't resolve /en-US/docs/DOM/Animations_using_MozBeforePaint
    • Can't resolve /en-US/docs/DOM/HTMLWBRElement
    • Can't resolve /en-US/docs/Supporting_private_browsing_mode#detecting_whether_private_browsing_mode_is_permanent
    • Can't resolve /en-US/docs/Gecko-Specific_DOM_Events#mozafterpaint
    • and 33 more flaws omitted
  • macros:
    • Can't resolve /en-US/docs/Web/API/Element/beforescriptexecute
    • Can't resolve /en-US/docs/Web/API/Element/afterscriptexecute

URL: /en-US/docs/Web/API/HTMLVideoElement
Title: HTMLVideoElement
Flaw count: 6

  • macros:
    • Can't resolve /en-US/docs/Web/API/HTMLVideoElement/mozParsedFrames
    • Can't resolve /en-US/docs/Web/API/HTMLVideoElement/mozDecodedFrames
    • Can't resolve /en-US/docs/Web/API/HTMLVideoElement/mozPresentedFrames
    • Can't resolve /en-US/docs/Web/API/HTMLVideoElement/mozPaintedFrames
    • Can't resolve /en-US/docs/Web/API/HTMLVideoElement/mozFrameDelay
    • and 1 more flaws omitted

URL: /en-US/docs/Web/API/HTMLMediaElement
Title: HTMLMediaElement
Flaw count: 6

  • macros:
    • Can't resolve /en-US/docs/Web/API/MediaController
    • Can't resolve /en-US/docs/Web/API/MediaController
    • Can't resolve /en-US/docs/Web/API/HTMLMediaElement/mozAudioCaptured
    • Can't resolve /en-US/docs/Web/API/HTMLMediaElement/mozFragmentEnd
    • Can't resolve /en-US/docs/Web/API/HTMLMediaElement/mozCaptureStreamUntilEnded
    • and 1 more flaws omitted

URL: /en-US/docs/Web/API/RTCRtpReceiver/getParameters
Title: RTCRtpReceiver: getParameters() method
Flaw count: 1

  • macros:
    • Can't resolve /en-US/docs/Web/API/RTCRtcpParameters

URL: /en-US/docs/Web/API/WebRTC_API
Title: WebRTC API
Flaw count: 6

  • macros:
    • Can't resolve /en-US/docs/Web/API/RTCIceTransport/error_event
    • Can't resolve /en-US/docs/Web/API/RTCSctpTransport/error_event
    • Can't resolve /en-US/docs/Web/API/RTCDtlsTransport/statechange_event
    • Can't resolve /en-US/docs/Web/API/RTCDtlsTransport/statechange_event
    • Can't resolve /en-US/docs/Web/API/RTCIdentityProvider
    • and 1 more flaws omitted

URL: /en-US/docs/Web/API/WebRTC_API/Connectivity
Title: WebRTC connectivity
Flaw count: 3

  • macros:
    • Can't resolve /en-US/docs/Web/API/RTCIceTransport/error_event
    • Can't resolve /en-US/docs/Web/API/RTCSctpTransport/error_event
    • Can't resolve /en-US/docs/Web/API/RTCDtlsTransport/statechange_event

URL: /en-US/docs/Web/API/WebRTC_API/Signaling_and_video_calling
Title: Signaling and video calling
Flaw count: 4

  • macros:
    • Can't resolve /en-US/docs/Web/API/RTCIceTransport/error_event
    • Can't resolve /en-US/docs/Web/API/RTCSctpTransport/error_event
    • Can't resolve /en-US/docs/Web/API/RTCDtlsTransport/statechange_event
    • Can't resolve /en-US/docs/Web/API/RTCPeerConnection/removetrack_event

URL: /en-US/docs/Web/API/RTCRtpSender/setParameters
Title: RTCRtpSender: setParameters() method
Flaw count: 1

  • macros:
    • Can't resolve /en-US/docs/Web/API/RTCRtcpParameters

URL: /en-US/docs/Web/API/RTCRtpSender/getParameters
Title: RTCRtpSender: getParameters() method
Flaw count: 1

  • macros:
    • Can't resolve /en-US/docs/Web/API/RTCRtcpParameters

URL: /en-US/docs/Web/API/Web_Audio_API
Title: Web Audio API
Flaw count: 1

  • macros:
    • Macro produces link /en-US/docs/Web/API/Web_Audio_API/Tools which is a redirect

URL: /en-US/docs/Web/API/Web_Audio_API/Using_Web_Audio_API
Title: Using the Web Audio API
Flaw count: 1

  • macros:
    • Macro produces link /en-US/docs/Web/API/Web_Audio_API/Tools which is a redirect

URL: /en-US/docs/Web/HTTP
Title: HTTP
Flaw count: 1

  • unknown:
    • No generic content config found
External URLs (26)

URL: /en-US/docs/Learn_web_development/Core/Structuring_content/HTML_video_and_audio
Title: HTML video and audio


URL: /en-US/docs/Learn_web_development/Core/Scripting/What_is_JavaScript
Title: What is JavaScript?


URL: /en-US/docs/Learn_web_development/Core/Accessibility/Multimedia
Title: Accessible multimedia


URL: /en-US/docs/Learn_web_development/Extensions/Performance/Multimedia
Title: Multimedia: Images


URL: /en-US/docs/Mozilla/Firefox/Releases/134
Title: Firefox 134 for developers


URL: /en-US/docs/Mozilla/Firefox/Releases/66
Title: Firefox 66 for developers


URL: /en-US/docs/Mozilla/Firefox/Releases/113
Title: Firefox 113 for developers


URL: /en-US/docs/Mozilla/Firefox/Releases/126
Title: Firefox 126 for developers


URL: /en-US/docs/Mozilla/Firefox/Releases/93
Title: Firefox 93 for developers


URL: /en-US/docs/Mozilla/Firefox/Releases/125
Title: Firefox 125 for developers


URL: /en-US/docs/Web/API/AudioDecoder/configure
Title: AudioDecoder: configure() method


URL: /en-US/docs/Web/API/AudioEncoder/configure
Title: AudioEncoder: configure() method


URL: /en-US/docs/Web/API/VideoEncoder/configure
Title: VideoEncoder: configure() method


URL: /en-US/docs/Web/API/VideoDecoder/configure
Title: VideoDecoder: configure() method


URL: /en-US/docs/Web/Media/Guides/DASH_Adaptive_Streaming_for_HTML_5_Video
Title: DASH Adaptive Streaming for HTML video


URL: /en-US/docs/Web/Media/Guides/Audio_and_video_delivery
Title: Audio and video delivery


URL: /en-US/docs/Web/Media/Guides/Audio_and_video_delivery/Video_player_styling_basics
Title: Video player styling basics


URL: /en-US/docs/Web/Media/Guides/Formats/codecs_parameter
Title: Codecs in common media types

(comment last updated: 2025-01-31 16:37:19)

Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions github-actions bot added the merge conflicts 🚧 [PR only] label Jan 31, 2025
@pepelsbey pepelsbey self-requested a review January 31, 2025 16:12
@github-actions github-actions bot removed the merge conflicts 🚧 [PR only] label Jan 31, 2025
Copy link
Member

@pepelsbey pepelsbey left a comment

Choose a reason for hiding this comment

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

Phew! What a chunk of work :) LGTM, thanks!

(apart from a little pesky tag, sorry)

@@ -36,7 +35,7 @@ The code below is an example of a basic audio implementation using HTML5:
- `src` contains the path to the audio file to be loaded (relative or absolute).
- `type` is used to inform the browser of the file type. If omitted, most browsers will attempt to guess this from the file extension.

- If the {{ htmlelement("audio") }} element is not supported then {{ htmlelement("audio") }} and {{ htmlelement("source") }} will be ignored. However, any supported text or elements that you define within {{ htmlelement("audio") }} will be displayed or acted upon. So the ideal place to create a fallback or inform of incompatibility is before the closing `</audio>` tag. In this case, we've provided a simple paragraph including a link to download the audio directly.
- If the {{ htmlelement("audio") }} element is not supported then {{ htmlelement("audio") }} and {{ htmlelement("source") }} will be ignored. However, any supported text or elements that you define within {{ htmlelement("audio") }} will be displayed or acted upon. So the ideal place to create a fallback or inform of incompatibility is before the closing `</audio>` element. In this case, we've provided a simple paragraph including a link to download the audio directly.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- If the {{ htmlelement("audio") }} element is not supported then {{ htmlelement("audio") }} and {{ htmlelement("source") }} will be ignored. However, any supported text or elements that you define within {{ htmlelement("audio") }} will be displayed or acted upon. So the ideal place to create a fallback or inform of incompatibility is before the closing `</audio>` element. In this case, we've provided a simple paragraph including a link to download the audio directly.
- If the {{ htmlelement("audio") }} element is not supported then {{ htmlelement("audio") }} and {{ htmlelement("source") }} will be ignored. However, any supported text or elements that you define within {{ htmlelement("audio") }} will be displayed or acted upon. So the ideal place to create a fallback or inform of incompatibility is before the closing `</audio>` tag. In this case, we've provided a simple paragraph including a link to download the audio directly.

In this case, it’s a tag. Sorry! 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Accessibility Accessibility docs Content:CSS Cascading Style Sheets docs Content:Firefox Content in the Mozilla/Firefox subtree Content:Glossary Glossary entries Content:Guide Guide docs Content:HTML Hypertext Markup Language docs Content:HTTP HTTP docs Content:Learn Learning area docs Content:Manifest Content:Media Media docs Content:Other Any docs not covered by another "Content:" label Content:Security Security docs Content:WebAPI Web API docs size/l [PR only] 501-1000 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants