JavaScript 2021

[rviscomi]

Part I Chapter 2: JavaScript

If you're interested in contributing to the JavaScript 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
@NishuGoel	@NishuGoel	@soulcorrosion @mgechev @rviscomi @pankajparkar @tunetheweb @wallet77	@pankajparkar @max-ostapenko @rviscomi	@rviscomi @pankajparkar	@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 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

[rviscomi]

In #1754 I posed a question about improving our ability to analyze JS.

The bulk of the CSS chapter's insights were made possible by the Rework library which parses the CSS into a queryable AST.

What comparable options are available for JS? How can we unlock similar insights for the 2021 JavaScript chapter?

Reasking that question here to get JS chapter contributors thinking about unlocking deeper insights.

[wallet77]

Hi Almanac team,

I will be very happy to participate on this section (or maybe on the page weight and performance section too). I can help as editors or reviewer.
My background can be sum up as: mainly fullstack developer, with a real interest in performance. I now work as a backend dev + devops.
I wrote some article on medium about perf related subjects (see here: https://medium.com/@vincentvallet).
I recently published a project to analyze JS packages quality, so I guess it can help here ;)

[rviscomi]

Welcome @wallet77! I've added you as a reviewer.

[rviscomi]

Added @mgechev and @soulcorrosion as a reviewers. Welcome! 👋

@mgechev @wallet77 @soulcorrosion feel free to start brainstorming content in the doc as we work on staffing the rest of the chapter. If there's anyone you'd like to see authoring this chapter, tell them about it!

[rviscomi]

📟 paging 2019 and 2020 contributors: @housseindjirdeh @rwaldron @RReverser @tkadlec @ibnesayeed @jadjoubran @ahmadawais @denar90

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?

[ahmadawais]

@rviscomi sure thing, I'd love to be a reviewer this year, for JavaScript and Jamstack.

[rviscomi]

@smrutiparida @Dashon-Hawkins were either of you interested in authoring/reviewing this chapter?

[ibnesayeed]

@rviscomi, I can review this chapter!

[NishuGoel]

@rviscomi I'd like to contribute as an author to this chapter.

[rviscomi]

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

• Due May 31: Complete Milestone 0: Form the content team by finding contributors to be analysts and reviewers/coauthors as needed
• Due June 15: Get started on Milestone 1: Plan content by brainstorming some content ideas in the doc (you may need to request edit access)

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!

[jabranr]

@rviscomi Interested and available as a reviewer

[rviscomi]

Welcome @jabranr! I'll defer to @NishuGoel as content team lead to onboard you and update the role assignments in #2141 (comment) as needed. For now could you request edit access to the chapter doc and start brainstorming ideas for the outline?

[NishuGoel]

Welcome @jabranr.
As yet, role assignments are as follows:-

Lead	Authors	Reviewers	Analysts	Editors	Coordinator
@NishuGoel	@NishuGoel	@wallet77 @mgechev @soulcorrosion @ahmadawais @ibnesayeed @jabranr

For now, let us explore resources and look for ideas for the chapter outline.

[rviscomi]

@NishuGoel FYI you should have edit access to the top comment, so that'd be the best place to keep all of the chapter metadata (contributors, milestones) up to date.

[NishuGoel]

@NishuGoel FYI you should have edit access to the top comment, so that'd be the best place to keep all of the chapter metadata (contributors, milestones) up to date.

@rviscomi Don't have edit access.

[rviscomi]

Ah it looks like you haven't accepted the invitation to join the HTTP Archive team on GitHub. That will give you edit access. Try going to https://github.com/HTTPArchive/ to accept the invite.

[NishuGoel]

@pankajparkar @webtaculars Would any of you be interested to co-author the 2021 chapter?

[pankajparkar]

@NishuGoel I'm interested to co-author this. Thanks

[rviscomi]

@NishuGoel and team, thank you for completing the chapter outline on time! 🎉

@ashleyish @NishuGoel could both of you review the outline and make sure that anything that would depend on querying the DOM or parsing JS files is implemented as a custom metric? I elaborated on custom metrics in this comment thread in the doc. Any new custom metrics would need to be implemented by the end of the month to be included in the test pipeline.

[max-ostapenko]

@ashleyish @NishuGoel would you need any hands for analytics tasks? I can support with custom metrics and SQL.
If yes - have you forked the legacy repo to work on custom metrics?

[NishuGoel]

@max-ostapenko That'd be really helpful! Thanks
I have been looking into this repo here

I can add a comment in the doc listing the custom metrics we need and then we can discuss further. cc: @ashleyish @pankajparkar

[bryantnovas]

He Almanac team,

I'm interested in contributing as an analyst, I'm a recent data science bootcamp grad and have previous experience with html css and javascript

[pankajparkar]

@bryantnovas that's fantastic!
@NishuGoel can you please help him to get access to Almanac Javascript resources?

[rviscomi]

👋 Hi @NishuGoel @pankajparkar @ashleyish @max-ostapenko, just checking in on the chapter progress. How is the analysis coming along?

[NishuGoel]

he chapter progress. How is the analysis coming along?

Hi @rviscomi, @pankajparkar and myself are in the middle of writing queries for the metrics here in this Draft PR.
Would love some help from anyone who has done this before, especially the part of creating visuals in excel.

[NishuGoel]

Hi, I plan to finish writing the first draft of the chapter in the next two days, this means the chapter should be ready for editing and reviewing starting October 31.
If we target to work on editing/reviewing starting 31st and continue for a week, I am optimistic to finish the writing, editing, reviewing of the chapter by November first week end.

@wallet77 @mgechev @soulcorrosion @ahmadawais @ibnesayeed @jabranr @gokulkrishh @pankajparkar @saketsaurabh05
Editors - I would like to understand who are available to start editing the chapter starting Oct 31?
Reviewers - I would like to understand who are available to start editing/reviewing the chapter starting Oct 31?

Thanks.

[soulcorrosion]

Thank you @NishuGoel. I can start reading whenever you give the go.

[wallet77]

Thank you @NishuGoel , I'm ready for reading ;)

[NishuGoel]

Hi @soulcorrosion @wallet77 Here's the draft doc. Please give your inputs here either as direct fixes for typos or as comments for some point that seems vague, incorrect etc. I am looking forward to completely working on edits/reviews.

Also sending you the link on Slack channel to be able to communicate in depth, if need be.
cc: @rviscomi

[rviscomi]

@NishuGoel @soulcorrosion @mgechev @rviscomi @pankajparkar @tunetheweb @wallet77 @max-ostapenko

🎉 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!

[NishuGoel]

Big thanks everyone here for pulling this off. 🚀🎉
Now, let's wait for the launch, and share away our efforts across.

@soulcorrosion @mgechev @pankajparkar @rviscomi @tunetheweb @shantsis @wallet77 @max-ostapenko