Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PWA 2021 #2153

Closed
6 tasks done
rviscomi opened this issue Apr 27, 2021 · 116 comments · Fixed by #2437
Closed
6 tasks done

PWA 2021 #2153

rviscomi opened this issue Apr 27, 2021 · 116 comments · Fixed by #2437
Assignees
@demianrenzulli
Labels
2021 chapter Tracking issue for a 2021 chapter
Milestone
2021 Content Writing

Comments

@rviscomi
Copy link
Member

rviscomi commented Apr 27, 2021 •
edited
Loading

Part II Chapter 15: PWA

PWA illustration

If you're interested in contributing to the PWA chapter of the 2021 Web Almanac, please reply to this issue and indicate which role or roles best fit your interest and availability: author, reviewer, analyst, and/or editor.

Content team

Lead Authors Reviewers Analysts Editors Coordinator
@demianrenzulli @demianrenzulli @webmaxru @Schweinepriester @thepassle @hemanth @tropicadri @andreban @jeffposnick @tunetheweb @demianrenzulli @rviscomi @OBTo
Expand for more information about each role
  • The content team lead is the chapter owner and responsible for setting the scope of the chapter and managing contributors' day-to-day progress.
  • Authors are subject matter experts and lead the content direction for each chapter. Chapters typically have one or two authors. Authors are responsible for planning the outline of the chapter, analyzing stats and trends, and writing the annual report.
  • Reviewers are also subject matter experts and assist authors with technical reviews during the planning, analyzing, and writing phases.
  • Analysts are responsible for researching the stats and trends used throughout the Almanac. Analysts work closely with authors and reviewers during the planning phase to give direction on the types of stats that are possible from the dataset, and during the analyzing/writing phases to ensure that the stats are used correctly.
  • Editors are technical writers who have a penchant for both technical and non-technical content correctness. Editors have a mastery of the English language and work closely with authors to help wordsmith content and ensure that everything fits together as a cohesive unit.
  • The section coordinator is the overall owner for all chapters within a section like "User Experience" or "Page Content" and helps to keep each chapter on schedule.

Note: The time commitment for each role varies by the chapter's scope and complexity as well as the number of contributors.

For an overview of how the roles work together at each phase of the project, see the Chapter Lifecycle doc.

Milestone checklist

0. Form the content team

  • May 31: The content team has at least one author, reviewer, and analyst

1. Plan content

  • June 15 The content team has completed the chapter outline in the draft doc

2. Gather data

  • June 30: Analysts have added all necessary custom metrics and drafted a PR (example) to track query progress
  • July 1 - 31: HTTP Archive runs the July crawl

3. Validate results

  • September 30: Analysts have queried all metrics and saved the output to the results sheet

4. Draft content

  • October 31: The content team has written, reviewed, and edited the chapter in the doc

5. Publication

  • November 15: The completed chapter and all required metadata and figures are converted to markdown and submitted to GitHub
  • December 1: Target launch date 🚀

Chapter resources

Refer to these 2021 PWA resources throughout the content creation process:

📄 Google Docs for outlining and drafting content
🔍 SQL files for committing the queries used during analysis
📊 Google Sheets for saving the results of queries
📝 Markdown file for publishing content and managing public metadata
@rviscomi rviscomi added 2021 chapter Tracking issue for a 2021 chapter help wanted Extra attention is needed labels Apr 27, 2021
@rviscomi rviscomi mentioned this issue Apr 27, 2021
Closed
@webmaxru
Copy link

It's my pleasure to support PWA chapter as a reviewer!

@rviscomi
Copy link
Member Author

Welcome @webmaxru!

@Schweinepriester
Copy link
Member

If I may, I'd support PWA as a reviewer as well :)

@demianrenzulli
Copy link
Contributor

I can work as an author in this one!

cc // @andreban @petele @b1tr0t

@github-actions github-actions bot mentioned this issue Apr 30, 2021
Closed
@rviscomi
Copy link
Member Author

rviscomi commented May 4, 2021

@demianrenzulli thanks for your interest in authoring this chapter! As the content team lead, you'll be responsible for the scope and direction of the chapter and keeping it on schedule. We automatically monitor the staffing and progress of each chapter based on the state of the initial comment so please keep that updated as you add new contributors and meet each milestone.

We've created a Google Doc for this chapter, which you're encouraged to use to collaborate with the content team on the initial outline, metrics, and ultimately the final draft.

Next steps for this chapter are:

@OBTo will be the section coordinator for this chapter, so they'll be periodically checking in with you directly to make sure the chapter is staying on schedule. Reach out to them here in this issue if you have any questions about the process.

More information about the content team lead and author roles and responsibilities are available for reference in the wiki if needed.

To anyone else interested in contributing to this chapter, please comment below to join the team!

@rviscomi rviscomi added the help wanted: analysts This chapter is looking for data analysts label May 4, 2021
@rviscomi
Copy link
Member Author

rviscomi commented May 5, 2021 •
edited by tunetheweb
Loading

📟 paging 2019/2020 contributors: @tomayac @jeffposnick @logicalphase @ahmadawais @jrharalson @hemanth @thepassle @jadjoubran @pearlbea @gokulkrishh @jaisanth @tunetheweb

Would any of you be interested to contribute to the 2021 chapter? This chapter could use your help with reviewing and/or analyzing. It'd be great to have your support!

@thepassle
Copy link

Yeah I'd be happy to help out as reviewer where possible :)

@hemanth
Copy link
Contributor

hemanth commented May 5, 2021

Count me in for reviews, thank you!

@demianrenzulli
Copy link
Contributor

demianrenzulli commented May 11, 2021 •
edited by tunetheweb
Loading

Thanks for your interest folks!

It seems like @tunetheweb acted as analyst for the 2020 section.

Hi Barry! Nice to meet you. You're more than welcome to collaborate on that role once again, but if you can't make it this year, and we don't find another contributor willing to work as analyst, I would be happy to take that role as well.
In that case, maybe we can touch base separately, so you can share some insights on your experience with the 2020 PWA section?

We might be able to reuse several of the 2020 queries, plus other ideas we have in mind.

@demianrenzulli
Copy link
Contributor

For the rest of the reviewers: it's the first time I contribute, so I'm not sure how you interacted in the past, but I'll touch base with Rick and other contributors to see how we can get organized for this year's PWA section 👍👍👍

@tunetheweb
Copy link
Member

tunetheweb commented May 11, 2021 •
edited
Loading

Hey @demianrenzulli , I'm one of the leads her for the Web Almanac project. I stepped in as the analyst last year as we were short, but wouldn't say PWAs are my area of expertise so would be great if someone else could take the mantle here. But definitely more than happy to help guide them and help out where I can.

A lot of the queries was based on @tomayac 's work from 2019, and in particular this blog post of his that he used as the basis of that first year's chapter. See also #1258 (comment) for more info on regenerating that data for last year (we'll help get that data for you again assuming you want it). Not sure if you wanna chip in here @tomayac ? Though know you are involved in Capabilities chapter too.

I'll touch base with Rick and other contributors to see how we can get organized for this year's PWA section

Best thing is for all authors to open the draft word doc, request edit permission, and then start listing ideas of what metrics or sections you'd like to keep from 2019 and 2020, and what you'd like to introduce. Start to get a chapter outline based on that and comment and suggest things. The more ideas the better at the beginning, and then can see which ones are realistic and whittle it down. The earlier you start this, the less pressure you'll feel later :-)

And btw you can get links to the results sheets (and the queries) from 2019 and 2020 at the bottom of the chapters to see what data those authors had to play with, to help with that:

@tomayac
Copy link
Member

tomayac commented May 11, 2021

A lot of the queries was based on @tomayac 's work from 2019, and in particular this blog post of his that he used as the based of that first year's chapter. See also #1258 (comment) for more info on regenerating that data for last year (we'll help get that data for you again assuming you want it). Not sure if you wanna chip in here @tomayac ? Though know you are involved in Capabilities chapter too.

I've signed up for capabilities and am reluctant to overcommit. More than happy to answer ad-hoc questions you may have, though.

@demianrenzulli
Copy link
Contributor

demianrenzulli commented May 11, 2021 •
edited by tunetheweb
Loading

Thanks a lot @tunetheweb!! If, based on previous experiences you think it's "doable" for someone to be both the author and analyst, I would be happy to collaborate on both sides.

As mentioned, this is my first time contributing, so yours, @tomayac and other folk's guidance, would be highly appreciated.

There are a bunch of resources here that I need to process before moving to the next step.

I'll keep this issue updated.
If anyone has any thoughts to share, please, let me know!

@rviscomi rviscomi mentioned this issue May 11, 2021
Merged
@rviscomi
Copy link
Member Author

It's definitely doable to be an author and analyst, you wouldn't be the first. Each role peaks in activity at different times during the project, so it should be manageable for a single person assuming you can set aside a few hours each week.

@foxdavidj
Copy link
Contributor

Hey @demianrenzulli excited to work with you and the rest of the group this year on the Almanac. I'm your go to guy if you've got any questions or need help so don't hesitate to reach out to me on github, the Slack (@OBTo) or email ([email protected]).

Few first steps:

  1. All authors, reviewers and analysts should add themselves to the Google Doc in the format: Name ([email protected]). But looks like you've already got a good handle on that.
  2. I've added links within the doc to the previous years Google doc in case you'd like to mine it for ideas.
  3. Would love to set up a 30 minute Zoom call in the next couple weeks to kick-start the chapter planning and brainstorming process, and put some faces to the names of the people we'll all be working with this year. I'll reach out again later this week to find a time that works.

Excited to work with you all this year.

@demianrenzulli
Copy link
Contributor

This is great @OBTo! Nice to meet you too.

My apologies for the delayed response, but we had a couple of things for I/O week, and some articles I've been working on for Web.dev.

I'm planning to start working on this by tomorrow. I'll make sure to also touch base with the rest of the collaborators.

We had some internal conversations already, and would be great to hear thoughts from the rest of the folks in this group.

I hope we can create a great PWA chapter this year!

@thepassle
Copy link

All authors, reviewers and analysts should add themselves to the Google Doc in the format: Name ([email protected]). But looks like you've already got a good handle on that.

Looks like I need some rights to be able to add myself there, I've requested them in the doc.

@foxdavidj
Copy link
Contributor

How does Tuesday (May 25) 11a ET / 8a PT / 4p BST work for that 30m chat? Timezones here: https://www.timeanddate.com/worldclock/meetingdetails.html?year=2021&month=5&day=25&hour=15&min=0&sec=0&p1=64&p2=179&p3=224&p4=136&p5=37&iv=1800

@demianrenzulli @webmaxru @Schweinepriester @thepassle @hemanth

@logicalphase
Copy link
Contributor

logicalphase commented May 19, 2021 via email

@demianrenzulli
Copy link
Contributor

That time: next Tuesday 11ET, works for me! Thanks for organizing this @OBTo!

@webmaxru
Copy link

Works fine for me!

@demianrenzulli
Copy link
Contributor

That's awesome! Thanks so much @alexburleh. I'll add that chart to the article doc, along with the reference to your analysis👍

@rviscomi
Copy link
Member Author

rviscomi commented Oct 5, 2021

@alexburleh any chance you could share the chart data in CSV format so we could run it through our data viz process for visual consistency with other charts?

@demianrenzulli @tunetheweb we should be sure to annotate the chart with Source: Mobsted PWA 2021 report in the subtitle.

@tunetheweb
Copy link
Member

Any chance we could get the raw data instead of the chart @alexburleh ? That way we can use our own chart style (appreciate you got it very close, but still slightly different and those stylist highlights might look odd).

And also means we can make it interactive on desktop like the other charts (not that interactive to be fair - just hover effects, but still!)

Also FYI, in your report you have a typo in the header:

image

@tunetheweb
Copy link
Member

Ah we gotta stop doing this @rviscomi !!!

@alexburleh
Copy link

@rviscomi @tunetheweb Gentlemen, 1) attached is the CSV for the above diagram 2) Barry, thanks for the typo, will fix that :)
PWA agregbyindustry.csv

@tunetheweb
Copy link
Member

Thanks @alexburleh - what's the total number to convert to %?

@alexburleh
Copy link

alexburleh commented Oct 5, 2021 via email •
edited
Loading

@tunetheweb
Copy link
Member

Ah comma delimited - you crazy Continental Europeans 😁

@alexburleh
Copy link

alexburleh commented Oct 5, 2021 via email

@tunetheweb
Copy link
Member

Added to sheet: https://docs.google.com/spreadsheets/d/16AkIdDBBkCR5Kgb7kyfYvnNLQBu23Vsh7MUSFHW9RtA/edit#gid=1817367668

What do you all think of this as a visualisation?:

Bar chart of PWA Categories

@demianrenzulli
Copy link
Contributor

This looks very aligned to the way the rest of the charts look like. Thanks a lot for working on this @tunetheweb!

@alexburleh
Copy link

alexburleh commented Oct 5, 2021 via email

@tunetheweb
Copy link
Member

Oops, conversion error. Take 2:

image

@alexburleh
Copy link

Oops, conversion error. Take 2:

image

Good. My only suggestion would be to color top 3 or 5 categories with one color and the rest with other. Could be easier to view.

@tunetheweb
Copy link
Member

Good. My only suggestion would be to color top 3 or 5 categories with one color and the rest with other. Could be easier to view.

Sorry that's not really the style we use so would prefer to be consistent here rather than introduce new themes. @demianrenzulli can could out particular stats in the writing if he wants.

@alexburleh
Copy link

alexburleh commented Oct 5, 2021 via email

@webmaxru
Copy link

webmaxru commented Oct 7, 2021

Hi @davrous!
We really need any public proof of the data you shared on behalf of PWA Builder to include it into the report. Just an idea: could it be a twitter thread? Simple and unobtrusive way to share some findings with the community. Only crucial point is timing - we finalize the report soon so it would be cool to have this tweet/thread in 1-2 days. Is it possible?

@demianrenzulli
Copy link
Contributor

Many thanks to all for taking a look at the doc and leaving comments.
@rviscomi: we have been making some final changes with @tunetheweb and the draft should be ready for the editorial review now. Looking forward to any comments and suggestions you might have!

@alexburleh
Copy link

alexburleh commented Oct 13, 2021 via email

@rviscomi rviscomi mentioned this issue Oct 21, 2021
Merged
@webmaxru
Copy link

@rviscomi @demianrenzulli @davrous : here is a tweet from PWA Builder to confirm stats from their side: https://twitter.com/pwabuilder/status/1454250060326318082?s=21

@demianrenzulli demianrenzulli mentioned this issue Nov 4, 2021
Merged
@tunetheweb
Copy link
Member

The PWA 2021 chapter is completed and has been merged!

Well done all involved - especially @demianrenzulli for holding the ship together.

The first 2021 chapter merged! 🎉 Quite an achievement. Can't wait until it's launched.

@demianrenzulli @webmaxru @Schweinepriester @thepassle @hemanth @tropicadri @andreban @jeffposnick @tunetheweb @rviscomi @OBTo

@demianrenzulli
Copy link
Contributor

Hi folks!

Thanks again for collaborating in this year's PWA chapter!!

The chapter has already been released: https://almanac.httparchive.org/en/2021/pwa

Please, feel free to share or retweet the HTTP Archive announcement: https://twitter.com/HTTPArchive/status/1461029997804720131

cc // @webmaxru @Schweinepriester @thepassle @hemanth @tropicadri @andreban @jeffposnick

@webmaxru
Copy link

Thanks for leading the project, @demianrenzulli!
Please, keep me in mind for the next year's PWA chapter!

@demianrenzulli
Copy link
Contributor

Sure thing! Thank you @webmaxru and thanks for the great insights everyone, it was great working with you, and once again many thanks to @tunetheweb for his contributions, support (and patience)!!

@rviscomi has shared this interest form so you can sign up and be contacted when the 2022 chapter starts.

@rviscomi
Copy link
Member Author

@demianrenzulli @webmaxru @Schweinepriester @thepassle @hemanth @tropicadri @andreban @jeffposnick @tunetheweb

Thank you all for your hard work getting this chapter over the finish line in time for the pre-release—the PWA chapter has been the most-read chapter in the past few weeks, English and Russian translation combined! Congratulations on finishing the chapter, and I'm excited to see us launch the rest of the chapters along side it on Wednesday 🎉

When you get 5 minutes, I'd really appreciate if you could fill out our contributor survey to tell us (the project leads) about your experience. It's super helpful to hear what went well or what could be improved for next time. 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@demianrenzulli demianrenzulli

Labels
2021 chapter Tracking issue for a 2021 chapter
Projects
None yet
Milestone
2021 Content Writing
Development

Successfully merging a pull request may close this issue.

PWA 2021 chapter demianrenzulli/almanac.httparchive.org