PWA 2022

[rviscomi]

PWA 2022

If you're interested in contributing to the PWA chapter of the 2022 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
@diekus	@diekus @Suzzicks	@aarongustafson @webmaxru @Schweinepriester @tropicadri @beth-panx @tropicadri	@beth-panx	@siwinlo	@foxdavidj

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 1: The content team has at least one author, reviewer, and analyst

1. Plan content

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

2. Gather data

• June 1: Analysts have added all necessary custom metrics and drafted a PR (example) to track query progress

• June 1 - 15: HTTP Archive runs the June crawl

3. Validate results

• August 1: Analysts have queried all metrics and saved the output to the results sheet

4. Draft content

• September 1: The content team has written, reviewed, and edited the chapter in the doc

5. Publication

• September 15: The completed chapter and all required metadata and figures are converted to markdown and submitted to GitHub

• September 26: Target launch date 🚀

Chapter resources

Refer to these 2022 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
💬 #web-almanac-pwa on Slack for team coordination

[Suzzicks]

I can help if you want me to Lead or Author this topic.

[webmaxru]

Hello!
My pleasure to be a Reviewer for this year again!

[Schweinepriester]

Hello everyone! 👋
Same as @webmaxru, I'm happy to be a reviewer again :)

[siwinlo]

hello! I'd be happy to join as an editor!

[foxdavidj]

@webmaxru @Schweinepriester @siwinlo

Hi all, we need your help. We currently don't have a Lead for this chapter, which means we'll likely miss our first milestone (May 1st) which will put the chapter at risk of being dropped.

Can you all reach out to anyone you feel may be a good fit for a Lead/Authoring role for the chapter?

Thanks so much for your interest in helping us assemble the chapter this year

[Schweinepriester]

Maybe @Suzzicks wants to step up and be Lead? :)

I had typed the following before I realized @Suzzicks said "Lead or Author", preserving just in case 0:-)

 Perhaps last years great lead @demianrenzulli, last years capabilities lead and PWA enthusiast @christianliebel and/or fugu🐡 aficionado/champion @tomayac? :)

[foxdavidj]

Thanks for the suggestions @Schweinepriester.

@christianliebel @demianrenzulli @tomayac Would any of you be interested in the Chapter Lead role for the PWA chapter?

Regarding @Suzzicks, we unfortunately we haven't been able to get a hold of her

[tomayac]

@tropicadri is fully focused on PWA on Google's side, maybe she's interested? I will help out with the Capabilities chapter already and can't commit to more at the moment.

[foxdavidj]

@tropicadri Would you be interested in being an author for this years PWA chapter in the Web Almanac?

[tropicadri]

As much as I would want to, I don't have the bandwidth to lead. I can help but I can't be the main point of contact.

[webmaxru]

Let me chat with PWA v-team of Microsoft about someone leading that

[rviscomi]

⚠️ @Suzzicks @webmaxru @Schweinepriester @tropicadri @siwinlo it looks like this chapter still doesn't have a lead or an analyst and the outline hasn't been started yet. We might have to drop this chapter if it doesn't seem like there's enough interest to sustain it.

Could you help us find contributors who can staff this chapter? Meanwhile, it'd be great to start brainstorming ideas in the doc and when we get the team fully formed we can hopefully get back on track quickly.

@webmaxru is anyone at Microsoft interested in contributing?

[tropicadri]

@Snugug would you have any interest in leading this chapter for the web almanac?

[webmaxru]

@webmaxru is anyone at Microsoft interested in contributing?
I'm on it - will keep you posted asap, let's wait with the decision on dropping this chapter for a few more days please.

Meanwhile, I requested an access to the working doc - ready to be an interim Lead to create doc structure and start adding some ideas.

[aarongustafson]

I’m happy to contribute however it would be helpful.

[webmaxru]

@aarongustafson Awesome! Could you then volunteer as a content team lead?

[aarongustafson]

@webmaxru If need be. If there are others who want to lead—particularly smart folks whose perspectives we don’t often hear—I’m open to working in a supporting capacity, but if there are still no takers and we’re down to the wire, I’m happy to step up.

[Snugug]

@Snugug would you have any interest in leading this chapter for the web almanac?

Thanks for offering! I unfortunately don't think I've got capacity to lead this right now. I also echo what @aarongustafson has said that it'd be great to get perspective from folks we don't often hear.

[aarongustafson]

Maybe @diekus or @beth-panx would be interested?

[beth-panx]

@aarongustafson - Since I haven't been involved in this before, I am happy to be your reviewer/analyst and contribute wherever I can this year.

[foxdavidj]

Hey @aarongustafson would you be willing to step up as the Content lead for the chapter? If so we'd love to have you!

[diekus]

Yes, reviewed the data. I'll sync up with Cindy to proceed with writing

[foxdavidj]

@diekus @Suzzicks How's the chapter coming along?

[foxdavidj]

Hi @diekus hope you're doing well. Looks like there isnt any activity in the Google Doc and the writing deadline is fast approaching.

Is this something you'll be able to commit to writing in the next couple of weeks? Because, sadly, right now this chapter is at risk of being closed so that we can focus our effort on the other chapters.

[diekus]

Hi David. You'll have an update on the text this week. Sorry for the delay

[rviscomi]

⛔ Hi everyone. Given that we're now beyond the deadline to have the draft written, reviewed, and edited but the draft has still not been started, unfortunately I think we're going to have to close the chapter. It's not looking like it'll be feasible to get the chapter back on track to be able to launch on time. Apologies to everyone who committed their time up to this point, and thanks for your understanding.

[diekus]

Hi @rviscomi , I understand that the writing is meant to be done in September, which we are still in the first week. I started writing the chapter in a word doc, and there is still some time before the 15th to get this done. Do you think there is a window here? I have the manifest bits written and can continue with the SW stuff.

[rviscomi]

Hi @diekus. To clarify the timeline, the chapter was expected to be fully written, reviewed, and edited in the shared doc by September 1.

The September 15 milestone to have the final draft submitted to GitHub in markdown is in 7 days. It's going to be very hard to catch up with the draft being written in private doc, so if you're still committed to landing the chapter, I'd suggest moving it into the shared doc and coordinating with the rest of your team on a plan ASAP. However, if that doesn't sound feasible without compromising on quality, then I do think closing the chapter is the best option.

[diekus]

hola @rviscomi. I have a revised chapter in markdown with all chart macros ready and published here. I have some questions, that you might be able to help me with.

• where should I upload the images needed for each figure?
• how can I format the stat numbers so they can show in the big bold lettering? Is this a specific guide? I have several numbers that I want to highlight this way but I do not know how to do so.
• is there anything that I am missing?

[tunetheweb]

• where should I upload the images needed for each figure?

See the Figures Guide.

There's a script to do this (npm run figure-images en/2022/pwa) which will generate them for you automatically!

Also handy to run locally (using npm run start after running the following:

• cd src
• npm install
• pip install -U requirements.txt
• npm run start
• Navigate to http://127.0.0.1:8080

• how can I format the stat numbers so they can show in the big bold lettering? Is this a specific guide? I have several numbers that I want to highlight this way but I do not know how to do so.

Detailed here.

• is there anything that I am missing?

Has anyone else reviewed this content? Normally we do that in the Google Doc as easier to review and accept changes.

[tomayac]

(Just a side remark: thanks for still making this chapter happen <3!)

[diekus]

@tunetheweb it has been reviewed by @aarongustafson and @tropicadri . I am making the last changes and then will be ready to commit the chapter later today with the macros for images ready.

[webmaxru]

I also completed reviewing this article. Great job, @diekus!

[Schweinepriester]

Same, good job indeed!

[diekus]

Thanks to the reviewers and editors. I have one more question @tunetheweb, how can I find out which is the name of the sql script and the google tab id for the figures?

[tunetheweb]

The sheets id is the one in the URL when viewing that data.

There should be one tab in the sheet for each of these SQL files: https://github.com/HTTPArchive/almanac.httparchive.org/tree/main/sql/2022/pwa

[diekus]

You're a life saver @tunetheweb! Thank you very much. I have added the sheets_gid and the sql to the charts and figures in the PWA chapter.

I believe this should be completed, and if there is anything else I need to do let me know, happy to get the PWA over the finishing line.

Apologies for the delays! 😳