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

Performance 2021 #2148

Closed
6 tasks done
rviscomi opened this issue Apr 27, 2021 · 34 comments · Fixed by #2434
Closed
6 tasks done

Performance 2021 #2148

rviscomi opened this issue Apr 27, 2021 · 34 comments · Fixed by #2434
Assignees
Labels
2021 chapter Tracking issue for a 2021 chapter

Comments

@rviscomi
Copy link
Member

rviscomi commented Apr 27, 2021

Part II Chapter 10: Performance

Performance illustration

If you're interested in contributing to the Performance 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
@siakaramalegos @siakaramalegos @rviscomi @ziemek-bucko @edmondwwchan @jzyang @estelle @kevinfarrugia @samarpanda @fili @Nithanaroy @siakaramalegos @jzyang @OBTo
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 Performance 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
@ziemek-bucko
Copy link

Hey, I'd love to contribute here, whether it's writing, editing, translating or anything else!

@rviscomi
Copy link
Member Author

rviscomi commented Apr 27, 2021

Thanks @ziemek-bucko! We're usually understaffed with analysts and I see in your GH profile that you've worked with BigQuery before, so how about joining as an analyst? And there are lots of translation opportunities available now if you'd like to jump in! See #923

You're also welcome to author/review in addition to being the analyst. For consideration as an author, is there anywhere we could learn more about your experience in performance? Alternatively, let me know if you'd prefer to be a reviewer.

@jonoalderson
Copy link
Contributor

jonoalderson commented Apr 27, 2021

Hello! Long-time fan, first-time caller.

I'd be extremely interested in authoring this section.

Why me?

I'm a web performance nerd, and I've been speaking internationally in the SEO & digital marketing space about performance for longer than I care to remember (see https://www.jonoalderson.com/speaking/). I'm also a member of the AMP Advisory Committee, and influence a lot of the performance thinking which happens at Yoast (and in our relation with / contributions to other open-source projects). I spend my evenings and weekends playing with cutting-edge, byte-by-byte optimization of all the things; I'm currently obsessed with shifting localization and fragment caching into edge workers, and what the 'perfect <img> tag' might look like from a performance perspective (I have 45+ slides on the topic so far, and there's still more to cover).

Some of my performance-related writing:

Can't wait to join the party!

@rviscomi
Copy link
Member Author

Thanks @jono-alderson! I'll tentatively put you down as a reviewer while we see if anyone else is interested in authoring. It's also really helpful to have your credentials for when we do need to pick an author, so thanks for providing that!

@fili
Copy link
Contributor

fili commented Apr 27, 2021

Happy to contribute as a peer reviewer here as well. Given many presentations on the topic of performance, and recently launched webvitals.dev 😁

@Nithanaroy
Copy link
Contributor

I would like to be an analyst

@jonoalderson jonoalderson mentioned this issue Apr 27, 2021
6 tasks
@jonoalderson
Copy link
Contributor

If we have other author candidates, I'd be happy to remain as a Reviewer, and to keep my primary focus on #2174.

@siakaramalegos
Copy link
Member

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, I'm happy to be a reviewer. Thanks for your consideration.

@rviscomi
Copy link
Member Author

Thanks @siakaramalegos great to have you! I've tentatively added you as a reviewer until we decide on authors.

@siakaramalegos
Copy link
Member

I just realized I'd also probably be good in the editor role for any article, as a backup if I'm not an author.

@rviscomi
Copy link
Member Author

Ok great. If there are specific chapters that you'd like to edit feel free to comment on them now. Editing also doesn't start for several months until the content takes shape so you have time to decide.

@edmondwwchan
Copy link

May I join the team to support this chapter as a peer review? Thanks.

@rviscomi
Copy link
Member Author

Absolutely, welcome to the team @edmondwwchan!

@jzyang
Copy link
Contributor

jzyang commented Apr 30, 2021

I'd like to sign up for reviewer and editor for this. :)

@rviscomi
Copy link
Member Author

rviscomi commented May 4, 2021

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

@OBTo will be the section coordinator for this chapter, so they'll be periodically checking in with you directly to make sure the chapter is staying on schedule. Reach out to them 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 still interested in contributing to this chapter, please comment below to join the team!

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

rviscomi commented May 5, 2021

ℹ️ FYI 2019/2020 contributors: @JMPerez @OBTo @sergeychernyshev @zeman @hakimelek @raghuramakrishnan71 @thefoxis @dimension85 @borisschapira @estelle @zeman @noamr @ashrith-kulai @Zizzamia @exterkamp @max-ostapenko @dooman87

The 2021 Performance chapter is in good shape in terms of staffing, but I wanted to ping you all in case you'd still like to contribute as reviewers or analysts. It's great to have input from past years' contributors. Let us know!

@rviscomi
Copy link
Member Author

rviscomi commented May 5, 2021

@eliwilliamson @nhoizey were either of you interested in being a peer reviewer for this chapter?

@Zizzamia
Copy link
Contributor

Zizzamia commented May 5, 2021

Happy to help as reviewer :-)

@samarpanda
Copy link

Can i join as a reviewer?

@estelle
Copy link
Member

estelle commented May 7, 2021

Please add me to the reviewer list.

@rviscomi rviscomi mentioned this issue May 11, 2021
6 tasks
@kevinfarrugia
Copy link
Contributor

Would be happy to help as a reviewer if you're still looking for some. :)

@siakaramalegos
Copy link
Member

Hey folks, thanks for volunteering to be on the Performance chapter team! I created a channel in the HTTP Archive Slack for this chapter - please join in for chat/discussions that don't need to be comments in this GH issue.

You can find detailed descriptions of each role in the Chapter Lifecycle article in the wiki.

Action Item
To confirm your participation, please add your name and email address to the Content Team portion of the draft Google doc. You may need to request edit access. (@ziemek-bucko @jono-alderson @fili @edmondwwchan @jzyang @estelle @Zizzamia @kevinfarrugia @Nithanaroy @jzyang @OBTo)

@foxdavidj
Copy link
Contributor

Hey @siakaramalegos excited to work with you and the rest of the group this year on the Almanac. I'm your go to guy if you've got any questions or need help so don't hesitate to reach out to me on github, the Slack (@OBTo) or email ([email protected]).

Few first steps:

  1. All authors, reviewers and analysts should add themselves to the Google Doc in the format: Name ([email protected]). But looks like you've already got a good handle on that.
  2. I've added links within the doc to the previous years Google doc in case you'd like to mine it for ideas.
  3. Would love to set up a 30 minute Zoom call in the next couple weeks to kick-start the chapter planning and brainstorming process, and put some faces to the names of the people we'll all be working with this year. I'll reach out again later this week to find a time that works.

Excited to work with you all this year.

@siakaramalegos
Copy link
Member

@Nithanaroy are you still interested in being an analyst? Just checking in since I haven't heard from you and we need to finalize the team. If you are, please add your name and email to the Google Doc and join us in Slack. See details in this comment

@foxdavidj
Copy link
Contributor

@siakaramalegos @rviscomi @ziemek-bucko @jono-alderson @fili @edmondwwchan @jzyang @estelle @Zizzamia @kevinfarrugia @Nithanaroy

Hey everyone, looks like there's been a lot of progress on creating the chapter outline which is awesome!

We should be in great shape to complete it by June 15 so we have enough time to update our crawler with any additional metrics you need this year.

Also a reminder that the team has a channel on slack (#web-almanac-performance), so feel free to join the discussion there as well: https://join.slack.com/t/httparchive/shared_invite/zt-45sgwmnb-eDEatOhqssqNAKxxOSLAaA

If you have any other questions don't hesitate to reach out :)

@siakaramalegos
Copy link
Member

@OBTo Thanks for reminding me to post here too! In case you're not on Slack, the first draft of the outline is done, so it's ready for reviewers to review. All reviews should be done in a week (by June 4) so that I have time to make final edits and work with our analyst to build queries or custom metrics.

The list of metrics is really large. So instead of giving feedback on what’s missing, try to focus the feedback on what are the likely biggest impacts to performance that are missing. A lot will need to be cut in the final version of the chapter for it to still be read by humans so I want to focus more on biggest impacts.

Slack is the best place for longer discussions. I haven't heard from some of you yet, so after this week I'll start untagging you from the contributors on the assumption you don't have the time right now. :)

@foxdavidj
Copy link
Contributor

@siakaramalegos @Nithanaroy

Hey everyone, wanted to give you a heads-up and reminder that the July website crawl has completed and chapters now need to:

  1. Analysts: Please write, test and publish the results of all the queries in the draft PR you should have created last month. We've got 3 chapters (PWA, Mobile Web, Accessibility) filled with every type of query you can imagine that you can refer to if you've ever got a question for how to grab the data you need.

  2. Chapter leads: Take a look at your Analysts draft PR where they have listed all the queries/data they'll be analyzing. You'll want to make sure all the ideas you discussed are listed and that nothing was lost in communication.

  3. Analysts: Once your queries are completed and data has been put into the spreadsheets (along with comments), set up a time to run through the data with the Chapter lead so they know exactly how to interpret the data

That's it! Really looking forward to seeing the chapter start to take form. And if you've ever got any questions just ping me

PWA: Queries, Results (has all their visualizations done as well)
Mobile Web: Queries, Results
A11Y: Queries, Results

@siakaramalegos
Copy link
Member

Hi Reviewers, in case you're not active in our Slack channel, the draft is ready for your review! I apologize for the delay - I had a whole hurricane, evacuation, and unplanned move in case you didn't know yet. I'm confident we can get back on track though!

Please review at your earliest convenience! The draft is in the same doc as before - use the outline aside to jump directly to “Draft” https://docs.google.com/document/d/1kcUGQBu9RIJ4dfE19s-GBKFIV1_QaJ4jWtAJEKz1NbE/edit#heading=h.l58oy8wsputh

@rviscomi @ziemek-bucko @jono-alderson @fili @edmondwwchan @jzyang @estelle @Zizzamia @kevinfarrugia

@rviscomi
Copy link
Member Author

rviscomi commented Nov 2, 2021

Thanks @siakaramalegos I've left my comments. It's looking great!

@siakaramalegos
Copy link
Member

@estelle @fili @Nithanaroy @kevinfarrugia @ziemek-bucko @jzyang @samarpanda @edmondwwchan for the published almanac, I need any of the following data you'd like to include - this is my example (name is required, rest is optional):

      "name": "Sia Karamalegos",
      "website": "https://sia.codes",
      "linkedin": "karamalegos",
      "twitter": "TheGreenGreek"

I already have your GitHub ID and avatar from GitHub. I'll use the name on there as a draft, but let me know if it's not how you would like it published. Please send to me in exactly this format so I can put it in the config. You can DM me on Slack also if you prefer.

@siakaramalegos
Copy link
Member

It would be even better if you could submit a PR for your info here: Already added your names, GH id, GH avatar. Fill in the blanks for the rest or delete the line if you don't want to include it https://github.com/siakaramalegos/almanac.httparchive.org/blob/performance-2021-markdown/src/config/2021.json

@tunetheweb
Copy link
Member

Or could suggest as a Review suggestion here if done before this is merged: https://github.com/HTTPArchive/almanac.httparchive.org/pull/2434/files

@siakaramalegos
Copy link
Member

I'd prefer a PR to my repo so it reduces the amount of upstream fetching I have to do. Or just give me the data.

@rviscomi
Copy link
Member Author

@siakaramalegos @ziemek-bucko @edmondwwchan @jzyang @estelle @kevinfarrugia @samarpanda @fili @Nithanaroy @jzyang

Thank you all for your hard work getting this chapter over the finish line in time for the pre-release! Congratulations on finishing the chapter, and I'm excited to see us launch the rest of the chapters along side it on Wednesday 🎉

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

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

Successfully merging a pull request may close this issue.