HTTPArchive
JavaScript 2022
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
- [x] May 1: The content team has at least one author, reviewer, and analyst
1. Plan content
- [x] May 15 The content team has completed the chapter outline in the draft doc
2. Gather data
- [x] 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
- [x] 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
@malchata is interested in the author role! 🎉 (unable to commit to team lead at this time)
Would love to contribute as an analyst + reviewer for JS chapter this year!
@seldo we heard you might be interested in contributing to the JS chapter - maybe as a reviewer? Pinging you here in case...
@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.
I'll be the writer for this chapter, and I'm looking forward to having you review @seldo!
I'll be happy to review as well if there's a need for more reviewers :)
@housseindjirdeh we could also use reviewers on #2886 if you're interested in Third Parties
That's okay @ibnesayeed, I think I'm the de facto lead author. I'd welcome the help if you wanted to co-author!
@NishuGoel @kevinfarrugia just verifying @rviscomi already has your email addresses to get access to Big Query so you're not charged
@siakaramalegos @rviscomi, it appears our team is mostly complete, just short an editor. Did anyone volunteer to edit and I just missed this?
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!
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.
@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!
@rviscomi, I'll be doing the outline this weekend. If anyone needs access, just ping me or Rick.
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. 🤝
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.
FYI to all: the table of contents outline is due this Sunday (15 May). If you’re a reviewer on the JavaScript chapter and have feedback, please get it in today or tomorrow: doc link.
@ibnesayeed @mgechev @pankajparkar @NishuGoel @seldo @housseindjirdeh @kevinfarrugia just a reminder to open up the draft doc, add your name and email address to confirm your participation, and provide feedback on the outline Jeremy started. The outline is due in 2 days and he will need time to incorporate your feedback. Thanks!
@kevinfarrugia, @NishuGoel what's the status of the custom metrics? Are we set for the June crawl?
@kevinfarrugia, are all metrics ready? I'm thinking I'd like to get a draft going next month.
@malchata there are a few remaining queries and visualisations. Will pick them up over the next 3/4 days so you have time to review before the end of the month.
@malchata Yep, completely forgot about them. All links are now updated. Keep me in the loop if you have any feedback.
@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.