Add "Overview"

[kaycebasques]

Just a braindump of how I would conceptually explain WB's value to a potential user

[kaycebasques]

I also changed the tagline to JavaScript Libraries For Offline Web Apps for dramatic effect :)

[jeffposnick]

Thanks for working on this!

I haven't digested the full set of text yet, but re: the "JavaScript Libraries For Offline Web Apps" tagline—I don't want to give the impression that these libraries are only for "offline" use cases. Going cache-first even when a device is online leads to reliable, fast performance. "Offline-First" would be my preference over "Offline", or just keep it "Progressive".

[kaycebasques]

My big issue with "JS Libraries for PWAs" is that you look at the definition for PWA, and it has sections on being responsive, add to homescreen, serving over HTTPS, being indexed by Google, etc. Workbox has nothing to do with those, so it's way too broad to define it as a PWA library.

The bit about it making it sound like it's only for offline is a good point though. You may never expect users to go fully offline, maybe you're just caching app shell stuff for a faster UX

I do think that we should continue to really think about a tagline that captures the value of Workbox in a sentence. We can create something that creates much more meaning than "PWA"

[gauntface]

"JS Libraries that make service workers easy"? Ultimately I'd like workbox to contain a library or two for push in the near future.

[gauntface]

@kaycebasques thank you so much for this - it's awesome!!

I've added comments but they are all personal. Where do you think this should live on the microsite? I'm not sure it's a good idea to have a wall of text as the first thing developers see, but again that's personal preference and if you think it's a good idea then let's do it.

[kaycebasques]

Where do you think this should live on the microsite?

This was just a hack to get it displayed on the site, I'm not suggesting to add it to the homepage like this

Although, since users have said that they look at the homepage and have no idea what Workbox is about, it may be worthwhile to add some short (1-3 paragraph) overview on the homepage

[gauntface]

+1 to adding like a TL;DR of this for home page and linking up to somewhere for this. Let me know if you want any help figuring out a home for this.

[addyosmani]

Although, since users have said that they look at the homepage and have no idea what Workbox is about, it may be worthwhile to add some short (1-3 paragraph) overview on the homepage

This is awesome. I think it would be immensely valuable for us to add that shorter summary overview on the homepage and as Matt suggested linking up to a longer overview doc. Would you be up for taking a stab at that @kaycebasques? 🍪

[googlebot]

So there's good news and bad news.

:thumbsup: The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

:confused: The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

[kaycebasques]

Hey @jeffposnick @gauntface @addyosmani I iterated on the Overview and tried to get it all to a shippable state

[googlebot]

CLAs look good, thanks!

[gauntface]

For some reason the overview page doesn't build on prod builds, will dig into why soon

[kaycebasques]

@gauntface it's because I'm using a pretty URL in the nav... we can change it to overview.html or see if Jekyll has a flag that we can switch

[kaycebasques]

I'd prefer option 2 (enabling pretty URLs)

[addyosmani]

@kaycebasques reviewed. Very minor nits, but in general I love it ❤️

[googlebot]

So there's good news and bad news.

:thumbsup: The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

:confused: The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

[googlebot]

CLAs look good, thanks!

[kaycebasques]

@jeffposnick @gauntface plz leave comments in the markdown if you've got any feedback

[kaycebasques]

and @philipwalton

[jeffposnick]

Re: pretty URLs, let's keep them turned off and always include the .html extension in our links, as we ran into issues with our service worker caching when we had pretty URLs enabled in our Firebase config (see https://github.com/GoogleChrome/workbox-microsite/pull/67)

[kaycebasques]

@jeffposnick let me know if the updates are good enough to meet your feedback points

[jeffposnick]

I'm 👍

Thanks again for writing this up!

[kaycebasques]

Somebody want to give me write access so I can merge PRs (after reviews)?

[jeffposnick]

Looks like you've already got it, @kaycebasques (Someone else might have just added you?)

[kaycebasques]

@jeffposnick nope

[addyosmani]

@kaycebasques Just gave you admin privs. Could you refresh and check if that fixed it?

[kaycebasques]

We gooooood

[addyosmani]