Caching 2022

[rviscomi]

Caching 2022

If you're interested in contributing to the Caching 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
@roryhewitt	@roryhewitt	@rrajiv	@kevinfarrugia	-	@paulcalvano

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 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
💬 #web-almanac-caching on Slack for team coordination

[roryhewitt]

Well I've been an Author (2020) and a Reviewer (2021). If you need authors or reviewers for 2022, I'm in again :)

[rrajiv]

Hi @rviscomi - i'd like to be a reviewer for this chapter. Thanks.

[kevinfarrugia]

Would be happy to help as analyst.

[rviscomi]

Thank you @roryhewitt @rrajiv @kevinfarrugia for stepping up to contribute to this year's Caching chapter!

@roryhewitt I've put you down as the content team lead, so you'll be responsible for all of its chapter's project management and keeping it on schedule. I've checked off Milestone 0 now that you have a fully-formed team, but I'll leave it to you to check off the rest of the milestones as you go.

The next milestone is coming up on May 15, which is to complete the chapter outline. So everyone please request access to the chapter planning doc and also make sure you're in the #web-almanac-caching channel on Slack to coordinate on progress.

Thanks everyone!

[valerojasm]

Hello! I'd love to help as an analyst too if it's still needed :)

[kevinfarrugia]

Hi @valerojasm . From my end help is always welcome. Would you like to take over the analysis role and I can pitch in if needed? (I'm contributing to other chapters too)

[rviscomi]

There are several chapters in need of analysts so it'd be good to spread the load. Or @kevinfarrugia if you're stretched too thin we can reassign the role to @valerojasm.

[kevinfarrugia]

Whatever works best. I'm happy to continue on this chapter.

[rviscomi]

@roryhewitt @rrajiv @kevinfarrugia reminder to get access to the planning doc and start brainstorming content to include in this year's chapter. What's new with caching, or what would be good to revisit from previous years? We're hoping to have the outline completed by May 15 to stay on schedule. Thanks for your help!

[roryhewitt]

@rviscomi @rrajiv @kevinfarrugia

So I have come down hard with Covid over the last week, and it's left me just completely wiped out. I'm aware that I am significantly behind on doing the draft outline (@paulcalvano has pinged me a couple of times). I'm doing my best to come up with something which isn't just the exact same thing as I authored for the 2020 Caching chapter (although I quite liked that, personally).

@rrajiv - are you able to give me a hand with this one? It's honestly hard to even put pen to paper and think...

[rviscomi]

So sorry to hear that @roryhewitt I hope you feel better soon. We'll find someone to fill in for you until then.

[rrajiv]

@roryhewitt sorry to hear that. I will take a look at it this week.

[rviscomi]

@roryhewitt @rrajiv @kevinfarrugia hi all, just checking in. Just to confirm, has the lead author role officially transitioned from @roryhewitt to @rrajiv? If so @rrajiv can you update the contributor info at the top of the issue? Also @roryhewitt could you confirm if you're still able to contribute as a reviewer?

@kevinfarrugia I see your note in #2941 that you're still waiting for the outline and will defer to the 2021 queries for now. Is that still the case? If so @rrajiv (or @roryhewitt) can you coordinate with @kevinfarrugia if there are any new metrics you'd like to explore this year?

The analysis phase is scheduled to end next week so I want to make sure the writing is able to start on time if possible.

Hope everyone is well!

[rrajiv]

Hi @rviscomi - wasn't aware the role had switched ;). I had helped out earlier on the doc with some comments to update the outline since @roryhewitt was out

[kevinfarrugia]

From my end I am still waiting for the outline and I ran the queries from 2021 and updated the Google Sheet with the data from June 2022. I see there is a request for two new standards which I can look into if needed.

[rviscomi]

Good to know thanks @rrajiv and @kevinfarrugia.

So it seems like the expectation is for @roryhewitt to continue in the lead author role. @roryhewitt are you feeling up for it? If not we may need to find an alternate lead or close the chapter. That'd be good to clarify now before @kevinfarrugia does any additional work on the analysis.

[rviscomi]

⛔ Hi everyone. Unfortunately it doesn't seem like this chapter has anyone to take the lead author role, which means we won't be able to publish it this year. I wish @roryhewitt the best and hope his recovery has been going well—one's health should always come before volunteer projects like this and I fully support stepping back to focus on recovery.

I'm going to close this issue so we can refocus our efforts on the remaining chapters. If anyone is interested to step up and lead the remaining effort, leave a comment and we can try to make it work. Given that the results are already available in the sheet, we only need two people at minimum: one to author the chapter, and one to review it. As a reminder, the due date to have the chapter fully written, reviewed, and edited is September 1.