Caching 2021

[rviscomi]

Part IV Chapter 23: Caching

If you're interested in contributing to the Caching 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
@Zizzamia	@Zizzamia	@jessnicolet @WilhelmWillie @roryhewitt @boosef	@rviscomi	-	@rviscomi

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 Caching 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

[roryhewitt]

More than willing to be the author again.

[rviscomi]

Thanks @roryhewitt! I'll tentatively put you down as a peer reviewer to let someone else author if interested (see #2165 for context).

[boosef]

Happy to review and/or edit!

[roryhewitt]

Peer reviewer it is! As long as we have a cat pic, I'm fine... :)

[rviscomi]

📟 paging 2019/2020 contributors: @paulcalvano @yoavweiss @colinbendell @OBTo @csswizardry @jzyang @jaisanth @Soham-S-Sarkar @raghuramakrishnan71

Would any of you be interested to contribute to the 2021 chapter? I'd especially like to see more 2019/2020 authors become 2021 reviewers to help ease the transition and similarly I think prior reviewers would make great 2021 authors, being familiar with the process already. And prior analysts would make excellent 2021 analysts 😁

Or is there anyone new you'd like to see?

[Zizzamia]

@rviscomi Happy to take this one as Lead Author for 2021 🔥

[rviscomi]

@Zizzamia 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:

• Due May 31: Complete Milestone 0: Form the content team by finding contributors to help with the analysis
• Due June 15: Get started on Milestone 1: Plan content by brainstorming some content ideas in the doc (you may need to request edit access)

There's not currently a section coordinator for this chapter, so I'll be periodically checking in with you directly to make sure the chapter is staying on schedule. Reach out 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!

[Zizzamia]

Niiiice! This is going to be fun! 🌲 🚀 🌕

[Zizzamia]

Alright, to have @jessnicolet and @WilhelmWillie as reviewers. Anyone interested to join as Analysts?

[roryhewitt]

@Zizzamia feel free to do a complete rewrite. You don't even need to keep the picture of my cat (as long as you include a picture of a cat :)

[Zizzamia]

LOL @roryhewitt, what if I don't like cats?!? 😆
But yeah, I usually do a full rewrite, and I use the old version as point of reference in what topic were covered so we can do a nice 2019 vs 2020 vs 2021 data comparison. Looking forward to hear your feedbacks in the coming months as the chapter shapes out.

[rviscomi]

Hi @Zizzamia just checking in. Here are some tips to help keep the chapter on track:

• Coordinate with the rest of the content team to request edit access to the doc and start brainstorming an outline for the chapter
• Consider announcing to your professional networks that you're looking for co-contributors knowledgable in caching to join the chapter
• Edit the top comment to keep the chapter metadata in sync with all coauthors/reviewers/analysts and also any completed milestones (this is helpful for us to monitor progress at a glance in 2021 Chapter Progress #2179)

[rviscomi]

Reminder for the content team (@Zizzamia @jessnicolet @WilhelmWillie @roryhewitt @boosef) please request edit access to the Caching chapter doc and begin outlining the chapter. The outline is due on June 15 to ensure that we have enough time to make any necessary changes to the testing pipeline before the crawl starts on July 1.

@HTTPArchive/analysts this chapter is still in need of an analyst. Can anyone help out? 🙏

[rviscomi]

@Zizzamia as we continue looking for an analyst, do you have any interest in taking on the role in the interim? I'd be happy to walk you through the dataset and answer any questions as needed. There's also a supportive community of analysts in the #web-almanac-analysts Slack channel.

[Zizzamia]

@rviscomi oh interesting, I am not on that Slack yet. Would you mind share an invite, so I can make the request in the #web-almanac-analysts channel.

[rviscomi]

Join us! https://join.slack.com/t/httparchive/shared_invite/zt-45sgwmnb-eDEatOhqssqNAKxxOSLAaA

[rviscomi]

Hey @Zizzamia, today is the deadline for the chapter outline to be completed but it doesn't look like anything is in the doc yet. Could you give us an update on when you'd be able to get that completed?

⚠️ Given that this chapter is behind on staffing (analysts) and planning, it's at risk of getting cut from the Almanac unless we can make progress on it soon. If you can get the planning done ASAP I can pick up the analysis work until we find a permanent contributor.

[Zizzamia]

@rviscomi thank you for the ping, the outline will be added by Friday Evening 😄

[Zizzamia]

Hey team (@jessnicolet @WilhelmWillie @roryhewitt @boosef @rviscomi),
feel free to review the initial outline in the draft doc, few notes on it:

• so far taking inspiration from the 2020 chapter in terms of query and content will be best to continue evolve
• extend the caching conversation not only on Browser Caching but also Client caching like Cookies, LocalStorage and IndexedDB

How can you help me? Well let me know if there is a particular query you think it should be included, or a new topic we should include in the Future section that explores new ways of caching.

I am going to keep re-read the queries and the outline this weekend so they are both pretty solid in the coming days.

[rviscomi]

Thanks @Zizzamia! I've reviewed the outline and left comments on anything unclear related to the analysis. I've also drafted #2254 to organize which queries need to be written and their implementation.

The only metric that may need to be implemented as a runtime metric (hard deadline at the end of the month) is "how big is the biggest CacheStorage value". I left a comment in the doc for clarification.

Reviewers: please review the outline and suggest any new metrics ASAP. I'll update my draft analysis PR accordingly but anything that requires a runtime metric needs to be implemented very soon or else it won't be measurable.

[rviscomi]

@Zizzamia @jessnicolet @WilhelmWillie @roryhewitt @boosef queries have been written and results saved to the results sheet. Could you all please review the results and leave comments if anything looks fishy? (you'll need to request access in order to comment)

[rviscomi]

The queries have all been written, reviewed, and merged in #2254, so I've checked off Milestone 3 in the top comment above.

@Zizzamia @jessnicolet @WilhelmWillie @roryhewitt @boosef please review the results in the sheet and leave comments if anything doesn't look right. Otherwise, the chapter draft is ready to start being written.

[rviscomi]

@Zizzamia have you had time to review the results? FYI the draft is due in 4 weeks. Let me know if there's anything I can do to help.

[rviscomi]

🛎️ @Zizzamia ping

[Zizzamia]

Morning, sorry for the extreme delay. I had several personal matter that put on-hold all my Open Source contributions in the last 4 months.

I will start working on the draft this week, so hopefully we have something to review soon.

And if anyone wants to help, is more than welcome 🙏

[Zizzamia]

As I am quite behind on writing this chapter, I decided to write directly the draft in this PR #2443.

Reviewers (@jessnicolet @WilhelmWillie @roryhewitt @boosef) and Analysts (@rviscomi), as I am going to write more over the next few days, feel free to add suggestions, edits or share a feedback at anytime. 🙏

[tunetheweb]

@Zizzamia @jessnicolet @WilhelmWillie @roryhewitt 

🎉 This chapter is fully written, reviewed, edited, and launched! Thank you to all of the contributors who put in the time and effort to make this a great chapter.

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. 🙏

Congratulations and thank you all again. I'm excited for this to launch soon!