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

Add browser removal/addition data guidelines #7244

Merged

Conversation

sideshowbarker
Copy link
Contributor

This change adds data guidelines on removal of existing browsers from BCD, and addition of new browsers to BCD.

Related: #7238

This change adds data guidelines on removal of existing browsers from
BCD, and addition of new browsers to BCD.

Related: mdn#7238
@queengooborg
Copy link
Contributor

(@ddbeck It seems the auto-labeler didn't catch this PR. Perhaps a problem with the glob?)

@queengooborg queengooborg added the docs Issues or pull requests regarding the documentation of this project. label Nov 3, 2020
@ddbeck
Copy link
Collaborator

ddbeck commented Nov 3, 2020

@vinyldarkscratch I opened #7250 to track the labeler problem.

Copy link
Collaborator

@ddbeck ddbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for opening this, @sideshowbarker. One suggestion in a line comment.

(Like the removal PR, this will likely be blocked until I hear back from Chris. I don't actually anticipate this proposal being rejected though.)

docs/data-guidelines.md Show resolved Hide resolved
@queengooborg queengooborg requested a review from ddbeck November 17, 2020 08:15
@ddbeck ddbeck requested a review from Elchi3 November 19, 2020 17:59
Copy link
Collaborator

@ddbeck ddbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had a few more suggestions, now that I've had some distance from this. Thank you!

docs/data-guidelines.md Outdated Show resolved Hide resolved
docs/data-guidelines.md Outdated Show resolved Hide resolved
docs/data-guidelines.md Outdated Show resolved Hide resolved
docs/data-guidelines.md Outdated Show resolved Hide resolved
docs/data-guidelines.md Show resolved Hide resolved
@sideshowbarker
Copy link
Contributor Author

Had a few more suggestions, now that I've had some distance from this.

Doublechecked them all and everything looks good, except that I see we’ve got a lint failure. Will investigate right now

Co-authored-by: Daniel D. Beck <daniel@ddbeck.com>
@sideshowbarker sideshowbarker force-pushed the sideshowbarker/browser-removal-addition-data-guidelines branch from 90dffc7 to 3ee5226 Compare November 20, 2020 11:09
@sideshowbarker
Copy link
Contributor Author

I see we’ve got a lint failure. Will investigate right now

OK, pushed a fix and we’re now all green again for CI/lint

@Elchi3
Copy link
Member

Elchi3 commented Nov 23, 2020

Thanks for coming up with these guidelines. Long overdue to specify this :-)

The original browsers in BCD are based on what the MDN wiki had in the old compat tables which were added by MDN contributors over the years. The wiki had sets of different browsers on different pages, but there was a set of browsers that occurred often. So, BCD came to its original list of browsers via the data migration and avoiding to lose information.

I remember BCD added and removed Servo. I think a removal reason was that there aren't real releases and versions numbers.
I think "published release information" might cover this in the addition guideline, ie. for adding a browser we should require that it actually has releases, so that recording compat data makes sense. (there are other experimental projects that asked to be added to BCD and it wasn't always clear to me if/when they actually have releases). We might want to state this explicitly.

Another removal that I remember is Edge mobile. See #3888. It seems to retroactively meet the removal criteria mentioned here.
Before we agreed to remove it, I sent an inquiry to the Microsoft MDN PAB representatives to comment on the removal. I don't know if it would be worth to mention it in the guideline that it is at least worth to try contacting vendors before removal.

Finally, I'd like to mention that BCD's Opera and Opera Android data seems to (almost) meet our removal criteria. Is there another criteria that makes us keep opera? Is it (historical) marketshare? Something else?

@ddbeck
Copy link
Collaborator

ddbeck commented Nov 24, 2020

@Elchi3 Good points on this, thank you for taking a look.

In general, my original proposal was meant to be a guideline for making a holistic decision, weighted heavily toward what's good for BCD consumers and their readers. Perhaps we could rephrase things to say something like, "BCD owners will consider the following…" to show that it's not a complete or absolute set of criteria. This might help with a few of these other issues.

To your more specific points:

for adding a browser we should require that it actually has releases, so that recording compat data makes sense. (there are other experimental projects that asked to be added to BCD and it wasn't always clear to me if/when they actually have releases). We might want to state this explicitly.

Yeah, I was trying to capture something like this with the published release information proposal. I wanted something a bit more substantial than being able to populate a browser data file. I want to know about release process and plans too. I'm open to rewording this, if you've got any ideas.

I don't know if it would be worth to mention it in the guideline that it is at least worth to try contacting vendors before removal.

I don't want to bind us to this. For the removals we have pending, I'm not even sure who I would contact and I don't think there would be any change in the outcome based on that conversation. I'd welcome the return of those browsers, but it seems preferable in a lot of ways to start from scratch. And if a browser has vendor participants here, I would expect (and ask) for their help on matters related to that browser prior to removal anyway.

I'd like to mention that BCD's Opera and Opera Android data seems to (almost) meet our removal criteria. Is there another criteria that makes us keep opera? Is it (historical) marketshare? Something else?

This is a good point. I think the biggest open question there is downstream: do MDN or caniuse readers care? I think if we adopt these guidelines, then we should open an issue to investigate this. The answer might be to keep it (we do update Opera data rather frequently), but it's not a bad idea to take a look.

docs/data-guidelines.md Outdated Show resolved Hide resolved
@Elchi3
Copy link
Member

Elchi3 commented Nov 24, 2020

In general, my original proposal was meant to be a guideline for making a holistic decision, weighted heavily toward what's good for BCD consumers and their readers. Perhaps we could rephrase things to say something like, "BCD owners will consider the following…" to show that it's not a complete or absolute set of criteria. This might help with a few of these other issues.

Makes sense to me. After all, a removal or an addition will be discussed in an issue anyways and arguments will be weighted against each other. The guidelines here provide general guidance and hopefully allow us to consider criteria more fairly for the various requests.

I don't want to bind us to this. For the removals we have pending, I'm not even sure who I would contact and I don't think there would be any change in the outcome based on that conversation. I'd welcome the return of those browsers, but it seems preferable in a lot of ways to start from scratch. And if a browser has vendor participants here, I would expect (and ask) for their help on matters related to that browser prior to removal anyway.

Yep, makes sense. I think we don't need to add anything about it then.

This is a good point. I think the biggest open question there is downstream: do MDN or caniuse readers care? I think if we adopt these guidelines, then we should open an issue to investigate this. The answer might be to keep it (we do update Opera data rather frequently), but it's not a bad idea to take a look.

Yeah, opening an issue for discussion is a must have for adding/removing a browser. I think this is obvious, but if anyone cares strongly, it could also be mentioned in the guideline that there must be a discussion in an issue about the case.

Co-authored-by: Daniel D. Beck <daniel@ddbeck.com>
Copy link
Collaborator

@ddbeck ddbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we're ready to go on this. Thank you, @sideshowbarker and @Elchi3 for making this really solid! 🎉

@ddbeck ddbeck merged commit 889a90c into mdn:master Nov 30, 2020
@sideshowbarker sideshowbarker deleted the sideshowbarker/browser-removal-addition-data-guidelines branch December 2, 2020 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues or pull requests regarding the documentation of this project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants