search

googlearchive / workbox-microsite

Workbox Microsite
Apache License 2.0
24 stars 13 forks source link

Sets up an examples collection #30

Closed jeffposnick closed 7 years ago

jeffposnick commented 7 years ago

R: @addyosmani @gauntface

This uses Jekyll's collections functionality to generate a list of all the examples we have, and tweaks the _examples/index.md page to make it a bit more presentable.

It also re-adds Examples to the navigation bar. Let me know if it's not in the right place.

The workbox-sw example is a placeholder to see how the list looked when there were multiple entries, and it will be populated with a real example in a future PR.

screen shot 2017-05-12 at 11 51 30 pm
addyosmani commented 7 years ago

Content here LGTM. With respect to where this shows up in the nav, I think this is fine for launch. Post I would say Reference should have submenus for API docs, examples etc.

jeffposnick commented 7 years ago

@addyosmani @gauntface

I've been working on the big workbox-sw example tonight, and realized that this branch handn't be merged yet. I've pushed out another commit with more sample code and if I could trouble for you some feedback on what's under _examples/workbox-sw that would be much appreciated. The code there isn't final and not ready to be merged, but it would be good to see if you have any major complaints about the general approach before I go much further.

jeffposnick commented 7 years ago

(You all might want to hold off on spending too much time reviewing the latest commits yet. There's a lot of late-night-commit-quality code in there that I will be cleaning up.)

addyosmani commented 7 years ago

(You all might want to hold off on spending too much time reviewing the latest commits yet. There's a lot of late-night-commit-quality code in there that I will be cleaning up.)

Started reading through the latest commits but will hold off until you feel its ready.

jeffposnick commented 7 years ago

I think I'm at a point where I've done most of what I can do in this PR, and may get more aggressive about merging as per @gauntface's push-it-out recommendations.

The sample SWs for both workbox-sw and workbox-routing are pretty extensively commented and touch on most of the functionality.

Here are some screenshots of how things are currently laid out:

screen shot 2017-05-14 at 9 33 47 pm screen shot 2017-05-14 at 9 33 58 pm screen shot 2017-05-14 at 9 41 08 pm
googlebot commented 7 years ago

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.