almanac.httparchive.org
almanac.httparchive.org copied to clipboard
HTTPArchive
Markup 2022
Markup 2022
If you're interested in contributing to the Markup 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 |
|---|---|---|---|---|---|
| ~@AlexLakatos~ @j9t | ~@AlexLakatos @ibnesayeed @daKmoR~ @j9t | ~@j9t~ @zcorpan @bkardell | @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
- [x] 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 Markup 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-markup on Slack for team coordination
@daKmoR Typically you're a co-author or a reviewer, but not listed as both. As a co-author, you still get to review all the content and provide feedback, you just only get one credit for it (author or reviewer).
Once content leads are selected (@AlexLakatos) they get to pick the final authoring team. So I'll let you two chat and then Alex can update the issue with the final decision.
Tentatively adding myself as the analyst for this chapter to help it meet Milestone 0.
@siakaramalegos @daKmoR I'm cool with having multiple authors, welcome to the team! @rviscomi thanks for volunteering, welcome to the team!
@daKmoR @ibnesayeed @j9t @bkardell @rviscomi Don't forget to add your contact info to the tracking document: https://docs.google.com/document/d/1OV_-YmxXoFCalDIdAYq9eTZMpjsQ0rsuFKGAsF-8eoM/edit#heading=h.xleqpbggrlck
@AlexLakatos @ibnesayeed @daKmoR @j9t @bkardell looks like there hasn't been much progress on the chapter outline yet. Could you all make sure you have access to the doc and start adding your ideas for new things happening to Markup this year, or interesting topics to revisit from previous years? Hoping to have that completed by May 15 to give us enough time to implement any needed custom metrics before the June crawl begins. Thanks!
@AlexLakatos @ibnesayeed @daKmoR @j9t @bkardell just a reminder that the outline is due in 2 days. Please open the doc, add your name and email address to confirm your participation, and add your thoughts for the outline.
This is a critical deadline because we only have 2 more weeks to finalize any custom metrics for the crawl.
I started an outline based on the one from last year - feel free to adjust/add/remove...
I tried to add some details on what to capture - not sure if it makes sense or what format it should be? any hints on how to formulate it?
We can use the metrics from last year as well. I've only added a couple of new things for links. @daKmoR I've seen the new web component sections you've added, looks good!
I've just marked the content plan as complete, it's got a lot of the things from last year, with just a few things added on around web components and links for this year. @rviscomi we can go ahead and look at the new metrics that need to be added, there's only a couple of things.
✨ Custom metrics added! We're all caught up on the analysis milestones, so the next step is to wait for the June crawl to kick off and start drafting the queries in #2945. Then it's over to you @AlexLakatos to do the fun part! 😁
@AlexLakatos FYI I'm starting to write the queries and putting the results in the chapter spreadsheet. I'll let you know when it's done but you can start taking a look now to plan your narrative.
Update: analysis is done. Just waiting for a code review on #2945, but you should be unblocked to review the results and start writing.
FYI coauthors and reviewers @AlexLakatos @ibnesayeed @daKmoR @j9t @bkardell: the analysis PR https://github.com/HTTPArchive/almanac.httparchive.org/pull/2945 is merged so it's over to you all now to review the results and start drafting the content. Let me know in the comments of the spreadsheet if you have questions about anything! (you will need to request edit access, as usual)
@AlexLakatos when do you think you can begin 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.
🛎️ @AlexLakatos @ibnesayeed @daKmoR @j9t @bkardell the results have been ready for two months but I don't see any progress whatsoever in the draft doc. As @siakaramalegos noted, the chapter is expected to be written, reviewed, and edited by the end of the month.
@AlexLakatos as the chapter lead please coordinate with your team to get the draft written. There are three coauthors so they should each have sections assigned to work in parallel. Reviewers should be kept in the loop so they can make time to give feedback when the draft is ready. There is not currently an editor assigned but as soon as the draft is reviewed, reach out to @siakaramalegos and we'll find someone.
We're almost done!
Haven't seen any update in the draft doc so wanted to reach out again - @AlexLakatos when do you think you can begin the draft? What's the plan to complete it in time? Thanks
Hi all, Rick and I haven't seen any responses to our messages and the deadline is upon us. Is anyone going to work on writing this chapter by the end of the month? If not, then this chapter is at risk of being closed so that we can focus our effort on the other chapters.
@AlexLakatos @ibnesayeed @daKmoR @j9t @bkardell
Still planning on writing this. We can revisit next week if my hopes and dream will translate into reality or not.
@AlexLakatos The deadline is in 5 days so if you can't commit to it then maybe one of the other authors should start?
⛔ Hi everyone. Given that we're now beyond the deadline to have the draft written, reviewed, and edited but the draft has still not been started, unfortunately I think we're going to have to close the chapter. It's not looking like it'll be feasible to get the chapter back on track to be able to launch on time. Apologies to everyone who committed their time up to this point, and thanks for your understanding.
@rviscomi, @siakaramalegos, team—if you can give me 5 days (until Wed, Sep 7) and allow to keep this chapter short, I think I can turn it around and write a minimum chapter until then, to be handed over for review.
(That assumes that the data are good—they seem so, but if there are major issues here, that could still stop us.)
Please confirm asap and I get right at it.
@bkardell, would you still be available as a reviewer? @zcorpan, I know you didn’t raise a hand, but would you be open to reviewing, too? Would be delighted to pair up with you.
PS. I may need support for generating the charts (will leave notes with sufficient detail in the doc to aid this process) as well as for Markdown conversion. I hope that’s work we can share across a few people.
(Background is that I’m on vacation Sep 8–23. Will work during the time, but also need some time off, and may communicate with light delay. Therefore being upfront about this part, too.)
Charts in sheet look good to me. I'm able to help change them if you want a different format. I'm also able to help convert to Markdown.
