Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CDN 2022 #2900

Closed
6 tasks done
rviscomi opened this issue Apr 12, 2022 · 29 comments · Fixed by #3212
Closed
6 tasks done

CDN 2022 #2900

rviscomi opened this issue Apr 12, 2022 · 29 comments · Fixed by #3212
Assignees
Labels
2022 chapter Tracking issue for a 2022 chapter ASAP This issue is blocking progress

Comments

@rviscomi
Copy link
Member

rviscomi commented Apr 12, 2022

CDN 2022

CDN illustration

If you're interested in contributing to the CDN 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
@harendra @harendra @joeviggiano @ytkoka @harendra @joeviggiano @tunetheweb @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 CDN 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-cdn on Slack for team coordination

@rviscomi rviscomi added 2022 chapter Tracking issue for a 2022 chapter help wanted Extra attention is needed labels Apr 12, 2022
@rviscomi rviscomi added this to the 2022 Content Planning milestone Apr 12, 2022
@Navaneeth-Akamai
Copy link

Navaneeth-Akamai commented Apr 18, 2022

@rviscomi Hope you are doing good! Wanted to add my nomination to author/be the content lead for CDN Chapter 2022 :) Want to pick it up from where we left it last time and see how the CDN landscape has moved on from then

@rviscomi
Copy link
Member Author

rviscomi commented May 2, 2022

Welcome back @Navaneeth-Akamai! Thank you for stepping up to lead the CDN chapter again!

The most urgent need is to staff the rest of the team (Milestone 0, due yesterday). @jzyang @boosef @paulcalvano would either of you be interested to join again as reviewers and/or analysts?

While we try to find other contributors, please request access to the chapter planning doc and join the #web-almanac-cdn channel on Slack to coordinate as the team fills out.

@Navaneeth-Akamai the next milestone is due May 15 and we're looking to have a completed outline for the chapter. It's fine to start with the 2021 table of contents and tweak it as needed. Thanks!

@Navaneeth-Akamai
Copy link

Thanks Rick! let me ask around if anyone i know off is ready to help us with the tasks

@rviscomi rviscomi added help wanted: reviewers This chapter is looking for reviewers help wanted: analysts This chapter is looking for data analysts labels May 3, 2022
@rviscomi
Copy link
Member Author

rviscomi commented May 6, 2022

⚠️ @Navaneeth-Akamai any progress on finding someone to review/analyze this chapter? The outline also doesn't seem to have been started yet so this chapter is at risk of falling behind. Would be great to get some ideas added to the doc and fill out the rest of the team ASAP. Thanks for your help!

@brassic-lint
Copy link

Hey, I'd be interested in helping out with Reviewing/Editing if you still need people!

@rviscomi rviscomi added the ASAP This issue is blocking progress label May 19, 2022
@rviscomi
Copy link
Member Author

Thanks @brassic-lint it's great to have you!

@Navaneeth-Akamai given the subject of this chapter I think it's less likely that we'll need any custom metrics, so let's extend the deadline for the completion of the outline to June 1. After that, I'd expect the team to have a firmer idea of the chapter's narrative and what metrics need to be queried in order to stay on track. Given that we're still missing an analyst, I do still consider this chapter as being at high risk of not making it into the final publication, so let's reevaluate the status on June 1.

@vgotluru
Copy link

I would be interested in reviewing if you are still looking for more people.

@joeviggiano
Copy link
Contributor

I would like to contribute to this project as a data analyst.

@m-shafiul
Copy link

I would like to contribute to the project as an analyst. If there are any other aspects of the project that requires assistance, more than happy to help.

@rviscomi rviscomi removed help wanted Extra attention is needed help wanted: reviewers This chapter is looking for reviewers help wanted: analysts This chapter is looking for data analysts labels May 24, 2022
@rviscomi
Copy link
Member Author

Thanks @brassic-lint @vgotluru @joeviggiano @m-shafiul for all stepping up to staff this chapter and keep it on track!

@Navaneeth-Akamai any progress on the chapter outline? I've seeded it with the outline from 2021 but it'd be great to flesh it out with any more details that you'd like to cover, beyond rerunning last year's queries.

@Navaneeth-Akamai
Copy link

Sure @rviscomi! I'm on it!

@sagrao
Copy link

sagrao commented May 25, 2022

Would like to contribute as a Co-author for this project.

@rviscomi
Copy link
Member Author

Welcome @sagrao! 🎉

@Navaneeth-Akamai do you need help coauthoring the chapter?

Meanwhile, @sagrao it'd be great if you added your ideas to the chapter outline (request edit access) for topics to cover beyond last year's chapter and any additional depth needed.

@harendra
Copy link
Contributor

Hi this is Haren from AWS, would like to contribute as a data analyst.

@abutail
Copy link

abutail commented May 26, 2022

Hi this is Anuj from AWS, would like to contribute as a co-author.

@rviscomi
Copy link
Member Author

👋 Welcome @harendra @abutail!

Go ahead and request access to the chapter planning doc and add any ideas for topics to cover to the outline.

@rviscomi rviscomi removed the ASAP This issue is blocking progress label Aug 19, 2022
@rviscomi
Copy link
Member Author

The analysis PR has been merged and the results available in the sheet with charts.

@Navaneeth-Akamai @sagrao @abutail @somecloudguy @brassic-lint @vgotluru please start reviewing the results and reach out to the analysts if you have any questions. In order to be released on time, the draft must be written, reviewed, and edited by September 1, so not much time left.

@Navaneeth-Akamai it'd be a good idea to coordinate with your coauthors on which sections they'll write so you can work in parallel. You should also coordinate with your reviewers to make sure they have time to review the draft once it's written. You don't currently have an editor assigned, so ping @paulcalvano when the draft has been peer reviewed and we'll assign you an editor to go over it.

@rviscomi
Copy link
Member Author

rviscomi commented Sep 3, 2022

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

@rviscomi rviscomi closed this as not planned Won't fix, can't repro, duplicate, stale Sep 3, 2022
@joeviggiano
Copy link
Contributor

@rviscomi I'd like to try and get this out the door before the next two week deadline, I'll start working on the report ASAP.

@rviscomi
Copy link
Member Author

Thanks for picking this back up @joeviggiano! I'm going to reiterate what I shared with the Accessibility team when they were considering reopening the chapter:

The chapter is still closed. It's fallen too far behind for us to plan on including it in this year's publication. BUT the people I've chatted with are still very interested to salvage the chapter.

If the chapter can meet the following requirements, we'll be able to reverse the decision to close it:

  • The chapter must be data-driven, so there needs to be a substantial amount of data backing it up. Reusing the 2021 outline and queries would accomplish this.
  • The content must be original, not a simple rewording of last year's authors.
  • The chapter must be peer reviewed and edited by someone other than the authors, following the guidelines in the wiki (Reviewers' Guide, Editors' Guide).
  • The chapter must be fully caught up with all milestones by the publication deadline on September 15 October 10, no exceptions.

To be clear, I am strongly discouraging this plan because of the enormous amount of work to be done in a short amount of time. But I won't stop anyone from trying to get it back on track, and I'll commit to reversing the decision if the requirements are met. Thanks everyone for your understanding, this is a tough decision and I'd like to be as fair as possible.

Anyone who still wants to contribute to the chapter is welcome to do so. Please reply here and/or coordinate in the Slack channel about tackling the remaining work.

@joeviggiano who will be the authors and reviewers?

@joeviggiano
Copy link
Contributor

I will be an author and @harendra will review. If you require more reviewers I'll try and recruit more this week.

@joeviggiano
Copy link
Contributor

@rviscomi we've decided that @harendra will co-author with me and @ytkoka will be the reviewer.

@ytkoka
Copy link
Contributor

ytkoka commented Sep 30, 2022

Hi, Thank you for inviting me, I am happy to review the CDN content.

@rviscomi rviscomi added the ASAP This issue is blocking progress label Sep 30, 2022
@rviscomi
Copy link
Member Author

Thanks @joeviggiano @harendra @ytkoka! Reopening this issue to track its progress. Let us know how it goes.

@tunetheweb
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2022 chapter Tracking issue for a 2022 chapter ASAP This issue is blocking progress
Projects
None yet
Development

Successfully merging a pull request may close this issue.