docs(gatsby-plugin-offline): Show how to handle a SW update #10417
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DSchau
reviewed
Dec 11, 2018
| @@ -206,6 +206,10 @@ exports.onServiceWorkerInstalled = true | |||
| * Inform plugins of when a service worker has an update available. | |||
| * @param {object} $0 | |||
| * @param {object} $0.serviceWorker The service worker instance. | |||
| * @example | |||
| * exports.onServiceWorkerUpdateFound = () => { | |||
| * window.alert(`An updated service worker was found.`) | |||
There was a problem hiding this comment.
We generally want to keep these examples relatively useful (e.g. users will probably directly copy and paste this).
Is this the best example we could show? I'm almost inclined to suggest reverting it back to the way it was, but minimally I think perhaps a prompt like you've shown earlier is more effective?
DSchau
reviewed
Dec 11, 2018
Co-Authored-By: davidbailey00 <4248177+davidbailey00@users.noreply.github.com>
DSchau
approved these changes
Dec 11, 2018
|
@davidbailey00 looks great! Thanks for noticing the redundancy too; I thought I had fixed that and clearly hadn't! Awesome! |
gpetrioli
pushed a commit
to gpetrioli/gatsby
that referenced
this pull request
Jan 22, 2019
…#10417) Closes gatsbyjs#9087 I also deleted `/docs/add-offline-support/` since it just redirects to `/docs/add-offline-support-with-a-service-worker/` anyway, and hasn't been updated in a while.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #9087
I also deleted
/docs/add-offline-support/since it just redirects to/docs/add-offline-support-with-a-service-worker/anyway, and hasn't been updated in a while.