search

HTTPArchive / almanac.httparchive.org

HTTP Archive's annual "State of the Web" report made by the web community
https://almanac.httparchive.org
Apache License 2.0
611 stars 170 forks source link

Markup 2021 #2142

Closed rviscomi closed 2 years ago

rviscomi commented 3 years ago

Part I Chapter 3: Markup

Markup illustration

If you're interested in contributing to the Markup 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
@AlexLakatos @AlexLakatos @j9t @ibnesayeed @meyerweb @brycehowitson @kevinfarrugia @shantsis @rviscomi
Expand for more information about each role - The **[content team lead](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Content-Team-Leads'-Guide)** is the chapter owner and responsible for setting the scope of the chapter and managing contributors' day-to-day progress. - **[Authors](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Authors'-Guide)** 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](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Reviewers'-Guide)** are also subject matter experts and assist authors with technical reviews during the planning, analyzing, and writing phases. - **[Analysts](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Analysts'-Guide)** 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](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Editors'-Guide)** 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](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Section-Leads'-Guide)** 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](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Chapter-Lifecycle) doc.

Milestone checklist

0. Form the content team

1. Plan content

2. Gather data

3. Validate results

4. Draft content

5. Publication

Chapter resources

Refer to these 2021 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

j9t commented 3 years ago

Interested and available as a reviewer. (Co-author, too, on demand.)

rviscomi commented 3 years ago

Thanks @j9t! Added you as a reviewer.

tunetheweb commented 3 years ago

BTW we got a suggestion from @axelboc in #1954 which might be one to consider for this chapter:

I'd be interested to know the proportion of explicit vs. implicit labelling of form elements.

The presence of the for attribute on label elements would be a good first indicator. However, to go further, the query could check:

  • whether both explicit and implicit labelling are used together,
  • whether the IDs referenced in the for attributes actually exist,
  • what kind of labelable form elements are more likely to be explicitly vs implicitly labelled (or not labelled at all even?) - e.g. perhaps checkbox and radio buttons are more likely to be implicitly labelled for styling purposes?

Explicit vs. implicit labelling vs. both

rviscomi commented 3 years ago

📟 paging 2019/2020 contributors: @bkardell @zcorpan @tomhodgins @matthewp @catalinred @iandevlin @matuzo @Tiggerito

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?

Tiggerito commented 3 years ago

I don't have the time to give this year, but I could support a new Analyst in getting up to speed.

rviscomi commented 3 years ago

@meyerweb were you interested in being an author or reviewer of this chapter? Also pinged you in the CSS chapter, LMK if you'd be interested in either/both.

rviscomi commented 3 years ago

@jabranr were you interested in reviewing this chapter? (or JS/CSS)?

ibnesayeed commented 3 years ago

I can review this chapter!

matuzo commented 3 years ago

I’d love to contribute again, but unfortunately I don’t have the time this year.

jabranr commented 3 years ago

@jabranr were you interested in reviewing this chapter? (or JS/CSS)?

@rviscomi I can go for JS/CSS ones.

tomhodgins commented 3 years ago

I'm curious/willing to help with a CSS chapter in whatever way helps!

Cheers, Tommy

On May 7, 2021, at 1:39 PM, Jabran Rafique⚡️ @.***> wrote:

@jabranr https://github.com/jabranr were you interested in reviewing this chapter? (or JS/CSS)?

@rviscomi https://github.com/rviscomi I can go for JS/CSS ones.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/HTTPArchive/almanac.httparchive.org/issues/2142#issuecomment-834645827, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAHJJULL7GQTBJ63XG6NM7DTMQQTXANCNFSM43UFMHVQ.

meyerweb commented 3 years ago

Sorry for the delay. I can definitely commit to being a reviewer for Markup as well as CSS. Still running the idea of authoring past my team at work.

rviscomi commented 3 years ago

I can go for JS/CSS ones.

@jabranr ok great! Could you comment on the JS and/or CSS issues for whichever you're interested in?

I'm curious/willing to help with a CSS chapter in whatever way helps!

@tomhodgins great! Could you reply to the CSS issue and indicate whether you're interested in authoring/reviewing/analyzing?

Sorry for the delay. I can definitely commit to being a reviewer for Markup as well as CSS. Still running the idea of authoring past my team at work.

@meyerweb per our Slack chat, I'll add you as a reviewer here and content team lead (author) for the CSS chapter. Great to have you!

rviscomi commented 3 years ago

@j9t if no one else is interested, would you be willing to take on the content team lead and author roles for this chapter?

j9t commented 3 years ago

Hi @rviscomi—I’d love to, alas I won’t have the bandwidth this year. I’m happy to go beyond reviewing though, to assist the chapter lead as much as I can.

brycehowitson commented 3 years ago

I'd help as a reviewer or contribute where I can (Markup or CSS). Though I hesitate to take a huge role as I'm new to the process/time commitments.

rviscomi commented 3 years ago

Welcome @brycehowitson! I've added you as a reviewer for the Markup chapter. As we continue looking for a lead for the team, you can get started by requesting edit access to the draft doc and adding your ideas.

tunetheweb commented 3 years ago

Any interest @matuzo ?

AlexLakatos commented 3 years ago

Just saw the tweet, I'd be happy to take on the author slot.

rviscomi commented 3 years ago

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

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!

shantsis commented 3 years ago

Any room for an editor in this chapter? 🙂

rviscomi commented 3 years ago

Absolutely, thanks for your interest @shantsis! I'll add your name to the Editor role.

FYI editing won't start until after Milestone 3 has been completed and the chapter is drafted. Do you have any interest in getting involved sooner during the content planning going on now? If so I can also add you as a reviewer. (The difference between reviewer and editor is that reviewers are involved in content planning and give technical feedback while editors focus more on the quality of writing and give non-technical feedback)

shantsis commented 3 years ago

Absolutely, thanks for your interest @shantsis! I'll add your name to the Editor role.

FYI editing won't start until after Milestone 3 has been completed and the chapter is drafted. Do you have any interest in getting involved sooner during the content planning going on now? If so I can also add you as a reviewer. (The difference between reviewer and editor is that reviewers are involved in content planning and give technical feedback while editors focus more on the quality of writing and give non-technical feedback)

I’m good for editing thanks

AlexLakatos commented 3 years ago

@AlexLakatos thanks for your interest in authoring this chapter!

Thanks!

Next steps for this chapter are:

* Due **May 31**: Complete [Milestone 0: Form the content team](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Chapter-Lifecycle#0-create-content-team) to **find an analyst** and add any additional coauthors/reviewers as needed

It looks like we've got quite a few reviewers, which is great! But this is an awfully short deadline, how / where do I find a willing analyst? Do I comment in #2193 and hope for the best?

matuzo commented 3 years ago

Any interest @matuzo ?

Unfortunately I wouldn't find enough time this year to do the job properly, but maybe next year. :)

kevinfarrugia commented 3 years ago

Hi all. I can join the chapter as analyst. This is my first time contributing so I'll be learning along the way. I have gone through last year's queries for the Markup chapter and I expect we would be reusing most of these this year too. Are there any custom metrics which you would like to include?

rviscomi commented 3 years ago

Great news, thanks for stepping up @kevinfarrugia! Feel free to join the #web-almanac-analysts channel on Slack to chat with other analysts and get help as needed. @paulcalvano leads the Analysts team and can get you set up with dataset access and answer any other questions.

@AlexLakatos that takes care of Milestone 0, you can go ahead and check that off now.

Tiggerito commented 3 years ago

@kevinfarrugia I was last years analyst. I'm happy to answer any questions you have. It was also my first time last year.

AlexLakatos commented 3 years ago

Amazing! Thanks @kevinfarrugia for stepping in! @Tiggerito appreciate the help!

kevinfarrugia commented 3 years ago

@AlexLakatos do you need any input from my end ahead of the deadline for the custom metrics please?

rviscomi commented 3 years ago

@AlexLakatos @j9t @ibnesayeed @meyerweb @brycehowitson @kevinfarrugia to Kevin's point, the outline in the chapter doc hasn't been started yet. It's up to the authors/reviewers to brainstorm topics to discuss in the chapter, which will give analysts (Kevin) guidance for what data needs to be prepared. Everyone should have edit access to the doc (request it in the doc if not) so you can start adding your thoughts/suggestions. For reference here was last year's Markup chapter doc.

The deadline for completing the outline is June 15 so that there's time to make any changes to the test infrastructure. Missing this deadline may mean that you won't have access to new metrics.

j9t commented 3 years ago

If it’s helpful, last year I took the previous year’s structure to build the chapter outline, to complement it by input by the group. That worked well to be fast but also make sure we didn’t miss anything major.

ibnesayeed commented 3 years ago

I have been busy lately, but now catching up. I have requested access to the docs and will provide feedback about the outline as authors put things together.

tunetheweb commented 3 years ago

Interesting discussion here you might want to consider as incorrect markup: https://twitter.com/therealnooshu/status/1404356341297303555?s=21

AlexLakatos commented 3 years ago

@j9t @ibnesayeed @meyerweb @brycehowitson @kevinfarrugia @shantsis @rviscomi: I've created a tentative outline in the working doc, I'd love to get your feedback on it. It's retained most of the sections from last year, with a few extras sprinkled in. I'm conscious of not stepping too much in other chapters territory, so some of those new sections might only get a shallow mention.

I'd also love if we could show most of the data in there compared to 2019 and 2020 where it makes sense, I'd love to know which of those metrics we don't have to structure the sections accordingly (probably all the new ones).

rviscomi commented 3 years ago

Looks good thanks @AlexLakatos. Please check off Milestone 1 above when you're feeling comfortable with the outline.

@kevinfarrugia there may be new topics in the outline that depend on custom metrics, so please give it a close look to see if there's anything we need to add to the test pipeline. Refer to the 2020 chapter's custom metrics to see what's currently implemented and don't be afraid to take @Tiggerito up on his offer to answer any questions!

kevinfarrugia commented 3 years ago

I will be going through the outline and reviewing the custom metrics at the end of this week or the start of the next. Will let you know if I have any queries. Thanks

kevinfarrugia commented 3 years ago

@AlexLakatos I have tagged you on the Google Doc (sorry for the spam) as there are a number of pending queries from my end please.

AlexLakatos commented 3 years ago

I think I got to all of them now, let me know if you need more info!

j9t commented 3 years ago

@AlexLakatos, not to give you a feeling you’ve been abandoned—anything our group of reviewers can do or help with at the moment?

kevinfarrugia commented 3 years ago

An update from my end too that I'm going through the queries and will have some updates in the next few days.

kevinfarrugia commented 3 years ago

I have started putting some of the data in a Google Sheet and will be updating the PR once I clean up some unused queries. Early feedback is welcome.

Edit: updated link

rviscomi commented 3 years ago

Thanks for the update @kevinfarrugia! @AlexLakatos have you had a chance to start reviewing the results?

AlexLakatos commented 3 years ago

Not yet, but I think I'll get to them this week.

j9t commented 3 years ago

Hi @AlexLakatos, is there something the reviewers can currently do? Would we have a few days to go over the material; anything else that could be good for you and for us as reviewers?

kevinfarrugia commented 2 years ago

Hi @AlexLakatos how's it coming along? Do you need my input on any of the queries or results?

AlexLakatos commented 2 years ago

@kevinfarrugia It's coming slower than I anticipated, but I hope to finish this weekend. Most queries were straightforward. I could use a second pair of eyes on the "Compression" section. I used filtering on the "content_encoding" sheet to come up with the data, I could use someone double-checking if that's the right way to do it.

kevinfarrugia commented 2 years ago

I created a pivot table for the content_encoding sheet and a bar chart. I'm not sure if that's what you want to show. Let me know if that helps you.

content_encoding desktop mobile
gzip 62.85% 63.84%
br 21.75% 21.93%
  15.26% 14.11%
deflate 0.10% 0.10%

Content encoding

AlexLakatos commented 2 years ago

@kevinfarrugia That's better than what I had in mind, thanks!

rviscomi commented 2 years ago

@AlexLakatos how's it going? Looks like there's still a lot of writing to go. Are you mostly blocked on the data visualization part? Let me know if I can help with that.

Given the short time remaining it's highly likely that this chapter will not be fully written/reviewed/edited in time for the November 15 milestone, so let's start thinking about a more realistic timeline. @AlexLakatos can you commit to having the first draft ready for review by the 15th? We can give the reviewers a week to submit their feedback and get it resolved. That leaves only a few days to get the markdown into shape before publication. I can't guarantee that we'll have time for a formal editing pass before that though, so it may have the scarlet "unedited" badge initially, but the most important thing is to get the chapter out there for the rush of traffic after launch. So the timeline would be:

November 15: @AlexLakatos finishes the first draft (ideally straight to markdown to save time) November 22: @j9t @ibnesayeed @meyerweb @brycehowitson finish their review November 24: @AlexLakatos resolves all reviewer feedback and submits the markdown PR (Editing if possible) December 1: Launch