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

Automatically add dev-doc-needed flag #2440

Open
SebastianZ opened this issue Jul 11, 2024 · 3 comments
Open

Automatically add dev-doc-needed flag #2440

SebastianZ opened this issue Jul 11, 2024 · 3 comments

Comments

@SebastianZ
Copy link

SebastianZ commented Jul 11, 2024

When bugs for new web platform features are created, the reporters very often don't set the dev-doc-needed flag to notify the MDN team that the feature needs to be documented on MDN. And it requires quite some effort for the MDN team and others like me to look though all the bugs and check which things need to be documented.

So it would be great if this could be automated as far as possible.

Some criteria to consider is

  • Product: "Core"
  • Components: everything web platform features related, might be all related to "Audio/Video", "CSS", "DOM", "Graphics", "Internationalization", "JavaScript", "Layout", "MathML", "Networking", "Panning and Zooming", "Performance", "Privacy", "Security", "Storage", "SVG", "Web Audio", "Web Speech", "WebRTC", "WebVR", "XML", and "XSLT"
  • Type: enhancement and task (Though it's often forgotten to set the type, so many features are filed as "defect". Therefore I'm not sure about that.)
  • Flags: not "meta"

and there are other, optional indicators like

  • certain keywords in the summary like "implement", "implementation", "add", "support", "consider", "update", "deprecate", "drop", "remove", "ship", "trains" (from "Let xyz ride the trains"), "enable", and "api".
  • a specification URL under the related URLs.
  • certain flags like DevAdvocacy, parity-*, and site-compat.
  • [DevRel or [layout in the Whiteboard field.

@hamishwillee and others from the MDN team may provide some more feedback on this.

Sebastian

@marco-c
Copy link
Contributor

marco-c commented Jul 11, 2024

We have a prototype model for this in bugbug which we could improve and validate: https://github.com/mozilla/bugbug/blob/master/bugbug/models/devdocneeded.py.

@hamishwillee
Copy link

hamishwillee commented Jul 11, 2024

@SebastianZ Thanks very much - I've pinged the rest of the Mozilla-employed MDN content authors for comment.

This is a good idea. It might be even better if it could be done as wizard like behaviour that prompted the submitter on creation (though that might be too obtrusive) so that they thought about it (I worry about a flood of false positives).
"Ship" is definitely something to look at as part of the selection criteria.

FYI Recently the browser-compat-team have made finding the missed release issues a bit easier for us via testing - such as mdn/browser-compat-data#23730.
The thing to note here is that compat tests look at IDL in specs, and may not catch some things that cannot be automatically detected, such as support for optional params in values passed to methods.

EDIT, we might also want to do some work to look at what should not be included. For example, I wasn't sure on https://bugzilla.mozilla.org/show_bug.cgi?id=1901491 , and the answer is "not yet".

@hamishwillee
Copy link

@SebastianZ We missed this one that wasn't tagged https://bugzilla.mozilla.org/show_bug.cgi?id=1825580. However it was tagged with need for a relnote, so triggering on this would be good too
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants