mdn / yari

The platform code behind MDN Web Docs
Mozilla Public License 2.0
1.19k stars 503 forks source link

Make release numbers in BCD notes a link to the browser's release notes #9704

Open estelle opened 1 year ago

estelle commented 1 year ago

What would you like to see added to BCD?

when there is a flag in the BCD, such as "X 91 (Released 2021-08-10) 🏳️" it would be great if the "91 (Released 2021-08-10)" would link to the release notes

in this case, the date would point to https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Releases/91

this example comes from https://developer.mozilla.org/en-US/docs/Web/CSS/content#browser_compatibility, which isn't discussed in the release notes, but a link would have been helpful if it had ;)

How impactful do you think this enhancement will be?

pretty helpful, especially if something is removed or partially supported, it helps the dev quickly find the resources to the underlying issues. The context may be removed from MDN documentation, but it will persist in the release notes.

Do you have anything more you want to share?

No response

### Tasks
- [ ] Check if the release notes links are already in BCD
Elchi3 commented 1 year ago

BCD exports the URL to release notes as browsers.firefox.releases[1].release_notes. So, this isn't a data issue but a renderer issue. Moving to Yari.

Rumyra commented 1 year ago

There is a caveat here with the example @estelle mentions - the feature was released behind a flag, but then there was a spec change and now it's off by default. Features behind a flag are not added to FF release notes, but to the experimental features page, so linking to release notes in this example wouldn't help. (In addition it was removed from experimental features due to the change see https://github.com/mdn/content/pull/7963)

I guess bcd should be updated...

However do we have any more examples other than this where linking to release notes or implementation bugs would be helpful?

caugner commented 7 months ago

@estelle @Elchi3 Would you like to add anything to Ruth's question?

However do we have any more examples other than this where linking to release notes or implementation bugs would be helpful?

If not, I would go ahead and close this issue.

Elchi3 commented 7 months ago

@estelle @Elchi3 Would you like to add anything to Ruth's question? However do we have any more examples other than this where linking to release notes or implementation bugs would be helpful?

Implementation bugs are now surfaced, see https://github.com/mdn/yari/pull/10549.

Linking to release notes from the version numbers might be helpful to learn more about the releases as Estelle said. It's an assumption though, I have no other research or opinion on this other than "worth trying" and seeing if it can proof helpful.

There is a caveat here with the example @estelle mentions - the feature was released behind a flag, but then there was a spec change and now it's off by default. Features behind a flag are not added to FF release notes, but to the experimental features page, so linking to release notes in this example wouldn't help.

I think this caveat is no longer true? Vadim presented how Mozilla changed their content policy on their release notes to mention experimental features: https://github.com/mdn/community-meetings/blob/main/2024-01-22/minutes.md#firefox-experimental-features-page-workflow-pepelsbey

More generally speaking, release notes published by browser vendors can have varying content. So, I don't know what criteria should be met for them to be worthy of linkage from the compat tables. Again, my feeling is that a link couldn't hurt (probably).

Rumyra commented 6 months ago

Correct @Elchi3 - anything past FF121 will have experimental features in the notes 👍