Interoperability 2022

[rviscomi]

Interoperability 2022

If you're interested in contributing to the Interoperability 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
@bkardell	@bkardell @meyerweb	@karlcow @foolip @miketaylr	@rviscomi @kevinfarrugia	-	@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 Interoperability 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-interop on Slack for team coordination

[bkardell]

Happy to be a co-author of this at least since it was my suggestion :)

[rviscomi]

Thanks @bkardell! Would you also be able to take on the content team lead role?

[bkardell]

Probably? Can we wait and see who else volunteers to make that decision?

[rviscomi]

Sounds good!

[meyerweb]

I’m willing to participate as a reviewer or co-author, depending on need. I don’t think I’m up for content lead on this one.

[karlcow]

Happy to review.

[miketaylr]

Interested in reviewing (and editing).

[bkardell]

I guess our biggest need is an analyst?

[foolip]

I can review. My first piece of feedback would be the name of the chapter, we've called the effort "Interop 2022" and have never expanded it to "Interoperability" in any of our comms about this, at least not that I've seen.

[rviscomi]

Thanks @foolip! The "2022" in the GitHub issue title is just to distinguish it from other annual versions of this chapter that may be to come. When published, "2022" will be implied by the annual edition of the Web Almanac. I think for the title of the chapter we would want to base it more on the concept of interoperability than a reference to the specific Interop 2022 program, and if we want to cover this topic next year, we would continue to call it "Interoperability" for consistency rather than "Interop 2023" which may or may not be a thing. If your feedback is also about interop vs interoperability, I'd prefer to write out the name in full for clarity, at least for the title.

That said, within the chapter I'd definitely encourage you all to reference the 2022 program or use the colloquial name however you see fit.

[siakaramalegos]

@bkardell I sent you an email to do a check-in - I know we're still waiting for some more volunteers but want to get y'all started so that doesn't hold you back. Let me know if you didn't get it.

[rviscomi]

Assigning @bkardell the lead author role after confirming via email. Thank you Brian! I'll leave it to you and @siakaramalegos to coordinate on the next steps for the chapter. (See the comment above about connecting, if you haven't already)

[foolip]

@rviscomi thanks for clarifying!

[rviscomi]

Hi @bkardell @meyerweb @karlcow @foolip @miketaylr just checking in. I see you're in need of an analyst, so I put my name down to ensure that we have a viable team for the chapter this year.

I see there's already some good progress in the planning doc but just as a reminder for anyone who hasn't yet contributed, we're hoping to have the outline completed by May 15, which should give us (me 😄) enough time to add any new instrumentation before the June crawl kicks off. Thanks!

[kevinfarrugia]

I'm still happy to contribute as analyst but would probably need your input @rviscomi since you worked a lot on the CSS chapters.

[rviscomi]

Thanks @kevinfarrugia! Happy to co-own the analysis with you.

[siakaramalegos]

@bkardell @meyerweb | @karlcow @foolip @miketaylr | @rviscomi @kevinfarrugia just a reminder that the outline is due in 2 days. It looks like none of you have added your name and email to the doc yet - please do that to confirm your participation. Thanks for all the drafting so far. Please finalize it before the deadline so there's enough time to write the custom queries. Thanks!

[siakaramalegos]

@bkardell 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!

[bkardell]

@bkardell 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!

Yes, sorry I just forgot to tick the box

[siakaramalegos]

Hi team Interop, how are things going on the analysis? What's the next step to get started? I see the drafted list of queries, and all of the data should be available now for you to both start and run the queries. Let me know if you need any help.

[siakaramalegos]

Hi @bkardell and @rviscomi just wanted to ping you again to see how things are going. It looks like you're still far behind so I'm starting to get worried that we won't hit the Aug 1 milestone. What's the plan at the moment?

[rviscomi]

@kevinfarrugia will be helping with the CSS-based analysis

[siakaramalegos]

He's also got 3 or 4 other chapters so I feel like that's a lot to put on him

[rviscomi]

So do I! 😄

[kevinfarrugia]

Yeah, me too. 😁

The other chapters are in a good state, for this one I need to catch up a bit on CSS-based queries. Will keep you posted.

[siakaramalegos]

@kevinfarrugia @rviscomi for the queries and analysis - can you give us an idea of % complete and timeline on the rest?

@bkardell when do you think you can begin the draft depending on when the analysis is ready? 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.

[siakaramalegos]

@bkardell @kevinfarrugia @rviscomi ditto the question from last week - can you write an update here? thanks

[bkardell]

We already have a bit more than an 'outline' in there, and I can start next week to fill in based on data coming available.

…

On Fri, Aug 19, 2022 at 2:03 PM Sia ***@***.***> wrote: @bkardell <https://github.com/bkardell> @kevinfarrugia <https://github.com/kevinfarrugia> @rviscomi <https://github.com/rviscomi> ditto the question from last week - can you write an update here? thanks — Reply to this email directly, view it on GitHub <#2887 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAGUQZICWBXNW4ZLMFNHSRTVZ7D63ANCNFSM5TH7Y2XA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Brian Kardell :: @briankardell :: bkardell.com

[siakaramalegos]

Just closing the loop, I think @rviscomi is under the impression all the data is done and ready for y'all. The two of you should connect if that's not the case. Thanks for the update!

[bkardell]

The chapter is drafted and partially reviewed. There's at least one item were waiting on some clarification and additional review eyes on before i mark that as complete, but i think for most intents and purposes we're in fair shape

[siakaramalegos]

@bkardell thanks for the update! I don't see a conclusion in the draft. When do you think that can be written and all the reviews finished and incorporated? We'd love to get this in the first round of publishing

[tunetheweb]

I've made the conversion of the chapter as it is to markdown in #3145

You can see a staged version here: https://20220922t161618-dot-webalmanac.uk.r.appspot.com/en/2022/interop

I know there's still some outstanding comments in the doc, and some things still under discussion, but can we move that discussion, and any suggestions to the GitHub issue now.

@bkardell I'll hand back this chapter to you to finish out now, and also leave you to do a sync of open issues from the Doc. Let me know when complete and will do a quick edit, but seems like that'll be pretty light from my quick read of this.