Markup 2024

[nrllh]

Markup 2024

If you're interested in contributing to the Markup chapter of the 2024 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. You might be interested in exploring the changes to this year's version here.

Content team

Lead	Authors	Reviewers	Analysts	Editors	Coordinator
@guaca	@guaca	@j9t, @zcorpan, @bkardell	@guaca	-	@turban1988

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

• 📆 April 15 Complete program and content committee - 🔑 Organizing committee
  • The content team has at least one author, reviewer, and analyst.

1. Plan content

• 📆 May 1 First meeting to outline the chapter contents - 🔑 Content team
  • The content team has completed the chapter outline.

2. Gather data

• 📆 June 1 Custom metrics completed - 🔑 Analysts
  • Analysts have added all necessary custom metrics and drafted a PR (example) to track query progress.
• 📆 June 1 HTTP Archive Crawl - 🔑 HA Team
  • HTTP Archive runs the June crawl.

3. Validate results

• 📆 August 15 Query Metrics & Save Results - 🔑 Analysts
  • Analysts have queried all metrics and saved the output.

4. Draft content

• 📆 September 15 First Draft of Chapter - 🔑 Authors
  • Authors has written the chapter.
• 📆 October 10 Review & Edit Chapter - 🔑 Reviewers & Editors
  • Reviewers and Editors has processed the the chapter.

5. Publication

• 📆 October 15 Chapter Publication (Markdown & PR) - 🔑 Authors
  • Authors has converted the chapter to markdown and drafted a PR.
• 📆 November 1 Launch of 2024 Web Almanac 🚀 - 🔑 Organizing committee

6. Virtual conference

• 📆 November 20 Virtual Conference - 🔑 Content Team

Chapter resources

Refer to these 2024 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
💻 Collab notebook for collaborative coding in Python - if needed
💬 #web-almanac-markup on Slack for team coordination

[nrllh]

Hey @AlexLakatos @ibnesayeed @daKmoR @zcorpan @bkardell - awesome contributors from previous years 🙂 Are you interested in joining us again this year?

[zcorpan]

I can help as a reviewer.

[nrllh]

Thank you, @zcorpan!

[guaca]

Hi there! Happy to join as an author and/or analyst 😃

[j9t]

@guaca, do you have everything you need or is there anything the rest of the team can do at the moment?

Also, will you communicate major updates here, or are there other channels to monitor for us? Just to avoid missing anything as I’m not currently monitoring the HTTP Archive’s Slack channels.

[bkardell]

I'm also happy to be a reviewer if you still need something.

[guaca]

Hello everyone! I am still finalizing some queries but have already started writing the chapter. Should be on track to be reviewed by the planned date (October 1st).

[guaca]

Hi @j9t , @zcorpan @bkardell

The chapter is ready for review. Please, feel free to add your comments and suggestions directly as comments in the document (you may need to ask @nrllh for the proper doc permissions).

Thanks!

[j9t]

Nice work, @guaca! I’ve done a first quick run and left a few comments. Will do another run at a later draft stage, too.