Move Web/API statics to _static URLs #26132

wbamberg · 2023-04-12T00:54:26Z

Description

Motivation

Additional details

Related issues and pull requests

github-actions · 2023-04-12T00:57:14Z

Preview URLs (42 pages)

Flaws (20)

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

URL: /en-US/docs/Web/API/RTCPeerConnection/generateCertificate_static
Title: RTCPeerConnection: generateCertificate() static method
Flaw count: 4

macros:
- /en-US/docs/Web/API/AlgorithmIdentifier does not exist
- /en-US/docs/Web/API/Algorithm does not exist
- /en-US/docs/Web/API/RTCCertificateExpiration does not exist
- /en-US/docs/Web/API/Algorithm does not exist

URL: /en-US/docs/Web/API/MouseEvent/WEBKIT_FORCE_AT_MOUSE_DOWN_static
Title: MouseEvent: WEBKIT_FORCE_AT_MOUSE_DOWN static property
Flaw count: 1

macros:
- /en-US/docs/Web/API/MouseEvent/WEBKIT_FORCE_AT_FORCE_MOUSE_DOWN redirects to /en-US/docs/Web/API/MouseEvent/WEBKIT_FORCE_AT_FORCE_MOUSE_DOWN_static

URL: /en-US/docs/Web/API/MouseEvent/WEBKIT_FORCE_AT_FORCE_MOUSE_DOWN_static
Title: MouseEvent: WEBKIT_FORCE_AT_FORCE_MOUSE_DOWN static property
Flaw count: 1

macros:
- /en-US/docs/Web/API/MouseEvent/WEBKIT_FORCE_AT_MOUSE_DOWN redirects to /en-US/docs/Web/API/MouseEvent/WEBKIT_FORCE_AT_MOUSE_DOWN_static

URL: /en-US/docs/Web/API/MediaSource/isTypeSupported_static
Title: MediaSource: isTypeSupported() static method
Flaw count: 1

macros:
- wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/MediaSource/canConstructInDedicatedWorker_static
Title: MediaSource: canConstructInDedicatedWorker static property
Flaw count: 1

macros:
- wrong xref macro used (consider changing which macro you use)

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

macros:
- /en-US/docs/Web/API/RTCRtpSender/getCapabilities redirects to /en-US/docs/Web/API/RTCRtpSender/getCapabilities_static

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

macros:
- /en-US/docs/Web/API/RTCRtpReceiver/getCapabilities redirects to /en-US/docs/Web/API/RTCRtpReceiver/getCapabilities_static

URL: /en-US/docs/Web/API/URL/createObjectURL_static
Title: URL: createObjectURL() static method
Flaw count: 4

macros:
- /en-US/docs/Web/API/URL/revokeObjectURL redirects to /en-US/docs/Web/API/URL/revokeObjectURL_static
- /en-US/docs/Web/API/URL/revokeObjectURL redirects to /en-US/docs/Web/API/URL/revokeObjectURL_static
- /en-US/docs/Web/API/URL/createObjectURL redirects to /en-US/docs/Web/API/URL/createObjectURL_static
- /en-US/docs/Web/API/URL/revokeObjectURL redirects to /en-US/docs/Web/API/URL/revokeObjectURL_static

URL: /en-US/docs/Web/API/URL/revokeObjectURL_static
Title: URL: revokeObjectURL() static method
Flaw count: 3

macros:
- /en-US/docs/Web/API/URL/createObjectURL redirects to /en-US/docs/Web/API/URL/createObjectURL_static
- /en-US/docs/Web/API/URL/createObjectURL redirects to /en-US/docs/Web/API/URL/createObjectURL_static
- /en-US/docs/Web/API/URL/createObjectURL redirects to /en-US/docs/Web/API/URL/createObjectURL_static

URL: /en-US/docs/Web/API/CSS/RegisterProperty_static
Title: CSS: registerProperty() static method
Flaw count: 3

macros:
- /en-US/docs/Web/API/CSS/supports redirects to /en-US/docs/Web/API/CSS/supports_static
- /en-US/docs/Web/API/CSS/escape redirects to /en-US/docs/Web/API/CSS/escape_static
- /en-US/docs/Web/API/CSS/factory_functions redirects to /en-US/docs/Web/API/CSS/factory_functions_static

(comment last updated: 2023-04-12 03:06:03)

OnkarRuikar · 2023-04-12T02:29:08Z

This is going to create so many redirects in content I wish we had merged feature(tool/move): update files pointing to the moved document(s) yari#8493

@teoli2003 we definitely have to merge it before CSS content restructuring.

About the front-matter attribute order change, let me know if we've decided/finalized on this order. Is it documented somewhere in meta docs or discussions?

I am using this one Required linter/validator for frontmatter yari#7900 (comment) in BCD synchronizaiton script.

files/en-us/web/api/abortsignal/abort_static/index.md

files/en-us/web/api/abortsignal/timeout_static/index.md

files/en-us/web/api/audiodecoder/isconfigsupported_static/index.md

files/en-us/web/api/audioencoder/isconfigsupported_static/index.md

files/en-us/web/api/barcodedetector/getsupportedformats_static/index.md

files/en-us/web/api/css/escape_static/index.md

files/en-us/web/api/css/highlights_static/index.md

files/en-us/web/api/css/paintworklet_static/index.md

files/en-us/web/api/css/registerproperty_static/index.md

files/en-us/web/api/css/supports_static/index.md

files/en-us/web/api/cssnumericvalue/parse_static/index.md

files/en-us/web/api/dompoint/frompoint_static/index.md

files/en-us/web/api/dompointreadonly/frompoint_static/index.md

files/en-us/web/api/domrect/fromrect_static/index.md

files/en-us/web/api/domrectreadonly/fromrect_static/index.md

files/en-us/web/api/htmlscriptelement/supports_static/index.md

files/en-us/web/api/idbkeyrange/bound_static/index.md

files/en-us/web/api/idbkeyrange/lowerbound_static/index.md

files/en-us/web/api/idbkeyrange/only_static/index.md

files/en-us/web/api/idbkeyrange/upperbound_static/index.md

files/en-us/web/api/imagedecoder/istypesupported_static/index.md

files/en-us/web/api/mediarecorder/istypesupported_static/index.md

files/en-us/web/api/mediasource/canconstructindedicatedworker_static/index.md

files/en-us/web/api/mediasource/istypesupported_static/index.md

files/en-us/web/api/mouseevent/webkit_force_at_force_mouse_down_static/index.md

files/en-us/web/api/mouseevent/webkit_force_at_mouse_down_static/index.md

files/en-us/web/api/notification/maxactions_static/index.md

files/en-us/web/api/notification/permission_static/index.md

wbamberg · 2023-04-12T02:57:22Z

files/en-us/web/api/notification/requestpermission_static/index.md

+title: 'Notification: requestPermission() static method'
+slug: Web/API/Notification/requestPermission_static
 page-type: web-api-static-method
 browser-compat: api.Notification.requestPermission
+short-title: requestPermission()


Suggested change

title: 'Notification: requestPermission() static method'

slug: Web/API/Notification/requestPermission_static

page-type: web-api-static-method

browser-compat: api.Notification.requestPermission

short-title: requestPermission()

title: 'Notification: requestPermission() static method'

short-title: requestPermission()

slug: Web/API/Notification/requestPermission_static

page-type: web-api-static-method

browser-compat: api.Notification.requestPermission

wbamberg · 2023-04-12T02:57:38Z

files/en-us/web/api/performanceobserver/supportedentrytypes_static/index.md

+title: 'PerformanceObserver: supportedEntryTypes static property'
+slug: Web/API/PerformanceObserver/supportedEntryTypes_static
 page-type: web-api-static-property
 browser-compat: api.PerformanceObserver.supportedEntryTypes
+short-title: supportedEntryTypes


Suggested change

title: 'PerformanceObserver: supportedEntryTypes static property'

slug: Web/API/PerformanceObserver/supportedEntryTypes_static

page-type: web-api-static-property

browser-compat: api.PerformanceObserver.supportedEntryTypes

short-title: supportedEntryTypes

title: 'PerformanceObserver: supportedEntryTypes static property'

short-title: supportedEntryTypes

slug: Web/API/PerformanceObserver/supportedEntryTypes_static

page-type: web-api-static-property

browser-compat: api.PerformanceObserver.supportedEntryTypes

wbamberg · 2023-04-12T02:58:04Z

...us/web/api/publickeycredential/isuserverifyingplatformauthenticatoravailable_static/index.md

+title: >-
+  PublicKeyCredential: isUserVerifyingPlatformAuthenticatorAvailable() static
+  method
+slug: >-
+  Web/API/PublicKeyCredential/isUserVerifyingPlatformAuthenticatorAvailable_static
 page-type: web-api-static-method
 browser-compat: api.PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable
+short-title: isUserVerifyingPlatformAuthenticatorAvailable()


Suggested change

title: >-

PublicKeyCredential: isUserVerifyingPlatformAuthenticatorAvailable() static

method

slug: >-

Web/API/PublicKeyCredential/isUserVerifyingPlatformAuthenticatorAvailable_static

page-type: web-api-static-method

browser-compat: api.PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable

short-title: isUserVerifyingPlatformAuthenticatorAvailable()

title: >-

PublicKeyCredential: isUserVerifyingPlatformAuthenticatorAvailable() static

method

short-title: isUserVerifyingPlatformAuthenticatorAvailable()

slug: >-

Web/API/PublicKeyCredential/isUserVerifyingPlatformAuthenticatorAvailable_static

page-type: web-api-static-method

browser-compat: api.PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable

wbamberg · 2023-04-12T02:58:38Z

files/en-us/web/api/response/error_static/index.md

+title: 'Response: error() static method'
+slug: Web/API/Response/error_static
 page-type: web-api-static-method
 browser-compat: api.Response.error
+short-title: error()


Suggested change

title: 'Response: error() static method'

slug: Web/API/Response/error_static

page-type: web-api-static-method

browser-compat: api.Response.error

short-title: error()

title: 'Response: error() static method'

short-title: error()

slug: Web/API/Response/error_static

page-type: web-api-static-method

browser-compat: api.Response.error

wbamberg · 2023-04-12T02:58:52Z

files/en-us/web/api/response/redirect_static/index.md

+title: 'Response: redirect() static method'
+slug: Web/API/Response/redirect_static
 page-type: web-api-static-method
 browser-compat: api.Response.redirect
+short-title: redirect()


Suggested change

title: 'Response: redirect() static method'

slug: Web/API/Response/redirect_static

page-type: web-api-static-method

browser-compat: api.Response.redirect

short-title: redirect()

title: 'Response: redirect() static method'

short-title: redirect()

slug: Web/API/Response/redirect_static

page-type: web-api-static-method

browser-compat: api.Response.redirect

wbamberg · 2023-04-12T02:59:07Z

files/en-us/web/api/rtcpeerconnection/generatecertificate_static/index.md

+title: 'RTCPeerConnection: generateCertificate() static method'
+slug: Web/API/RTCPeerConnection/generateCertificate_static
 page-type: web-api-static-method
 browser-compat: api.RTCPeerConnection.generateCertificate
+short-title: generateCertificate()


Suggested change

title: 'RTCPeerConnection: generateCertificate() static method'

slug: Web/API/RTCPeerConnection/generateCertificate_static

page-type: web-api-static-method

browser-compat: api.RTCPeerConnection.generateCertificate

short-title: generateCertificate()

title: 'RTCPeerConnection: generateCertificate() static method'

short-title: generateCertificate()

slug: Web/API/RTCPeerConnection/generateCertificate_static

page-type: web-api-static-method

browser-compat: api.RTCPeerConnection.generateCertificate

wbamberg · 2023-04-12T02:59:20Z

files/en-us/web/api/rtcrtpreceiver/getcapabilities_static/index.md

+title: 'RTCRtpReceiver: getCapabilities() static method'
+slug: Web/API/RTCRtpReceiver/getCapabilities_static
 page-type: web-api-static-method
 browser-compat: api.RTCRtpReceiver.getCapabilities
+short-title: getCapabilities()


Suggested change

title: 'RTCRtpReceiver: getCapabilities() static method'

slug: Web/API/RTCRtpReceiver/getCapabilities_static

page-type: web-api-static-method

browser-compat: api.RTCRtpReceiver.getCapabilities

short-title: getCapabilities()

title: 'RTCRtpReceiver: getCapabilities() static method'

short-title: getCapabilities()

slug: Web/API/RTCRtpReceiver/getCapabilities_static

page-type: web-api-static-method

browser-compat: api.RTCRtpReceiver.getCapabilities

wbamberg · 2023-04-12T02:59:34Z

files/en-us/web/api/rtcrtpsender/getcapabilities_static/index.md

+title: 'RTCRtpSender: getCapabilities() static method'
+slug: Web/API/RTCRtpSender/getCapabilities_static
 page-type: web-api-static-method
 browser-compat: api.RTCRtpSender.getCapabilities
+short-title: getCapabilities()


Suggested change

title: 'RTCRtpSender: getCapabilities() static method'

slug: Web/API/RTCRtpSender/getCapabilities_static

page-type: web-api-static-method

browser-compat: api.RTCRtpSender.getCapabilities

short-title: getCapabilities()

title: 'RTCRtpSender: getCapabilities() static method'

short-title: getCapabilities()

slug: Web/API/RTCRtpSender/getCapabilities_static

page-type: web-api-static-method

browser-compat: api.RTCRtpSender.getCapabilities

wbamberg · 2023-04-12T02:59:49Z

files/en-us/web/api/url/createobjecturl_static/index.md

+title: 'URL: createObjectURL() static method'
+slug: Web/API/URL/createObjectURL_static
 page-type: web-api-static-method
 browser-compat: api.URL.createObjectURL
+short-title: createObjectURL()


Suggested change

title: 'URL: createObjectURL() static method'

slug: Web/API/URL/createObjectURL_static

page-type: web-api-static-method

browser-compat: api.URL.createObjectURL

short-title: createObjectURL()

title: 'URL: createObjectURL() static method'

short-title: createObjectURL()

slug: Web/API/URL/createObjectURL_static

page-type: web-api-static-method

browser-compat: api.URL.createObjectURL

wbamberg · 2023-04-12T03:00:02Z

files/en-us/web/api/url/revokeobjecturl_static/index.md

+title: 'URL: revokeObjectURL() static method'
+slug: Web/API/URL/revokeObjectURL_static
 page-type: web-api-static-method
 browser-compat: api.URL.revokeObjectURL
+short-title: revokeObjectURL()


Suggested change

title: 'URL: revokeObjectURL() static method'

slug: Web/API/URL/revokeObjectURL_static

page-type: web-api-static-method

browser-compat: api.URL.revokeObjectURL

short-title: revokeObjectURL()

title: 'URL: revokeObjectURL() static method'

short-title: revokeObjectURL()

slug: Web/API/URL/revokeObjectURL_static

page-type: web-api-static-method

browser-compat: api.URL.revokeObjectURL

wbamberg · 2023-04-12T03:00:16Z

files/en-us/web/api/videodecoder/isconfigsupported_static/index.md

+title: 'VideoDecoder: isConfigSupported() static method'
+slug: Web/API/VideoDecoder/isConfigSupported_static
 page-type: web-api-static-method
 browser-compat: api.VideoDecoder.isConfigSupported
+short-title: isConfigSupported()


Suggested change

title: 'VideoDecoder: isConfigSupported() static method'

slug: Web/API/VideoDecoder/isConfigSupported_static

page-type: web-api-static-method

browser-compat: api.VideoDecoder.isConfigSupported

short-title: isConfigSupported()

title: 'VideoDecoder: isConfigSupported() static method'

short-title: isConfigSupported()

slug: Web/API/VideoDecoder/isConfigSupported_static

page-type: web-api-static-method

browser-compat: api.VideoDecoder.isConfigSupported

wbamberg · 2023-04-12T03:00:30Z

files/en-us/web/api/videoencoder/isconfigsupported_static/index.md

+title: 'VideoEncoder: isConfigSupported() static method'
+slug: Web/API/VideoEncoder/isConfigSupported_static
 page-type: web-api-static-method
 browser-compat: api.VideoEncoder.isConfigSupported
+short-title: isConfigSupported()


Suggested change

title: 'VideoEncoder: isConfigSupported() static method'

slug: Web/API/VideoEncoder/isConfigSupported_static

page-type: web-api-static-method

browser-compat: api.VideoEncoder.isConfigSupported

short-title: isConfigSupported()

title: 'VideoEncoder: isConfigSupported() static method'

short-title: isConfigSupported()

slug: Web/API/VideoEncoder/isConfigSupported_static

page-type: web-api-static-method

browser-compat: api.VideoEncoder.isConfigSupported

wbamberg · 2023-04-12T03:00:53Z

files/en-us/web/api/xrwebgllayer/getnativeframebufferscalefactor_static/index.md

+title: 'XRWebGLLayer: getNativeFramebufferScaleFactor() static method'
+slug: Web/API/XRWebGLLayer/getNativeFramebufferScaleFactor_static
 page-type: web-api-static-method
+browser-compat: api.XRWebGLLayer.getNativeFramebufferScaleFactor
+short-title: getNativeFramebufferScaleFactor()
 status:
  - experimental


Suggested change

title: 'XRWebGLLayer: getNativeFramebufferScaleFactor() static method'

slug: Web/API/XRWebGLLayer/getNativeFramebufferScaleFactor_static

page-type: web-api-static-method

browser-compat: api.XRWebGLLayer.getNativeFramebufferScaleFactor

short-title: getNativeFramebufferScaleFactor()

status:

- experimental

title: 'XRWebGLLayer: getNativeFramebufferScaleFactor() static method'

short-title: getNativeFramebufferScaleFactor()

slug: Web/API/XRWebGLLayer/getNativeFramebufferScaleFactor_static

page-type: web-api-static-method

status:

- experimental

browser-compat: api.XRWebGLLayer.getNativeFramebufferScaleFactor

files/en-us/web/api/audioencoder/isconfigsupported_static/index.md

OnkarRuikar · 2023-04-12T03:19:51Z

If possible we do not have to change double quotes " in the title considering double(~5514) vs single(~147) in the repo and #26028 (comment).

wbamberg · 2023-04-12T04:14:36Z

This is going to create so many redirects in content I wish we had merged feature(tool/move): update files pointing to the moved document(s) yari#8493

This isn't merged yet! And I'd be happy to block it for a while if that one is likely to get in any time soon. I'm not totally sure it's what we want to do (but think it probably is).

I also think we should basically deprecate domxref calls like {{domxref("Interface.member")}}, and encourage people to do:

{{domxref("Interface/member")} for non-static
{{domxref("Interface/member_static")} for non-static

...and have domxref cook up sensible link text (unless param 2 is given).

@teoli2003 we definitely have to merge it before CSS content restructuring.

About the front-matter attribute order change, let me know if we've decided/finalized on this order. Is it documented somewhere in meta docs or discussions?

No, we should though. But it makes sense (to me) to have short-title right after title. I think this is connected to mdn/yari#7825 (comment).

wbamberg · 2023-04-12T04:15:29Z

If possible we do not have to change double quotes " in the title considering double(~5514) vs single(~147) in the repo and #26028 (comment).

I would love that but this is what yarn content move does 🙄 . So it would be great to get that fixed.

github-actions · 2023-04-12T04:36:40Z

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

teoli2003 · 2023-04-12T05:31:51Z

About the front-matter attribute order change, let me know if we've decided/finalized on this order. Is it documented somewhere in meta docs or discussions?

No, we should though. But it makes sense (to me) to have short-title right after title. I think this is connected to mdn/yari#7825 (comment).

We should document the order and enforce it with linting. We have many YAML headers nowadays. Does anybody know a good YAML linter?

OnkarRuikar · 2023-04-12T06:36:36Z

We should document the order and enforce it with linting. We have many YAML headers nowadays. Does anybody know a good YAML linter?

It's been already implemented here feat(lint): Implement front matter validator and linter yari#8295 using js-yaml that validates our custom schema.
But the PR hasn't gone anywhere. 😠
Prettier does pass front-matter through it's yaml parser, but for prettifying purposes only. Above PR does do schema validation and more.

Do we need a GitHub discussion to fix the order of front-matter attributes?

OnkarRuikar · 2023-04-12T07:08:30Z

If possible we do not have to change double quotes " in the title considering double(~5514) vs single(~147) in the repo and #26028 (comment).

I would love that but this is what yarn content move does roll_eyes . So it would be great to get that fixed.

fixed in fix: prevent yarn content move from converting double quotes to single quotes yari#8623

wbamberg · 2023-04-28T17:13:19Z

Closing in favour of #26482.

Move Web/API statics to _static URLs

299a8b5

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