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

Remove WebRTC custom sidebar #22486

Merged
merged 2 commits into from
Nov 25, 2022
Merged

Conversation

wbamberg
Copy link
Collaborator

This PR removes all references to the custom sidebar implemented by the WebRTCSidebar macro, and replaces them with references to the standard DefaultAPISidebar.

The WebRTCSidebar macro doesn't really have any features missing in DefaultAPISidebar. In fact, there is already a group for WebRTC in groupdata.json, and the WebRTC overview page already uses DefaultAPISidebar (https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API) although its children don't.

Because the usage of this sidebar is quite inconsistent, this PR makes a few different changes:

I also added one guide to the groupdata entry for WebRTC - that was the only relevant thing that seemed to be missing, compared with the custom sidebar contents.

All the other changes are Prettier. I hope that's OK (and sorry about the noise).

After merging this we can deprecate WebRTCSidebar.

@wbamberg wbamberg requested review from a team as code owners November 22, 2022 22:48
@wbamberg wbamberg requested review from jpmedley, hamishwillee and bsmth and removed request for a team November 22, 2022 22:49
@github-actions github-actions bot added Content:Learn Learning area docs Content:WebAPI Web API docs labels Nov 22, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Nov 22, 2022

Preview URLs (24 pages)
Flaws (11)

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

URL: /en-US/docs/Web/API/RTCDTMFSender/tonechange_event
Title: RTCDTMFSender: tonechange event
Flaw count: 1

  • broken_links:
    • Link points to the page it's already on

URL: /en-US/docs/Web/API/WebRTC_API/Using_DTMF
Title: Using DTMF with WebRTC
Flaw count: 5

  • macros:
    • /en-US/docs/Web/API/MediaConstraints does not exist
    • /en-US/docs/Web/API/RTCPeerConnection/createDTMFSender does not exist
    • /en-US/docs/Web/API/RTCPeerConnection/getTracks does not exist
    • /en-US/docs/Web/API/RTCTrackEvent/stream does not exist
    • The fourth to sixth parameters of 'EmbedLiveSample' are deprecated

URL: /en-US/docs/Web/API/WebRTC_API/adapter.js
Title: Improving compatibility using WebRTC adapter.js
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/RTCPeerConnection/urls does not exist

URL: /en-US/docs/Web/API/WebRTC_API/Build_a_phone_with_peerjs
Title: Building an Internet-Connected Phone with PeerJS
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/API/WebRTC_API/Build_a_phone_with_peerjs/Connect_peers/End_a_call

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

  • macros:
    • /en-US/docs/Web/API/RTCPeerConnection/removetrack_event does not exist
    • /en-US/docs/Web/API/HTMLElement/disabled does not exist

URL: /en-US/docs/Web/API/WebRTC_API/Simple_RTCDataChannel_sample
Title: A simple RTCDataChannel sample
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/EventListener redirects to /en-US/docs/Web/API/EventTarget/addEventListener

(this comment was updated 2022-11-24 12:20:54.092833)

@bsmth
Copy link
Member

bsmth commented Nov 24, 2022

Taking a look shortly 👀

@bsmth
Copy link
Member

bsmth commented Nov 24, 2022

  • Prettier formatting looks good
  • Sidebars look better
  • Redirects look good

Why are we deleting https://developer.mozilla.org/en-US/docs/Web/Guide/API/WebRTC/Peer-to-peer_communications_with_WebRTC ?

Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

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

Thanks @wbamberg, LGTM 👍🏻

Once comment open about rationale for deleting the page, everything else looks good.

@wbamberg
Copy link
Collaborator Author

  • Prettier formatting looks good

    • Sidebars look better

    • Redirects look good

Why are we deleting https://developer.mozilla.org/en-US/docs/Web/Guide/API/WebRTC/Peer-to-peer_communications_with_WebRTC ?

Because:

@bsmth
Copy link
Member

bsmth commented Nov 25, 2022

Thank you, merging now 👍🏻

@bsmth bsmth merged commit 3f7036e into mdn:main Nov 25, 2022
hamishwillee pushed a commit to hamishwillee/content that referenced this pull request Dec 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Learn Learning area docs Content:WebAPI Web API docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants