mdn / pab

MDN Web Docs Product Advisory Board
26 stars 17 forks source link

Coordinated workflows between spec changes and doc updates #26

Closed dontcallmedom closed 1 year ago

dontcallmedom commented 6 years ago

It would be great to set up workflows whereby a developer-impacting change in a spec would flag the need to update the corresponding MDN article(s).

Ideas to accomplish this include:

A possible inspiration for such a workflow is the one set up whereby some groups have committed to always file issues or pull requests on the relevant test suite whenever a change is made in a spec, known as "Test as you commit".

chrisdavidmills commented 6 years ago

We have already had a similar discussion over at WHATWG about doing something similar:

https://github.com/whatwg/meta/issues/62

I think monitoring a specific label on certain issues/PRs in some way works quite well. We could pull them into a spreadsheet, or just manually look at a list periodically.

domfarolino commented 6 years ago

have tools that can automatically detect some of the developer-impacting change in a spec (e.g. when the WebIDL fragments change?)

I'd say this probably isn't too feasible, as it is tough to determine, even without an IDL change, what shifting of things around results in an editorial or normative change.

I agree with the monitoring of labels, I'll go ahead and submit a PR to the whatwg/meta thread that @chrisdavidmills linked to, so WHATWG can get an official label for MDN to track in the mix.

chrisdavidmills commented 6 years ago

@domfarolino nice, thanks.

chrisdavidmills commented 5 years ago

This is working fairly well on the WHATWG side; repeating on the W3C side would perhaps be a little repetitious?

chrisdavidmills commented 5 years ago

^ I take back this last comment. This would be good to replicate over at W3C.

jpmedley commented 5 years ago

I would like to volunteer for this one as well.