Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CSS 2022 #2879

Closed
6 tasks done
rviscomi opened this issue Apr 12, 2022 · 33 comments · Fixed by #3140
Closed
6 tasks done

CSS 2022 #2879

rviscomi opened this issue Apr 12, 2022 · 33 comments · Fixed by #3140
Assignees
Labels
2022 chapter Tracking issue for a 2022 chapter ASAP This issue is blocking progress
Projects

Comments

@rviscomi
Copy link
Member

rviscomi commented Apr 12, 2022

CSS 2022

CSS illustration

If you're interested in contributing to the CSS 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
@rachelandrew @rachelandrew @j9t @meyerweb @svgeesus @rviscomi @dereknahman @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

  • May 1: The content team has at least one author, reviewer, and analyst

1. Plan content

  • May 15 The content team has completed the chapter outline in the draft doc

2. Gather data

  • 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

  • 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 CSS 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-css on Slack for team coordination

@rviscomi rviscomi added 2022 chapter Tracking issue for a 2022 chapter help wanted Extra attention is needed labels Apr 12, 2022
@rviscomi rviscomi added this to the 2022 Content Planning milestone Apr 12, 2022
@rachelandrew
Copy link
Contributor

As discussed, happy to be an author for CSS.

@rviscomi rviscomi added this to TODO in 2022 via automation Apr 12, 2022
@rviscomi rviscomi moved this from TODO to In Progress in 2022 Apr 12, 2022
@rviscomi
Copy link
Member Author

Yes thank you @rachelandrew! I've added you to the roster above and added myself as an analyst. A few formalities...

As the content team lead you'll be ultimately responsible for setting the narrative for the chapter, keeping it on schedule, and coordinating with the rest of the content team. A coordinator will be assigned to this chapter to help with any process/logistical questions, but you can always reach out to me if anything comes up.

The contributor roster and milestone checklist above are this chapter's source of truth for how it's progressing. We use automation to monitor all chapters at a glance, so please try to keep these sections up to date as best you can.

The chapter resources section above contains a few canonical links unique to this chapter. These are the shared resources that you and your content team can use to coordinate throughout the project, including a Google Doc for planning and drafting content and a Google Sheet for analyzing the results.

Thanks again, looking forward to collaborating on this chapter with you!

@j9t
Copy link
Member

j9t commented Apr 13, 2022

Happy to review.

@meyerweb
Copy link
Member

Offering myself as a reviewer.

@svgeesus
Copy link
Contributor

Happy to review again this year

@dereknahman
Copy link

Hello! I'd like to register my interest for the Editor role. I have previous lives in Editorial Management and writing for trade news outlets before I became a dev, so I think I can be of some use to this project.

@rviscomi
Copy link
Member Author

rviscomi commented May 6, 2022

Welcome @dereknahman! I've added you as the Editor for this chapter.

@rachelandrew @j9t @meyerweb @svgeesus @dereknahman could you all make sure you have access to the planning doc and start adding content to the outline? What topics would you like to see covered this year; what's new or what should we revisit from previous years? We're hoping to have the outline completed by May 15, to give us time to add any required custom metrics to the crawl before it starts on June 1. Thanks!

@svgeesus
Copy link
Contributor

I have access to the planning doc

@svgeesus
Copy link
Contributor

For comparison, here is the 2021 planning doc and results sheet

@rachelandrew
Copy link
Contributor

I've added an outline, mostly based on last year so we can do comparisons year on year, with a few extras, things that have landed this year. Please add any additions, I'm also going to run this by a few folks outside of the team who might have opinions on specific bits of CSS!

@siakaramalegos
Copy link
Member

@j9t @meyerweb @svgeesus 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 Rachel started. The outline is due in 2 days and she will need time to incorporate your feedback. Thanks!

@siakaramalegos
Copy link
Member

@rachelandrew and team, is the outline complete? The deadline was May 15. We now have less than 2 weeks to finalize any custom metrics so getting to outline completion is critical. When it's complete, please check the milestone off. Thanks for your contributions!

@svgeesus
Copy link
Contributor

Is it possible to add another metric for this year? Recent discussions in CSS WG considered allowing mixed percentages and numbers in color functions (til now, you needed either three percentages or three numbers for the likes of rgb() or color(). The big unknown is:

whether there are currently usages of number and percentage mixtures (that currently break but would work after that change and cause a visual difference)

So this is a "how badly would we break the Web if we made this change and caused these to be accepted" query.

@svgeesus
Copy link
Contributor

@rachelandrew I was looking at the draft doc just now and see some unanswered questions. I helped with some but I think most are directed at yourself.

@rviscomi
Copy link
Member Author

Thanks for the clarifications @svgeesus!

General update for all, especially @rachelandrew: the underlying parsed_css table on which most of this chapter's queries are based still needs to be generated. I'm having trouble with "out of memory" errors in BigQuery when I try to generate it and looking into options to either fix it or work around it. I'll update the team when the data is available and I'm able to start getting results into the spreadsheet.

@rviscomi
Copy link
Member Author

rviscomi commented Jun 21, 2022

Is it possible to add another metric for this year? Recent discussions in CSS WG considered allowing mixed percentages and numbers in color functions (til now, you needed either three percentages or three numbers for the likes of rgb() or color().

@svgeesus I'm happy to decouple that question from the Almanac analysis and share the results with the CSS WG as soon as the data is available (or use 2021 data, assuming freshness isn't a huge concern). I'll defer to @rachelandrew as content team lead to decide if the data is generally interesting enough to include in the chapter.

@svgeesus
Copy link
Contributor

@svgeesus I'm happy to decouple that question from the Almanac analysis and share the results with the CSS WG as soon as the data is available

Fantastic. Yes, better to decouple. I wondered if it might be interesting enough to discuss in the chapter, depends on what we find.

@siakaramalegos
Copy link
Member

@rviscomi it looks like the analysis is almost complete - can you give us an idea of % complete and timeline on the rest?

@rachelandrew 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.

@rviscomi rviscomi removed the help wanted Extra attention is needed label Aug 13, 2022
@rviscomi
Copy link
Member Author

I've just merged the analysis PR with 68 of 73 metrics. Their results are available in the spreadsheet. Sorry for the delay, everyone.

The remaining metrics have open questions in the draft doc. If we can get those addressed, I'll follow up with the additional queries/results.

@rachelandrew @j9t @meyerweb @svgeesus let me know if any of the results look off.

Over to @rachelandrew to start the draft of the chapter.

@rachelandrew
Copy link
Contributor

thanks @rviscomi I'll go through those questions today.

@rviscomi
Copy link
Member Author

Thanks for following up on those open questions @rachelandrew. I've implemented the remaining queries and saved their results to the sheet. Back over to you.

@siakaramalegos
Copy link
Member

Haven't seen any updates in the draft doc so just wanted to ping again @rachelandrew when do you think you can begin the draft? What's the plan for completing it? THanks

@siakaramalegos
Copy link
Member

@rachelandrew great job starting the draft - when do you think it will be ready for review? We only have 4 days left for the review and editing cycles, and the reviewers need some time (cc @j9t @meyerweb @svgeesus)

@rachelandrew
Copy link
Contributor

@j9t @meyerweb @svgeesus @siakaramalegos I should be finished a first pass this weekend but feel free to follow me down the doc (right now I've just finished feature queries). I've a few comments where I've called out interesting looking things, or places where I don't understand where the change might have come from. I'd appreciate eyes on color in particular as that's not my area of knowledge.

I need to do things like add figure captions, an intro and so on, but I'll do those when I do my second pass, so don't worry about missing stuff like that.

@rachelandrew
Copy link
Contributor

@j9t @meyerweb @svgeesus @siakaramalegos I've got through all the sections, there are a few to dos, I need to write an intro and conclusion. But PTAL, and I'll follow up in a day or so, and tidy up.

@j9t
Copy link
Member

j9t commented Aug 28, 2022

(On it—need a few days to read through but will give feedback asap.)

@siakaramalegos
Copy link
Member

I haven't seen much change since last week and we're past the deadline now. What's the plan to get the draft completed, reviewed, and comments incorporated @rachelandrew ? (cc @j9t @meyerweb @svgeesus)

@rviscomi rviscomi added the ASAP This issue is blocking progress label Sep 3, 2022
@rachelandrew
Copy link
Contributor

@siakaramalegos sorry for the delay in wrapping up, I really can only work on this at the weekend. Other than a couple of small comments this is done from my point of view. I'll have a look tomorrow in case anything else comes in.

@svgeesus
Copy link
Contributor

svgeesus commented Sep 3, 2022

This looks to be in good shape to me. I made whatever comments seemed appropriate so my review is essentially complete but I will keep checking back if there are new comments or changes.

@svgeesus
Copy link
Contributor

svgeesus commented Sep 3, 2022

I'd appreciate eyes on color in particular as that's not my area of knowledge.

Naturally that was where I started reading and I don't have any more suggestions to add in that area. Web-in-the-wild is very conservative and a bit cargo-cultish so naturally we see very little uptake of newer color stuff (even of hsl!!) though that might change if Interop-2022 bears fruit but meanwhile the color situation is "same as last year pretty much".

@siakaramalegos
Copy link
Member

@rachelandrew looks good to me other than one table that will probably be too small to be readable on the web layout - I noted it in Slack since I didn't have access already to comment in the doc.

It sounds like it's ready for edit @dereknahman. When do you think you can take a look?

@dereknahman
Copy link

dereknahman commented Sep 9, 2022 via email

@rviscomi
Copy link
Member Author

No worries @dereknahman. I'll start the markdown conversion now and I can take care of the editing in the process.

@rviscomi rviscomi mentioned this issue Sep 20, 2022
5 tasks
2022 automation moved this from In Progress to Done Sep 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2022 chapter Tracking issue for a 2022 chapter ASAP This issue is blocking progress
Projects
2022
Done
Development

Successfully merging a pull request may close this issue.

7 participants