search

HTTPArchive / almanac.httparchive.org

HTTP Archive's annual "State of the Web" report made by the web community
https://almanac.httparchive.org
Apache License 2.0
611 stars 169 forks source link

PWA 2022 #2895

Closed rviscomi closed 2 years ago

rviscomi commented 2 years ago

PWA 2022

PWA illustration

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](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Content-Team-Leads'-Guide)** is the chapter owner and responsible for setting the scope of the chapter and managing contributors' day-to-day progress. - **[Authors](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Authors'-Guide)** 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](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Reviewers'-Guide)** are also subject matter experts and assist authors with technical reviews during the planning, analyzing, and writing phases. - **[Analysts](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Analysts'-Guide)** 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](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Editors'-Guide)** 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](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Section-Leads'-Guide)** 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](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Chapter-Lifecycle) doc.

Milestone checklist

0. Form the content team

1. Plan content

2. Gather data

3. Validate results

4. Draft content

5. Publication

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

diekus commented 2 years ago

I've synced with Beth on the queries, the only one that I am not sure how to get is support for Web Share API, since this is a JS API and not easily to find out if a PWA is invoking navigator.share. Any ideas on how to find out this area welcome!

diekus commented 2 years ago

@beth-panx let's add also queries for

tomayac commented 2 years ago

The Capabilities chapter has traditionally covered some of these APIs: https://almanac.httparchive.org/en/2021/capabilities.

diekus commented 2 years ago

Indeed! We checked this when we were developing the chapter, but we wanted to make a mention of the data when intersecting with PWAs. This is, from all web apps using such APIs, which are actual PWAs? It'd be interesting to note that x% of websites using web share api are installable web apps, for example.

beth-panx commented 2 years ago

Hi all - Most of the queries are done, validated, and translated into graph and added to the result sheet. Please feel free to review. 🚀

beth-panx commented 2 years ago

Queries were reviewed and merged thanks to @tunetheweb! I have updated the result sheet based on the new queries. 🧠

foxdavidj commented 2 years ago

Fantastic work!! Thanks so much

foxdavidj commented 2 years ago

The queries have been run and saved in the results sheet @diekus @Suzzicks. Writing the chapter is fully green-lit

foxdavidj commented 2 years ago

@diekus @Suzzicks Have you been able to review the data from the analysts?

diekus commented 2 years ago

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

foxdavidj commented 2 years ago

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

foxdavidj commented 2 years ago

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 commented 2 years ago

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

rviscomi commented 2 years ago

⛔ 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 commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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.

tunetheweb commented 2 years ago
  • 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:

  • 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 commented 2 years ago

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

diekus commented 2 years ago

@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 commented 2 years ago

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

Schweinepriester commented 2 years ago

Same, good job indeed!

diekus commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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! 😳