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

Page Weight 2021 #2157

Closed
6 tasks done
rviscomi opened this issue Apr 27, 2021 · 28 comments
Closed
6 tasks done

Page Weight 2021 #2157

rviscomi opened this issue Apr 27, 2021 · 28 comments
Assignees
Labels
2021 chapter Tracking issue for a 2021 chapter

Comments

@rviscomi
Copy link
Member

rviscomi commented Apr 27, 2021

Part IV Chapter 19: Page Weight

Page Weight illustration

If you're interested in contributing to the Page Weight 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
@logicalphase @logicalphase @siakaramalegos @jessthebp @RMHolmlund @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 Page Weight 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

@rviscomi rviscomi added 2021 chapter Tracking issue for a 2021 chapter help wanted Extra attention is needed labels Apr 27, 2021
@siakaramalegos
Copy link
Member

siakaramalegos commented Apr 27, 2021

Hi, I'd be interested in being an author. I write and speak on performance as well as perform contract work for various companies on performance. You can learn more about me on my website (including articles, talks, and workshops): https://sia.codes/

If I'm not chosen as an author on this or any other page, I'm happy to be a reviewer or editor. Thanks for your consideration.

@rviscomi
Copy link
Member Author

rviscomi commented May 5, 2021

📟 paging 2019/2020 contributors: @khempenius @tammyeverts @paulcalvano @flowlabs @henrihelvetica @borisschapira

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?

@logicalphase
Copy link
Contributor

I'm in full remission and back at work full time. I'd like to author this one. It fits with my work on web sustainability and performance. If you agree, sign me up. Thanks.

@jessthebp
Copy link
Contributor

Hi, I'd be interested in working on this chapter as a reviewer or analyst.

@rviscomi rviscomi removed the help wanted Extra attention is needed label May 5, 2021
@rviscomi
Copy link
Member Author

rviscomi commented May 5, 2021

@logicalphase so glad to hear you're doing better and 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:

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!

@logicalphase
Copy link
Contributor

Perfect. I'm reaching out to a few people also working in this area, and will report back. Excited about 2021 almanac as always. Thanks again, Rick. Look forward to working with and on it.

@logicalphase
Copy link
Contributor

You can add @RMHolmlund as editor. She's awesome with content 🙂

@rviscomi
Copy link
Member Author

rviscomi commented May 6, 2021

@logicalphase as the lead, you've got control of this issue now and you should have edit access, so feel free to modify #2157 (comment) as you get new contributors and also as you meet new milestones. For example, you can add @RMHolmlund to the Editors column and check off Milestone 0.

@logicalphase
Copy link
Contributor

Got it. Thanks again.

@logicalphase
Copy link
Contributor

Greetings @siakaramalegos, @jessthebp, and @RMHolmlund , and thank you for joining the Page Weight team. I look forward to working with each of you. I'll send an update in day or two on next steps. In the meantime please let me know if you have questions or if I can assist. Cheers.

@rviscomi
Copy link
Member Author

rviscomi commented May 11, 2021

Hi @logicalphase just checking in to help keep the chapter on track. One tip: coordinate with the rest of the content team to request edit access to the doc and start brainstorming an outline for the chapter. We're looking to have an outline completed by June 15.

Also, thank you for being the first chapter to actually check off Milestone 0! 😄 🙌

@logicalphase
Copy link
Contributor

Will do. We'll have outline by or before the DL. I've been going through previous chapters so we can figure out how to forward, and needs. Thanks for your assists as always.

@rviscomi
Copy link
Member Author

Sounds great! I'll check in on your progress again in about a week but feel free to ping me if you have any questions/concerns.

@logicalphase
Copy link
Contributor

logicalphase commented May 11, 2021 via email

@logicalphase
Copy link
Contributor

In looking at the 2020 Page Weight product, I think it touches on all the right data points. I may add some analysis to the previous work. If anyone on the team can take some time to review https://almanac.httparchive.org/en/2020/page-weight and offer any additional thoughts on shaping the next release I'd be grateful. My plan is to to complete milestone 1 over the weekend and move on to the next. That keeps us on schedule given Google IO this week. Thank you.

@siakaramalegos
Copy link
Member

In the Performance Chapter, we were thinking of looking to see if there is a correlation between page weight and performance (Core Web Vitals) - this is our tracking issue for now: siakaramalegos/performance-almanac#15

Let me know if you're interested in covering it instead, and then we could point to your chapter.

@logicalphase
Copy link
Contributor

Hi @siakaramalegos - I'm fine with adding content that can be linked to by the performance product. Good to go.

@rviscomi
Copy link
Member Author

@logicalphase the outline is looking good so far! I've left a couple of comments. @siakaramalegos @jessthebp @RMHolmlund be sure to also request edit access to the doc so you can leave your suggestions/feedback. As a reminder the chapter outline should be completed by June 15 to leave enough time for changes to the test pipeline as needed before the July 1 crawl begins, but it looks like you're on track to finish early 🚀

@logicalphase
Copy link
Contributor

THank you, @rviscomi. Just to bring @siakaramalegos @jessthebp @RMHolmlund further up to date, I completed the draft of the outline for 2021. Now, I really need your help in the form of suggestions, proposed changes, and questions you may have. Your feedback is important. Ideally, I'd like to complete this milestone this weekend at the latest. So, if you would be so kind as to give the outline linked to above, and post your comments, we can close this milestone and get a welcomed head start on analysis. Thank you all again.

@rviscomi
Copy link
Member Author

Thanks for completing the chapter outline on time @logicalphase! 🏆

@logicalphase
Copy link
Contributor

logicalphase commented Jul 19, 2021

Hey @jessthebp - based on the criteria set forth in item #1 - the outline document. Can you take a quick look to make sure you're good to go on custom metrics, etc. for analysis. If so I'd like to mark item #2 complete. Thanks again for your help.

@konfirmed
Copy link
Contributor

Hi, I'll like to help here if needed

@rviscomi
Copy link
Member Author

👋 Hi @logicalphase @jessthebp, just checking in on the chapter progress. How is the analysis coming along?

@logicalphase
Copy link
Contributor

Hi Rick,

Admittedly, I've gotten behind this past couple of weeks implementing org changes with acquisition of company and today is another stuffed day of meetings. I'm hoping @jessthebp can help pull me along on the data issues outstanding, so I can step back in on Wednesday when done here and forge ahead.

@jessthebp
Copy link
Contributor

Hi, @logicalphase - I'm working on the analysis this week and will keep you updated.

@logicalphase
Copy link
Contributor

Thanks. Much appreciated!

@rviscomi
Copy link
Member Author

Hi @logicalphase @jessthebp any updates? A good first step would be to draft the analysis PR. I noticed the Milestone 2 checkbox was checked, but I don't see the draft PR open so I went ahead and unchecked it.

@rviscomi rviscomi added the ASAP This issue is blocking progress label Sep 25, 2021
@rviscomi rviscomi mentioned this issue Oct 1, 2021
21 tasks
@rviscomi rviscomi removed the ASAP This issue is blocking progress label Oct 1, 2021
@rviscomi
Copy link
Member Author

@logicalphase @siakaramalegos @jessthebp @RMHolmlund

🎉 This chapter is fully written, reviewed, edited, and ready to be launched on Wednesday! 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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2021 chapter Tracking issue for a 2021 chapter
Projects
None yet
Development

No branches or pull requests

6 participants