JavaScript 2022

[rviscomi]

JavaScript 2022

If you're interested in contributing to the JavaScript 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
@malchata	@malchata @ibnesayeed	@mgechev @pankajparkar @NishuGoel @seldo @housseindjirdeh @kevinfarrugia	@NishuGoel @kevinfarrugia	@DesignrKnight @rviscomi	@siakaramalegos

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 JavaScript 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-javascript on Slack for team coordination

[mgechev]

I'd love to help as a reviewer!

[pankajparkar]

I'm interested in reviewing this chapter

cc- @NishuGoel

[rviscomi]

@malchata is interested in the author role! 🎉
(unable to commit to team lead at this time)

[NishuGoel]

Would love to contribute as an analyst + reviewer for JS chapter this year!

[siakaramalegos]

@seldo we heard you might be interested in contributing to the JS chapter - maybe as a reviewer? Pinging you here in case...

[seldo]

@seldo we heard you might be interested in contributing to the JS chapter - maybe as a reviewer? Pinging you here in case...

Yep, I don't consider myself deep enough in JS itself to write, but more than happy to review.

[malchata]

I'll be the writer for this chapter, and I'm looking forward to having you review @seldo!

[housseindjirdeh]

I'll be happy to review as well if there's a need for more reviewers :)

[siakaramalegos]

@housseindjirdeh we could also use reviewers on #2886 if you're interested in Third Parties

[kevinfarrugia]

Would be happy to pitch in as analyst + reviewer if needed.

[ibnesayeed]

I can co-author, but can't be the lead author.

[malchata]

That's okay @ibnesayeed, I think I'm the de facto lead author. I'd welcome the help if you wanted to co-author!

[siakaramalegos]

@NishuGoel @kevinfarrugia just verifying @rviscomi already has your email addresses to get access to Big Query so you're not charged

[malchata]

@siakaramalegos @rviscomi, it appears our team is mostly complete, just short an editor. Did anyone volunteer to edit and I just missed this?

[DesignrKnight]

I would love to join the team and volunteer as an editor.

[malchata]

I've added you to the editor column, @DesignrKnight!

If anyone else is interested in editing, please indicate interest here and I'll add you!

[rviscomi]

Thanks @DesignrKnight! FYI there's not much work for editors to do until the draft is written, so that's why we don't require those roles to be filled before starting on the planning phase. If you'd like to be involved with the planning phase, you may also be interested in the reviewer role.

For now the main thing is to make progress on the chapter outline in the planning doc. We're hoping to have that completed by May 15.

[rviscomi]

@malchata @ibnesayeed @mgechev @pankajparkar @NishuGoel @seldo @housseindjirdeh @kevinfarrugia @NishuGoel @kevinfarrugia @DesignrKnight could you all make sure you have access to the planning doc and start adding your ideas to the outline? What's new with JavaScript this year or what should we revisit from previous years? We're hoping to have that completed by May 15 to give us enough time to add any new custom metrics to the crawl before it starts on June 1. Thanks!

[malchata]

@rviscomi, I'll be doing the outline this weekend. If anyone needs access, just ping me or Rick.

[rviscomi]

Thanks @malchata! It's also a team sport so all coauthors/reviewers/analysts should feel free to collaborate on the outline by adding their ideas. As the content team lead, you're ultimately responsible for deciding the narrative and direction for the chapter, but don't feel that the brainstorming part is all on you. 🤝

[malchata]

cc: @siakaramalegos, @rviscomi

I now have a draft outline available. Anyone reading this who doesn't have access, please request it. The outline is similar in structure to last year's, but with additional content. I left a flurry of comments in the draft outline, addressed openly to anyone who wants to engage.

[malchata]

Awesome! I appreciate your hard work on this, Kevin!

[kevinfarrugia]

@malchata Yep, completely forgot about them. All links are now updated. Keep me in the loop if you have any feedback.

[siakaramalegos]

@kevinfarrugia it looks like the analysis is almost complete - can you give us an idea of % complete and timeline on the rest, if any?

@malchata Thanks for beginning the draft! Just as a reminder, the due date at the end of the month is for post-review and post-edit, so you'll need to set aside at least a week for those and preferably more.

[malchata]

Thanks for the heads up @siakaramalegos! I'm going to allocating more time to tackle this over the next couple of weeks so I can get it all wrapped up for review.

Just a note, I will be in South Korea during the review due date, but anticipate I will have time to get it across the finish line in time for 9/15.

[kevinfarrugia]

@siakaramalegos analysis is complete and and all results are updated on the result sheet.

@malchata I left the comments on the outline. Let me know if I missed something or you need anything else from my end.

Thanks both.

[malchata]

I'll be working more on the draft this weekend, so I'll hit you up if I see anything missing. Thanks for all your hard work, @kevinfarrugia! LOTS of data here to pore over for the remainder of the draft.

[siakaramalegos]

Hi reviewers (@mgechev @pankajparkar @NishuGoel @seldo @housseindjirdeh @kevinfarrugia), @malchata only has two small sections to finish writing, but all the other content is done. Can you start reviewing now so we can try to still hit the deadline? I can backfill for review on the last bit if you're not free then.

[DesignrKnight]

Should I also start looking at the style guide as an editor in a preliminary fashion in parallel or do I do it after the review is done?

[rviscomi]

@DesignrKnight yes definitely start familiarizing yourself with the Editors' Guide. Ideally the editing pass will be done after the technical review because the text is still changing, but given the tight timeline, I'd suggest leaving your non-technical edit suggestions in the doc when you're ready. Then you can give it a quicker final pass after the technical review is done.

[malchata]

@rviscomi @kevinfarrugia I'm nearly done with the text, but I do need additional graphs/visualizations for the minification section that were present in the 2021 almanac's JavaScript chapter.

[kevinfarrugia]

Sure, I will prepare them tomorrow.

[DesignrKnight]

@DesignrKnight yes definitely start familiarizing yourself with the Editors' Guide. Ideally the editing pass will be done after the technical review because the text is still changing, but given the tight timeline, I'd suggest leaving your non-technical edit suggestions in the doc when you're ready. Then you can give it a quicker final pass after the technical review is done.

Awesome, sounds good. Will do as per the suggestion.

[kevinfarrugia]

@malchata I added the visualizations for the minification section (two sheets). Heads up that the pct value was calculated incorrectly on lighthouse_unminified_js.sql and I have now updated it.

[malchata]

@siakaramalegos, @rviscomi: the first draft is complete!

cc reviewers @mgechev @pankajparkar @NishuGoel @seldo @housseindjirdeh @kevinfarrugia. The draft link is here: https://docs.google.com/document/d/12Mqcp5ME04fn15ujO-J65eMZJlQ6ADEbXozttx0MJw8/edit#

[rviscomi]

Thanks @malchata! I gave it a read and left lots of small suggestions mostly about the charts and data precision. Overall this is really really well-polished and well-written, great work to you and the rest of the team! 🎉

I can sign off on it from an editorial perspective once those comments are resolved. @DesignrKnight it'd still be great if you could also give it a read through and leave editing/non-technical feedback in case I missed anything.

I see @ibnesayeed is listed as a coauthor but don't see any additions to the writing in the edit history. Should we move him to the reviewer role instead?

Speaking of which, @mgechev @pankajparkar @NishuGoel @seldo @housseindjirdeh @kevinfarrugia over to you all for technical / peer review feedback.

[malchata]

I wrote the whole thing from top to bottom, so if @ibnesayeed is interested, they can jump in on the review.

Thanks for the kind words, Rick. Was glad I could get this in a draft before September.

[DesignrKnight]

Thanks @malchata! I gave it a read and left lots of small suggestions mostly about the charts and data precision. Overall this is really really well-polished and well-written, great work to you and the rest of the team! 🎉

I can sign off on it from an editorial perspective once those comments are resolved. @DesignrKnight it'd still be great if you could also give it a read through and leave editing/non-technical feedback in case I missed anything.

Surely @rviscomi . I'll take a look at it today (Tuesday) before end of the day and add my thoughts on the document.

[DesignrKnight]

I took a first-pass look at the chapter's first half. It is pretty amazing to see such a detailed well-articulated chapter. Fantastic

[siakaramalegos]

Great job so far @malchata and team! Do you think you can finish reviewing and incorporating comments within the next few days? We'd really like to get this published in the first round. cc @mgechev @pankajparkar @NishuGoel @seldo @housseindjirdeh @kevinfarrugia

[malchata]

I can work on it over the weekend!

…

On Fri, Sep 2, 2022 at 12:54 PM Sia ***@***.***> wrote: Great job so far @malchata <https://github.com/malchata> and team! Do you think you can finish reviewing and incorporating comments within the next few days? We'd really like to get this published in the first round. cc @mgechev <https://github.com/mgechev> @pankajparkar <https://github.com/pankajparkar> @NishuGoel <https://github.com/NishuGoel> @seldo <https://github.com/seldo> @housseindjirdeh <https://github.com/housseindjirdeh> @kevinfarrugia <https://github.com/kevinfarrugia> — Reply to this email directly, view it on GitHub <#2880 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAMPHJTSM3DBVBM7NRTHZCDV4I5OJANCNFSM5TH7XOUA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[siakaramalegos]

It looks like we still need some more reviewers - I've only seen 1 reviewer comment from Kevin Farrugia. @mgechev @pankajparkar @NishuGoel @seldo @housseindjirdeh can you review in the next day or two? We're now behind schedule and at risk for publishing on time. Please post when you're done with your review so that @malchata can more quickly integrate feedback. Editing can't begin until the technical review cycle is done.

[malchata]

Hey @siakaramalegos,

@rviscomi is going to get this over the finish line for me, as I have a trip to South Korea next week for JSConf. But do keep me in the loop, and if you need anything from me specifially!

Cheers,
Jeremy

[pankajparkar]

@siakaramalegos @rviscomi I had a look at the complete article. I have added a comment from my end.

@malchata Great Job! Very well written 🙌 🙌