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

Document supported platforms in the README file #457

Closed
3 tasks done
funkyboy opened this issue Feb 1, 2018 · 6 comments
Closed
3 tasks done

Document supported platforms in the README file #457

funkyboy opened this issue Feb 1, 2018 · 6 comments
Assignees
Labels
enhancement New feature or improved functionality.

Comments

@funkyboy
Copy link
Contributor

funkyboy commented Feb 1, 2018

  • add section to the README that says which platforms we support
  • Add node 4.2, 6.13, 8.9.4, latest stable
  • Add browsers IE8, 9, 10, 11, 16, Chrome, Firefox, Safari 11 on iOS, Safari 11 on macOS, Chrome Android 6
@funkyboy funkyboy self-assigned this Feb 1, 2018
@funkyboy
Copy link
Contributor Author

funkyboy commented Feb 1, 2018

@paddybyers @mattheworiordan need your help on the TBD ^

@paddybyers
Copy link
Member

When this was first implemented, we intended to support all desktop browsers with the exception of IE6 and earlier, and all versions of iOS Safari and Android's browser. I think we officially stopped supporting IE7 (which I think was the only browser that didn't support JSON natively). We also officially stopped supporting some transports (iframe and flash websockets) - but this didn't stop any browsers from working; it only meant that certain browsers would fall back to JSONP.

@SimonWoolf has done most of the cross-browser work and fixed multiple issues over the years but I wasn't aware of specific problems that would cause any of the "supported" browsers (ie IE8+, Safari, Chrome, Firefox, Opera, Android) to fail.

Then we have unsupported features. For example, we use local storage to persist connection state for recover mode; not all browsers support that, but it just means that for some browsers either recover isn't supported, or the site would need to implement something itself.

So then the question is which ones do we test - and if we find problems, how much effort do we put into fixing them? If a browser (eg IE8) shows a large number of test failures, and we think the IE8 population is too small to worry about, then we can list IE8 as unsupported. Otherwise, we could document known issues for certain browsers if those issues affect only certain use-cases (eg "crypto is unsupported on IE8").

So TBH I think to advertise a formal supported browsers list we need more concrete data so we know where the issues are, and we can decide which are worth fixing.

@funkyboy
Copy link
Contributor Author

funkyboy commented Feb 1, 2018

@paddybyers Cool. Let's resume this when I finish #452

@funkyboy funkyboy added the enhancement New feature or improved functionality. label Feb 5, 2018
@funkyboy
Copy link
Contributor Author

As per call today with @paddybyers we'll document supported platforms in the README file.
In the case of js we'll list node versions (LTS + latest) and browsers.

@SimonWoolf
Copy link
Member

@funkyboy don't forget to update the engines field in package.json

@funkyboy funkyboy changed the title Document supported platforms Document supported platforms in the README file Feb 21, 2018
This was referenced Mar 5, 2018
@funkyboy
Copy link
Contributor Author

funkyboy commented Apr 5, 2018

Resolved in #498

@funkyboy funkyboy closed this as completed Apr 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or improved functionality.
Development

No branches or pull requests

3 participants