Add page-type to Web_component and relocate them #26173

teoli2003 · 2023-04-13T05:35:31Z

As part of openwebdocs/project#91 we adds page-type to every document on MDN.

This PR adds them (landing-page and guide) to the documents under Web/Web_components.

In addition, it relocates the folder under Web/API. Its location at the top of the Web/ hierarchy is incongruous: It is a set of APIs. Its sidebar was {{DefaultAPISidebar}} and used GroupData.json anyway.

github-actions · 2023-04-13T05:37:26Z

Preview URLs (51 pages)

Flaws (40)

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

URL: /en-US/docs/Mozilla/Firefox/Releases/52
Title: Firefox 52 for developers
Flaw count: 2

macros:
- /en-US/docs/Web/API/Document/selectstart_event redirects to /en-US/docs/Web/API/Node/selectstart_event
- /en-US/docs/Web/API/Window/appinstalled does not exist

URL: /en-US/docs/Mozilla/Firefox/Releases/42
Title: Firefox 42 for developers
Flaw count: 7

macros:
- /en-US/docs/Web/API/HTMLInputElement/directory does not exist
- /en-US/docs/Web/API/HTMLInputElement/isFilesAndDirectoriesSupported does not exist
- /en-US/docs/Web/API/HTMLInputElement/getFilesAndDirectories does not exist
- /en-US/docs/Web/API/HTMLInputElement/chooseDirectory does not exist
- /en-US/docs/Web/API/Directory does not exist
- and 2 more flaws omitted

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

macros:
- /en-US/docs/Web/CSS/:-moz-full-screen-ancestor does not exist
- /en-US/docs/Web/API/Navigator/battery redirects to /en-US/docs/Web/API/Navigator/getBattery
- /en-US/docs/Web/API/HTMLInputElement/webkitGetEntries does not exist

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

broken_links:
- Can't resolve /en-US/docs/Web/JavaScript/Reference/Errors/Cant_access_property

URL: /en-US/docs/Web/HTML/Global_attributes
Title: Global attributes
Flaw count: 2

broken_links:
- Can't resolve /en-US/docs/Web/HTML/Global_attributes/popover
- Can't resolve /en-US/docs/Web/API/HTMLElement/showPopover/

URL: /en-US/docs/Web/HTML/Element
Title: HTML elements reference
Flaw count: 2

macros:
- /en-US/docs/Web/HTML/Element/content redirects to /en-US/docs/Web/HTML/Element/slot
- /en-US/docs/Web/HTML/Element/shadow does not exist

URL: /en-US/docs/Web/API/HTML_DOM_API
Title: The HTML DOM API
Flaw count: 6

macros:
- /en-US/docs/Web/API/HTMLDirectoryElement does not exist
- /en-US/docs/Web/API/HTMLFrameElement does not exist
- /en-US/docs/Web/API/HTMLIsIndexElement does not exist
- /en-US/docs/Web/API/External does not exist
- /en-US/docs/Web/API/ApplicationCache does not exist
- and 1 more flaws omitted

URL: /en-US/docs/Web/API/Window
Title: Window
Flaw count: 16

macros:
- /en-US/docs/Web/API/Window/content redirects to /en-US/docs/Web/API/Window
- /en-US/docs/Web/API/Window/returnValue does not exist
- /en-US/docs/Web/API/Window/setResizable does not exist
- /en-US/docs/Web/API/Window/animationcancel_event redirects to /en-US/docs/Web/API/Element/animationcancel_event
- /en-US/docs/Web/API/Window/animationend_event redirects to /en-US/docs/Web/API/Element/animationend_event
- and 9 more flaws omitted
broken_links:
- Can't resolve /en-US/docs/Web/API/Navigation_timing_API
- Can't resolve /en-US/docs/Web/API/Navigation_timing_API/Using_Navigation_Timing

URL: /en-US/docs/Web/CSS/:-moz-focusring
Title: :-moz-focusring
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: css.selectors.-moz-focusring

External URLs (10)

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

https://bugzil.la/1275838 (1 time) (Note! This may be a new URL 👀)

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

https://bugzil.la/1705141 (1 time) (Note! This may be a new URL 👀)

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

https://bugzil.la/1276579 (1 time) (Note! This may be a new URL 👀)

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

https://bugzil.la/1471947 (1 time) (Note! This may be a new URL 👀)
https://bugzil.la/1471948 (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTML/Element/slot
Title: <slot>: The Web Component Slot element

https://mdn.github.io/web-components-examples/element-details/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/HTMLElement/attachInternals
Title: HTMLElement: attachInternals() method

https://wicg.github.io/aom/explainer.html (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/MathML/Authoring
Title: Authoring MathML

https://fred-wang.github.io/TeXZilla/examples/customElement.html (1 time) (Note! This may be a new URL 👀)
https://github.com/fred-wang/TeXZilla (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/MathML/Examples
Title: Examples

https://en.wikipedia.org/wiki/LaTeX (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2023-04-13 21:16:19)

wbamberg · 2023-04-13T05:50:49Z

This is incongruous under Web/API as well though, isn't it? AFAIK this is the only landing-page under Web/API, and the only landing-page to get DefaultAPISidebar. There's a little history on this here: https://discourse.mozilla.org/t/defaultapisidebar-apiref-and-groupdata/40210/18.

I think we should decide whether it's a web-api-overview page, and if so put it in Web/API, or a landing-page and keep it where it is...

teoli2003 · 2023-04-13T05:54:14Z

I would see it as a web-api-overview then. Even if it touched a bit HTML, you need to use the API part of it to use it.

wbamberg · 2023-04-13T06:12:57Z

Fair enough, I'm happy with that for now.

I think the underlying issue here is that we have this IA in Web/API in which top-level things are supposed to be "Web APIs", narrowly conceived as things that map to specifications, but then we quite often want to talk about higher-level concepts that cut across "Web APIs", narrowly conceived, and we don't have a systematic way to present these. See also, things like the PWA docs and to a lesser extent the new Performance API docs.

Some day we will need to resolve this.

teoli2003 · 2023-04-13T06:14:25Z

Some day we will need to resolve this.

I think we will be able to resolve this the day we can have the Divio system applied at the top level. For this, we first need to clean the top level, though.

github-actions · 2023-04-13T08:01:00Z

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

wbamberg · 2023-04-13T21:07:54Z

This will also need:

       "overview": ["Web components"]

...in groupdata.json, or it won't appear in https://developer.mozilla.org/en-US/docs/Web/API and the sidebar won't have the name at the top:

I'm still a bit uncomfortable having this in Web/API, but I take the point that we don't have a perfect solution here.

teoli2003 · 2023-04-13T21:14:53Z

I'm still a bit uncomfortable having this in Web/API, but I take the point that we don't have a perfect solution here.

I agree: I think we won't have a good solution until we can apply the DIvio system at the top level. I really want to finish all the refactoring that started a few years ago so we can start working on this question later this year. I think there are too many things getting in the way for the moment.

wbamberg

Thanks @teoli2003 !

* Add page-type to Web_component and relocate them * Fix flaws * landing-page -> web-api-overview * Fix links – yarn content move should do this * Actually remove the files * Add overview page to GroupData

Add page-type to Web_component and relocate them

1b46782

teoli2003 requested a review from wbamberg April 13, 2023 05:35

teoli2003 requested review from a team as code owners April 13, 2023 05:35

github-actions bot added the Content:WebAPI Web API docs label Apr 13, 2023

Fix flaws

3cbc0fa

landing-page -> web-api-overview

0f4ad8a

teoli2003 added 2 commits April 13, 2023 08:55

Fix links – yarn content move should do this

f4ece66

Merge branch 'ptwebc' of github.com:teoli2003/content into ptwebc

f07f6ba

teoli2003 requested review from a team as code owners April 13, 2023 06:55

teoli2003 requested review from fred-wang, schalkneethling and estelle and removed request for a team April 13, 2023 06:55

github-actions bot added Content:CSS Cascading Style Sheets docs Content:Glossary Glossary entries Content:HTML Hypertext Markup Language docs Content:JS JavaScript docs Content:MathML MathML docs Content:Other Any docs not covered by another "Content:" label labels Apr 13, 2023

Actually remove the files

964fdf9

github-actions bot added the merge conflicts 🚧 [PR only] label Apr 13, 2023

Add overview page to GroupData

2e88bcb

teoli2003 requested a review from a team as a code owner April 13, 2023 21:12

teoli2003 requested review from dipikabh and removed request for a team April 13, 2023 21:12

Merge branch 'main' into ptwebc

d7051b0

github-actions bot removed the merge conflicts 🚧 [PR only] label Apr 13, 2023

wbamberg approved these changes Apr 13, 2023

View reviewed changes

wbamberg merged commit ac28748 into mdn:main Apr 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add page-type to Web_component and relocate them #26173

Add page-type to Web_component and relocate them #26173

teoli2003 commented Apr 13, 2023

github-actions bot commented Apr 13, 2023 •

edited

Loading

wbamberg commented Apr 13, 2023

teoli2003 commented Apr 13, 2023

wbamberg commented Apr 13, 2023

teoli2003 commented Apr 13, 2023

github-actions bot commented Apr 13, 2023

wbamberg commented Apr 13, 2023

teoli2003 commented Apr 13, 2023

wbamberg left a comment

Add page-type to Web_component and relocate them #26173

Add page-type to Web_component and relocate them #26173

Conversation

teoli2003 commented Apr 13, 2023

github-actions bot commented Apr 13, 2023 • edited Loading

wbamberg commented Apr 13, 2023

teoli2003 commented Apr 13, 2023

wbamberg commented Apr 13, 2023

teoli2003 commented Apr 13, 2023

github-actions bot commented Apr 13, 2023

wbamberg commented Apr 13, 2023

teoli2003 commented Apr 13, 2023

wbamberg left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 13, 2023 •

edited

Loading