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 prerequisites #130

Closed
jampy opened this issue Nov 10, 2016 · 3 comments
Closed

document prerequisites #130

jampy opened this issue Nov 10, 2016 · 3 comments
Labels

Comments

@jampy
Copy link

jampy commented Nov 10, 2016

As discussed in #127, please document all prerequisites necessary to make this plugin work properly.

For example, I learned that it's important that "sw.js" is served with headers that disallow caching. A simple note on which headers would be appropriate would be important.

Likewise, if there are other pitfalls, these should be documented as well.

@NekR
Copy link
Owner

NekR commented Nov 11, 2016

Thank you, I'll add it.

@NekR NekR added the docs label Apr 5, 2017
@GGAlanSmithee
Copy link
Collaborator

@jampy we now have the troubleshooting docs. It's not exaclt what you suggested, but should cover the case you points out and more.

Do you (adnd @NekR) feel there is a need for another separate doc regarding this, or would it just fragment the docs more?

@NekR
Copy link
Owner

NekR commented Sep 22, 2017

@GGAlanSmithee good point! I don't think there is a need for another doc file. If someone else has suggestions about prerequisites we can add them as "make sure" or something like that section to the troubleshooting doc.

@NekR NekR closed this as completed Sep 22, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants