V3 Microsite Plans

[gauntface]

@addyosmani @jeffposnick @philipwalton @deanhume @jescalan @prateekbh @kaycebasques

This is a bit of a brain dump of things we should do to the Workbox Microsite.

Move to WebFundamentals

• [x] Move build process for ref-docs to WebFundamentals (Started by @gauntface)
• [X] Move existing content over to WebFundamentals
• [x] Move demos to glitch and link up in WebFundamentals (Started by @jeffposnick)

Information Architecture

This is just an idea to try and organise things a little.

- Guides
    - Get Started
    - Compared to sw-<toolbox|precache>
    - How to Configure Workbox
    - How to Precache
    - How to Use Routing
    - How to Handle CORS
    - How to use Plugins
    - How to Enable Offline Analytics
    - Common Recipes for Workbox
    - How to Troubleshoot / Debug
    - How to Migrate from sw-<toolbox|precache>
    - How to Rollup Your Own Build
- Modules
    - Service Worker
        - Loader
        - Precaching
        - Routing
        - Google Analytics
        - Strategies
        - Background Sync
    - Plugins
        - Broadcast Cache Update
        - Cachable Response
        - Cache Expiration
    - Node
        - Build in Node
        - CLI
        - WebPack Plugin

Home Page

• [ ] Create a video for the home page covering high-level explanation and use of workbox.
• [ ] Highlight some of the common "How to Guides" from the new IA
  • [ ] Cache Google Fonts (Inlined in the home page or just linked to?)
  • [ ] Cache JS, CSS and Images (Inlined in the home page or just linked to?)
• [ ] Call out browser support
• [ ] Call out sites using Workbox
  • [ ] Forbes
  • [ ] Add a "Built by the team that worked on sw-toolbox and sw-precache, as used by Lyft, Washington Post.....(+ others)"
• [ ] Inline a demo running on Glitch
  • [ ] Could be a set of images with diff caching strategies.
  • [ ] Show off the broadcast cache update message
  • [ ] Show off service worker templating.
  • [ ] Get developer to change precache revision and show only that asset updates?

Reference Docs

• [ ] Build out reference docs as Markdown files rather than a file with YAML with HTML as content (Should encourage contributions).
• [ ] Build Reference Docs into a location that means a module can have normal markdown content next to the actual reference docs.
• [ ] Optional Add ability to select a specific version of the docs from available versions.

Footer

This is some stuff we should call out a little better.

- Community
    - Stack Overflow
    - Slack
    - Contributing
- More
    - Blog
    - Github
    - Demos and Examples

[jescalan]

The most shameless of plugs, but you'd probably see a large benefit by switching from jekyll to spike 😉 Would be happy to help with this if anyone is interested.

[gauntface]

Runtime recipe ideas from Addy. https://gist.github.com/addyosmani/0e1cfeeccad94edc2f0985a15adefe54

[deanhume]

This is great! If I can help in any way with the build of this please let me know - happy to jump on anything!

[gauntface]

Any other opinions for changing static site generator?

I'm pretty much hating Jekyll at this point, largely because of Ruby, but personally not a fan of Spike just because of the Webpack requirement (but that's super peronsal preference).

Anyone have experience with Hexo?

[gauntface]

• How to cache additional CDN files
• How to cache files uploaded to CDN
• How to precache runtime files

[gauntface]

Add Search

[jescalan]

@gauntface Woah, I haven't yet heard anyone not be ok with webpack. I'm genuinely curious to hear your reasoning for this, in my experience webpack has been pretty universally appreciated.

[gauntface]

@jescalan I may have come off a bit strong being anti-webpack. My main reluctance is the notion of pulling CSS and HTML into the dependency graph to then add steps to pull it out of the dependency graph.

It's a personal thing and not me saying Webpack is bad or shouldn't be used.

[jescalan]

@gauntface Isn't this what you'd have to do if you wanted to process html & css in any way? Add the files to some process that transforms them, then once the transform is done, write them out.

[gauntface]

@jescalan Like I said, it's a personal preference.