Skip to content
This repository has been archived by the owner on Aug 10, 2022. It is now read-only.

Update Workbox "Using Plugins" documentation #9017

Merged
merged 2 commits into from
Nov 30, 2020

Conversation

housseindjirdeh
Copy link
Member

@housseindjirdeh housseindjirdeh commented Sep 22, 2020

What's changed, or what was fixed?

  • Updates the "Using Plugins" documentation for Workbox to include new plugin capabilities:
    • Lifecycle state
    • New lifecycle callbacks

Target Live Date: TBD

  • This has been reviewed and approved by (NAME)
  • I have run npm test locally and all tests pass.
  • I have added the appropriate type-something label.
  • I've staged the site and manually verified that my content displays correctly.

CC: @jeffposnick @philipwalton

@google-cla google-cla bot added the cla: yes label Sep 22, 2020
@housseindjirdeh housseindjirdeh changed the title Update Workbox "Update Plugins" documentation Update Workbox "Using Plugins" documentation Sep 23, 2020
@google google deleted a comment from leyoj5 Sep 24, 2020
@google google deleted a comment from leyoj5 Sep 24, 2020
Copy link
Contributor

@jeffposnick jeffposnick 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 doing this!

As with the other content that targets Workbox v6, we're going to hold off on merging until we've released v6.0.0.

plugin did (e.g. compute the time delta between running `requestWillFetch()` and `fetchDidSucceed()`
or `fetchDidFail()`).

## Lifecycle Callbacks
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think there's a meaningful distinction between these "lifecycle callbacks" and the other group of existing callbacks. All of the callbacks in this section are new for v6 and are tied to the handler* lifecycle, but conceptually, they're very similar to the existing callbacks and should probably be listed alongside them.

Would you mind rearranging things so that these aren't broken out into their own section? You can add in something like "The lifecycle callbacks starting with handler are all new in Workbox v6." to make it clear what the support story is.

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated, and added a note mentioning how handler callbacks are new in v6 :)

@WebFundBot
Copy link

Whoops!

There were 4 warnings that will prevent this PR from being merged. Please take a look, and either fix, or provide a justification for why they can't be fixed.

WARNINGS
src/content/en/tools/workbox/guides/using-plugins.md#L221 - Consider adding a "was this page helpful?" widget to your page: https://developers.google.com/web/resources/widgets#helpful
src/content/en/tools/workbox/guides/using-plugins.md#L47 - Common typo found: 'javascript' Should it be 'JavaScript'?
src/content/en/tools/workbox/guides/using-plugins.md#L124 - Common typo found: 'javascript' Should it be 'JavaScript'?
src/content/en/tools/workbox/guides/using-plugins.md#L111 - Common typo found: 'ServiceWorker' Should it be 'service worker'? Capitalize Service if it's the first word in the sentence.

@petele
Copy link
Member

petele commented Oct 6, 2020

@jeffposnick - can you take a peek and LGTM/merge?

@jeffposnick jeffposnick merged commit 97c842e into master Nov 30, 2020
@jeffposnick jeffposnick deleted the update-plugins-documentation branch November 30, 2020 21:12
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants