Almanac.httparchive.org: Caching 2020

[obto]

Part IV Chapter 20: Caching

Content team

| Authors | Reviewers | Analysts | Draft | Queries | Results |
| ------- | --------- | -------- | ----- | ------- | ------- |
| @roryhewitt | @csswizardry @jzyang @jaisanth @Soham-S-Sarkar | @raghuramakrishnan71 | Doc | *.sql | Sheet |

Content team lead: @roryhewitt

Welcome chapter contributors! You'll be using this issue throughout the chapter lifecycle to coordinate on the content planning, analysis, and writing stages.

The content team is made up of the following contributors:

• Authors
• Reviewers
• Analysts

New contributors: If you're interested in joining the content team for this chapter, just leave a comment below and the content team lead will loop you in.

_Note: To ensure that you get notifications when tagged, you must be "watching" this repository._

Milestones

0. Form the content team

• [x] Jul 6th: Project owners have selected an author to be the content team lead
• [x] Jul 13th: The content team has at least one author, reviewer, and analyst (minimally viable team formed)

1. Plan content

• [x] Jul 20th: The content team has completed the chapter outline in the draft doc
• [x] Jul 27th: Analysts have triaged the feasibility of all proposed metrics

2. Gather data

• [x] Jul 27th: Analysts have added all necessary custom metrics and drafted a PR to track query progress
• Aug 1 - 31: August crawl
• [x] Sep 7th: Analysts have queried all metrics and saved the output to the results sheet

3. Validate results

• [ ] Sep 14th: The content team has reviewed the results sheet

4. Draft content

• [ ] Nov 12th: Authors have completed the first draft in the doc
• [ ] Nov 26th: The content team has prototyped all data visualizations

5. Publication

• [ ] Nov 26th: The content team has reviewed the final draft, converted to markdown, and filed a PR to add it to the 2020 content directory
• Dec 9th: Target launch date

[rviscomi]

@paulcalvano any recommendations for authors?

[paulcalvano]

@csswizardry - any interest in writing this chapter?

[roryhewitt]

@paulcalvano I'll be an author if you're looking...

[obto]

@roryhewitt just want to confirm that you've reviewed the authoring commitment and the process works for you. Would love to have you as the lead author :)

[roryhewitt]

Yeah, the commitment should be fine. Not sure if you REALLY want me as lead author :)

[obto]

@roryhewitt thank you for agreeing to be the lead author for the Caching chapter! As the lead, you'll be responsible for driving the content planning and writing phases in collaboration with your content team, which will consist of yourself as lead, any coauthors you choose as needed, peer reviewers, and data analysts.

The immediate next steps for this chapter are:

1. Establish the rest of your content team. The larger the scope of the chapter, the more people you'll want to have on board.
2. Start sketching out ideas in your draft doc.
3. Catch up on last year's chapter and the project methodology to get a sense for what's possible.

There's a ton of info in the top comment, so check that out and feel free to ping myself or @rviscomi with any questions!

@csswizardry we'd still love to have you contribute as a peer reviewer or coauthor as needed. Let us know if you're still interested!

[csswizardry]

Hey! Sorry! I missed this. I’m happy to be involved, sure! And doubly happy for someone else to be taking on the bulk of the work—thanks, @roryhewitt 😂

[obto]

@csswizardry excited to have you on board :). Just added you as a reviewer and will leave it to @roryhewitt to re-assign as needed

[obto]

Hey @roryhewitt, hope you had a great weekend.

As you know, we're tying to have the outline and metrics settled on by the end of the week so we have time to configure the Web Crawler to track everything you need. Is there anything you need from me to keep moving things forward?

Also, can you remind your team to properly add and credit themselves in your chapter's Google Doc?

[jaisanth]

I'm interested in being part of the content team or as a reviewer, not sure if this is already filled up :-)

[jzyang]

I'd also love to help out in reviewing as this topic is interesting to me. :)

[roryhewitt]

@obto I now have access to the draft doc, so I'm going to start on it by essentially copying some of @paulcalvano's introduction to the 2019 Caching chapter (copy/paste FTW!).

Currently no co-authors assigned, although we have @csswizardry as a reviewer (I feel honored to be in such company, but you're clearly going to get British spelling from the two of us!) and two other possible reviewers - @jaisanth and @jzyang

[roryhewitt]

@obto @paulcalvano Stupid question - is it 'better' to use my personal email address or my work (Akamai) one when identifying myself at the top of the doc? I'm clearly using some of the knowledge I learned related to my job, but I'm not 'representing' them...

[paulcalvano]

That's completely up to you. Whatever is easier for you to keep track of really.

[raghuramakrishnan71]

I can help as an analyst and write the SQL queries for the identified metrics. Was part of the 2019 analyst team.

[obto]

Terrific, @raghuramakrishnan71. I've added you to the team as an analyst!

[roryhewitt]

@raghuramakrishnan71 can you add yourself to the Google Doc as an Analyst? @jzyang can you add yourself as a Reviewer? @jaisanth if you want to help me out with authoring the doc or as a reviewer, add yourself as appropriate.

Google Doc: https://docs.google.com/document/d/1uzLXOrvr8yHMnEYnY1aGTjHLq_qOYnc39ZFirTmPxlU/edit

I've started on the section descriptions etc. The 2019 Caching chapter (as written by @paulcalvano) is at https://almanac.httparchive.org/en/2019/caching, if you want an idea of what's expected.

[rviscomi]

@roryhewitt @csswizardry @jzyang @jaisanth @raghuramakrishnan71 I've updated the content team metadata in this issue and the doc and sent everyone invitations to join their respective teams. You can go to https://github.com/HTTPArchive to accept your invites. Please also "request edit access" to the doc if you haven't already so you can comment on the outline/metrics.

@raghuramakrishnan71 we're hoping to have the metrics triaged by Monday the 27th.

[obto]

@raghuramakrishnan71 Took a look through the chapter and it looks like the Crawler should be setup to get most if not all of the data you need. Can you verify and let me know if you find any additional data you need tracked?

Working on adding new custom metrics to the crawler right now :)

[raghuramakrishnan71]

@obto will check and revert. I am going through the last year's chapter and associated queries.

[obto]

@roryhewitt @raghuramakrishnan71 for the two milestones overdue on July 27 could you check the boxes if:

• the outline has been reviewed and all feasible metrics have been identified
• any necessary custom metrics have been created and you've created a draft PR to track which feasible metrics have had their queries implemented (we've updated the milestone description to clarify this)

Keeping the milestone checklist up to date helps us to see at a glance how all of the chapters are progressing. Thanks for helping us to stay on schedule!

[Soham-S-Sarkar]

I am interested in the reviewers role for this topic if we still have an open spot.

[rviscomi]

Thanks @Soham-S-Sarkar! Go ahead and request edit access to the outline doc, add your contact info to the first page, and leave any comments on the outline in the doc. cc @roryhewitt

[roryhewitt]

@Soham-S-Sarkar glad to have you on board!

[Soham-S-Sarkar]

@Soham-S-Sarkar glad to have you on board!

@roryhewitt Glad to connect and join the team. Would start reviewing the content and also, schedule a quick touchpoint with you.

[obto]

I've updated the chapter metadata at the top of this issue to link to the public spreadsheet that will be used for this chapter's query results. The sheet serves 3 purposes:

1. Enable authors/reviewers to analyze the results for each metric without running the queries themselves
2. Generate data visualizations to be embedded in the chapter
3. Serve as a public audit trail of this chapter's data collection/analysis, linked from the chapter footer

[rviscomi]

@raghuramakrishnan71 what's the status of this chapter's analysis?

[raghuramakrishnan71]

@rviscomi the scenario here has been a bit tough with frequent lockdowns and rising cases, hence there has been bit of delay from my side. Have gone through the doc/previous queries and tried the modified versions on the sample set. Will raise a PR this week the integrate the queries for review this week.

[roryhewitt]

Raghu, you and I can discuss this week, if that's good with you.

On Mon, Sep 21, 2020 at 6:35 AM Raghu Ramakrishnan [e-mail]
wrote:

@rviscomi https://github.com/rviscomi the scenario here has been a bit
tough with frequent lockdowns and rising cases, hence there has been bit of
delay from my side. Have gone through the doc/previous queries and tried
the modified versions on the sample set. Will raise a PR this week the
integrate the queries for review this week.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/HTTPArchive/almanac.httparchive.org/issues/917#issuecomment-696118832,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/ACYF72Y4PDUZPHCE63JZZYLSG5JDNANCNFSM4OJ2CWTQ
.

--
Rory Hewitt

https://www.linkedin.com/in/roryhewitt

[obto]

@roryhewitt in case you missed it, we've adjusted the milestones to push the launch date back from November 9 to December 9. This gives all chapters exactly 7 weeks from now to wrap up the analysis, write a draft, get it reviewed, and submit it for publication. So the next milestone will be to complete the first draft by November 12.

However if you're still on schedule to be done by the original November 9 launch date we want you to know that this change doesn't mean your hard work was wasted, and that you'll get the privilege of being part of our "Early Access" launch.

Please see the link above for more info and reach out to @rviscomi or me if you have any questions or concerns about the timeline. We hope this change gives you a bit more breathing room to finish the chapter comfortably and we're excited to see it go live!

[roryhewitt]

@raghuramakrishnan71 can you please send me your email address at rory.[email protected]?

[rviscomi]

@roryhewitt I've checked off all of the milestones up to "The content team has reviewed the results sheet". Please tick that once you've reviewed the results, and work with @raghuramakrishnan71 if you have any questions.

[rviscomi]

@roryhewitt @csswizardry @jzyang @jaisanth @Soham-S-Sarkar @raghuramakrishnan71 All: the draft is looking great, thank you for all of your hard work! If all of the reviewers read it and left their feedback then this is in great shape to go out in the launch in two weeks. For any reviewers who haven't gone through it yet, please try to do that before next week to keep us on schedule. Thanks!

[roryhewitt]

@rviscomi unfortunately I have to deal with a family health issue for the next week. I started the conversion to MD, but didn't get very far before this happened. What should I do - Will someone else be able to do the conversion, or can it wait until I'm available (which will probably be next weekend)?

[rviscomi]

@roryhewitt I'm sorry to hear that, take as much time as you need. During your absence, is there anyone else you'd recommend to complete the markdown conversion and/or make content decisions during the PR and editorial reviews? It looks like @jzyang has been the most active reviewer based on Docs comments, so maybe they're a good candidate if interested and willing.

I've added a comment to the PR about the metadata TODOs. They should only take a few minutes and they're personalized to you as the author, so if you have time to resolve those before taking your leave, that would help us get this chapter in shape for launch while we handle the markdown conversion.

Thank you and all of the other contributors for putting this together. I know it took a lot of time but the quality of the draft shows how worthwhile it it all was. One last big push to get the content converted to markdown and ready for final editing, so let's finish strong!

[raghuramakrishnan71]

@roryhewitt i'm sorry to hear about your family health issue. take care.
@rviscomi
I can try and help complete the markdown conversion, if there is a guide or example on the conversion mechanism (maybe the 2019 markdown can be useful).

[rviscomi]

That'd be great, thank you @raghuramakrishnan71! You can see the 2019 version of the markdown here: https://raw.githubusercontent.com/HTTPArchive/almanac.httparchive.org/main/src/content/en/2019/caching.md

For generating figures, see the guide: https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Figures-Guide

@roryhewitt used one such markdown conversion tool but you can see how much extra junk it generates, so from my experience I think converting manually is the next best option. @bazzadp posted some conversion tips in the SEO chapter: https://github.com/HTTPArchive/almanac.httparchive.org/issues/908#issuecomment-733957111 and https://github.com/HTTPArchive/almanac.httparchive.org/issues/908#issuecomment-733963486

[bazzadp]

Also feel free to reach out with any questions. I've become a bit of an expert at manually converting stuff to Markdown now! 😉 Also more than happy to review your conversion after and offer any advice.