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.

Sign up for GitHub

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

Jump to bottom

Add page-types for guide areas of MDN #27624

Merged
merged 5 commits into from
Jul 4, 2023
Merged

Add page-types for guide areas of MDN #27624

merged 5 commits into from
Jul 4, 2023

Conversation

teoli2003
Copy link
Contributor

@teoli2003 teoli2003 commented Jun 28, 2023 •
edited
Loading

This is a long tail of scattered guides on MDN.

I used guide and landing-pages.

Note: Under the PWA section, there are a few pages that match the modern docs structures. So I created the page types howto and tutorial, but used them ONLY for places where the 4-types-of-doc structure have been used.

This is part of openwebdocs/project#91

@teoli2003 teoli2003 requested a review from wbamberg June 28, 2023 14:19
@teoli2003 teoli2003 requested review from a team as code owners June 28, 2023 14:19
@github-actions github-actions bot added Content:Learn Learning area docs Content:Media Media docs Content:Other Any docs not covered by another "Content:" label labels Jun 28, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 28, 2023 •
edited
Loading

Preview URLs (126 pages)
Flaws (95)

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

URL: /en-US/docs/Games/Tutorials/Touch_Event_Horizon
Title: Touch Event Horizon
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/Apps/Fundamentals/User_input_methods/Touch_Gestures_and_Events

URL: /en-US/docs/Web/Progressive_web_apps/Tutorials/CycleTracker/HTML_and_CSS
Title: CycleTracker: Base HTML and CSS
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_selectors
    • Can't resolve /en-US/docs/Web/CSS/CSS_selectors

URL: /en-US/docs/Web/Guide
Title: Developer guides
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Animations/Using_CSS_animations
    • Can't resolve /en-US/docs/Web/CSS/CSS_Fonts/Variable_Fonts_Guide

URL: /en-US/docs/Web/Guide/Houdini
Title: CSS Houdini
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/PaintWorklet/registerPaint redirects to /en-US/docs/Web/API/PaintWorkletGlobalScope/registerPaint

URL: /en-US/docs/Web/Guide/Mobile
Title: Mobile Web Development
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/Media_Queries
    • Can't resolve /en-US/docs/Web/CSS/CSS_Images/Using_CSS_gradients

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

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/Media_Queries/Using_media_queries

URL: /en-US/docs/Web/Guide/CSS/Block_formatting_context
Title: Block formatting context
Flaw count: 7

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Table
    • Can't resolve /en-US/docs/Web/CSS/CSS_Table
    • Can't resolve /en-US/docs/Web/CSS/CSS_Box_Model/Mastering_margin_collapsing
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flow_Layout/In_Flow_and_Out_of_Flow
    • Can't resolve /en-US/docs/Web/CSS/CSS_Box_Model/Mastering_margin_collapsing
    • and 2 more flaws omitted

URL: /en-US/docs/Web/Guide/CSS/CSS_Layout
Title: CSS Layout
Flaw count: 37

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flow_Layout/Block_and_Inline_Layout_in_Normal_Flow
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flow_Layout/In_Flow_and_Out_of_Flow
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flow_Layout/Intro_to_formatting_contexts
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flow_Layout/Flow_Layout_and_Writing_Modes
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flow_Layout/Flow_Layout_and_Overflow
    • and 32 more flaws omitted

URL: /en-US/docs/Web/Guide/CSS/Getting_started/Challenge_solutions
Title: Challenge solutions
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/Media_Queries/Using_media_queries

URL: /en-US/docs/Web/Guide/Introduction_to_Web_development
Title: Introduction to Web development
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript

URL: /en-US/docs/Web/Guide/User_input_methods
Title: User input and controls
Flaw count: 8

  • macros:
    • /en-US/docs/Web/API/Screen/orientationchange does not exist
  • broken_links:
    • Can't resolve /en-US/docs/Web/Guide/HTML/Editable_content
    • Can't resolve /en-US/docs/Web/CSS/Media_Queries/Using_media_queries#orientation
    • Can't resolve /en-US/docs/Web/API/Document/dragstart_event
    • Can't resolve /en-US/docs/Web/Guide/HTML/Editable_content
    • Can't resolve /en-US/docs/Web/Guide/HTML/Editable_content
    • and 2 more flaws omitted

URL: /en-US/docs/Web/Security/User_activation
Title: Features gated by user activation
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/IdleDetector/requestPermission redirects to /en-US/docs/Web/API/IdleDetector/requestPermission_static

URL: /en-US/docs/Web/Privacy/State_Partitioning
Title: State Partitioning
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Mozilla/Firefox/Privacy/Storage_access_policy

URL: /en-US/docs/Web/Performance
Title: Web performance
Flaw count: 11

  • broken_links:
    • Can't resolve /en-US/docs/Learn/Performance/Mobile
    • Can't resolve /en-US/docs/Web/API/Performance_API/Using_the_Performance_API
    • Can't resolve /en-US/docs/Web/API/Resource_Timing_API/Using_the_Resource_Timing_API
    • Can't resolve /en-US/docs/Web/API/Resource_Timing_API
    • Can't resolve /en-US/docs/Web/API/Performance_Timeline/Using_Performance_Timeline
    • and 6 more flaws omitted

URL: /en-US/docs/Web/Performance/CSS_JavaScript_animation_performance
Title: CSS and JavaScript animation performance
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Transitions/Using_CSS_transitions
    • Can't resolve /en-US/docs/Web/CSS/CSS_Animations/Using_CSS_animations

URL: /en-US/docs/Web/Performance/Fundamentals
Title: Performance fundamentals
Flaw count: 3

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/Media_Queries/Using_media_queries
    • Can't resolve /en-US/docs/Web/CSS/CSS_Animations/Using_CSS_animations
    • Can't resolve /en-US/docs/Web/CSS/CSS_Transitions/Using_CSS_transitions

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

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

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

  • macros:
    • /en-US/docs/Web/API/MediaSource/isTypeSupported redirects to /en-US/docs/Web/API/MediaSource/isTypeSupported_static

URL: /en-US/docs/Web/Media/Formats/Support_issues
Title: Handling media support issues in web content
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/MediaSource/isTypeSupported redirects to /en-US/docs/Web/API/MediaSource/isTypeSupported_static

URL: /en-US/docs/Web/Media/Formats/Video_codecs
Title: Web video codec guide
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/MediaSource/isTypeSupported redirects to /en-US/docs/Web/API/MediaSource/isTypeSupported_static
    • /en-US/docs/Web/API/MediaSource/isTypeSupported redirects to /en-US/docs/Web/API/MediaSource/isTypeSupported_static

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

  • macros:
    • /en-US/docs/Web/API/RTCRtpSender/getCapabilities redirects to /en-US/docs/Web/API/RTCRtpSender/getCapabilities_static
    • /en-US/docs/Web/API/RTCRtpReceiver/getCapabilities redirects to /en-US/docs/Web/API/RTCRtpReceiver/getCapabilities_static
    • /en-US/docs/Web/API/RTCRtpCodecParameters/payloadType does not exist
  • broken_links:
    • Can't resolve /en-US/docs/Web/API/RTCRtpSender/getCapabilities#codecs
    • Can't resolve /en-US/docs/Web/API/RTCRtpSender/getCapabilities#rtx_retransmission
    • Can't resolve /en-US/docs/Web/API/RTCRtpSender/getCapabilities#red_redundant_audio_data
    • Can't resolve /en-US/docs/Web/API/RTCRtpSender/getCapabilities#fec_forward_error_correction

URL: /en-US/docs/Web/Text_fragments
Title: Text fragments
Flaw count: 2

  • broken_links:
    • Anchor not lowercase
    • Anchor not lowercase

(comment last updated: 2023-07-03 12:04:39)

wbamberg
wbamberg reviewed Jun 28, 2023
View reviewed changes
files/en-us/web/progressive_web_apps/how_to/associate_files_with_your_pwa/index.md Outdated
@@ -1,6 +1,7 @@
---
title: Associate files with your PWA
slug: Web/Progressive_web_apps/How_to/Associate_files_with_your_PWA
page-type: howto
Copy link
Collaborator

Choose a reason for hiding this comment

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

how-to seems easier to read than howto, is there a reason for this choice?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

wbamberg
wbamberg reviewed Jun 28, 2023
View reviewed changes
files/en-us/web/progressive_web_apps/tutorials/intro/html_and_css/index.md Outdated
@@ -1,6 +1,7 @@
---
title: "PWA tutorial: Base HTML and CSS"
slug: Web/Progressive_web_apps/Tutorials/Intro/HTML_and_CSS
page-type: tutorial
Copy link
Collaborator

Choose a reason for hiding this comment

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

It bothers me that this page is not a tutorial, it's a chapter of a tutorial: the tutorial is the whole sequence of pages. Maybe consider tutorial for Web/Progressive_web_apps/Tutorials/Intro, but tutorial-chapter for these subpages?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Makes sense

@github-actions github-actions bot added the merge conflicts 🚧 [PR only] label Jun 28, 2023
@github-actions
Copy link
Contributor

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

@github-actions github-actions bot removed the merge conflicts 🚧 [PR only] label Jun 29, 2023
@teoli2003 teoli2003 requested a review from wbamberg June 29, 2023 04:57
@teoli2003
Copy link
Contributor Author

So, I have:

  • merged with main
  • renamed howto to how-to
  • renamed some tutorial into tutorial-chapter

I think this is read for a second review.

@github-actions
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 Jun 30, 2023
@github-actions github-actions bot added Content:Games Games docs Content:Performance Web performance docs Content:Guide Guide docs Content:Security Security docs Content:Firefox Content in the Mozilla/Firefox subtree Content:PWA Progressive Web Apps content and removed merge conflicts 🚧 [PR only] Content:Learn Learning area docs labels Jul 3, 2023
@teoli2003 teoli2003 requested a review from Elchi3 July 3, 2023 12:10
Elchi3
Elchi3 approved these changes Jul 4, 2023
View reviewed changes
Copy link
Member

@Elchi3 Elchi3 left a comment

Choose a reason for hiding this comment

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

Thanks Jean-Yves! I really like the idea of using "how-to" and "tutorial" for newly created structures that follow divio.

@Elchi3 Elchi3 merged commit e74627e into mdn:main Jul 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Elchi3 Elchi3 Elchi3 approved these changes

@wbamberg wbamberg Awaiting requested review from wbamberg

Assignees
No one assigned
Labels
Content:Firefox Content in the Mozilla/Firefox subtree Content:Games Games docs Content:Guide Guide docs Content:Media Media docs Content:Other Any docs not covered by another "Content:" label Content:Performance Web performance docs Content:PWA Progressive Web Apps content Content:Security Security docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@teoli2003 @Elchi3 @wbamberg