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

Jamstack 2021 #2156

Closed
6 tasks done
rviscomi opened this issue Apr 27, 2021 · 38 comments · Fixed by #2634
Closed
6 tasks done

Jamstack 2021 #2156

rviscomi opened this issue Apr 27, 2021 · 38 comments · Fixed by #2634
Assignees
Labels
2021 chapter Tracking issue for a 2021 chapter

Comments

@rviscomi
Copy link
Member

rviscomi commented Apr 27, 2021

Part III Chapter 18: Jamstack

Jamstack illustration

If you're interested in contributing to the Jamstack 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
@denar90 @denar90 @thomkrupa @mor10 @satpras @ahmadawais @Dawntraoz @ianand @denar90 @RMHolmlund @logicalphase
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 31: The content team has at least one author, reviewer, and analyst

1. Plan content

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

2. Gather data

  • June 30: Analysts have added all necessary custom metrics and drafted a PR (example) to track query progress
  • July 1 - 31: HTTP Archive runs the July crawl

3. Validate results

  • September 30: Analysts have queried all metrics and saved the output to the results sheet

4. Draft content

  • October 31: The content team has written, reviewed, and edited the chapter in the doc

5. Publication

  • November 15: The completed chapter and all required metadata and figures are converted to markdown and submitted to GitHub
  • December 1: Target launch date 🚀

Chapter resources

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

@rviscomi rviscomi added 2021 chapter Tracking issue for a 2021 chapter help wanted Extra attention is needed labels Apr 27, 2021
@mor10
Copy link

mor10 commented Apr 27, 2021

I'd like to join the jAMSTACK team as a reviewer. I can't dedicate enough time to do the authoring job.

@rviscomi
Copy link
Member Author

Yay welcome @mor10 great to have you!

@satiyap
Copy link

satiyap commented Apr 30, 2021

I would like to join the team as a reviewer

@rviscomi rviscomi added help wanted: coauthors This chapter is looking for coauthors help wanted: analysts This chapter is looking for data analysts labels May 4, 2021
@rviscomi
Copy link
Member Author

rviscomi commented May 5, 2021

📟 paging 2020 contributors: @phacks @MaedahBatool @denar90 @remotesynth

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?

@phacks
Copy link

phacks commented May 7, 2021

I would have loved to, but I don’t think I’ll have the time to get involved this year.

@phacks
Copy link

phacks commented May 7, 2021

I’d like to suggest @thomkrupa though! He’s the co-founder and CTO of Bejamas, where they extensively work with (and write about!) the Jamstack

@rviscomi
Copy link
Member Author

⚠️ Still looking for more contributors to make this chapter viable, specifically authors and analysts. If we're unable to staff the chapter by May 31 we may have to close it and focus our efforts on other chapters.

@thomkrupa let us know if you're interested or can recommend anyone else!

@rviscomi rviscomi mentioned this issue May 11, 2021
6 tasks
@logicalphase
Copy link
Contributor

Just a quick hello to team Jamstack! I know there's some spots left to fill, and I've put out some requests for assistance for that. My job is to help keep the chapter on track, and help you in anyway I can. So please reach out and thank you for making the next release the best ever.

@denar90
Copy link
Member

denar90 commented May 12, 2021

hey hey 👋
I'd really want to have a chapter about Jamstack on HTTParchive. We have a lot of interest from folks in different communities (JamstackTORONTO, JAMstack Boston)who eager to hear about numbers on meetups.
If there's still a spot for writers I'd be happy to write about Jamstack this year.
We have queries from last year so after improvements they can be easily done, last year when we had to write them from scratch, so I hope we can simplify effort in this area.

@thomkrupa
Copy link

hey, @rviscomi I can help with writing or reviewing.

@rviscomi
Copy link
Member Author

@denar90 are you able to take the lead author position as well as the analyst position for this chapter? Sounds like @thomkrupa is willing to help coauthor if needed.

@logicalphase
Copy link
Contributor

@thomkrupa I went ahead and added you in as an author. Really thankful for the help. Please let me know if I can assist while we finalize. Cheers

@denar90
Copy link
Member

denar90 commented May 14, 2021

@rviscomi yeah, that would be awesome. @thomkrupa let's rock!

@rviscomi rviscomi removed help wanted Extra attention is needed help wanted: analysts This chapter is looking for data analysts help wanted: coauthors This chapter is looking for coauthors labels May 14, 2021
@rviscomi
Copy link
Member Author

rviscomi commented May 14, 2021

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

@logicalphase is the section coordinator for this chapter and they'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!

@rviscomi rviscomi added the ASAP This issue is blocking progress label Jun 23, 2021
@mor10
Copy link

mor10 commented Jun 23, 2021

I made a #web-almanac-jamstack channel on HTTP Archive Slack to get it started. Makes sense to keep the conversation under a joint Slack so history is preserved and other HTTP Archive contributors can jump in.

@denar90
Copy link
Member

denar90 commented Jun 23, 2021

Cool, folks! That's even better. Thank you 🙏

@denar90
Copy link
Member

denar90 commented Jul 5, 2021

Reviewers, if you have no access to the article, please, request it and add your names/emails so we can fill blank spots and get your feedback

cc @mor10 @satpras @ahmadawais @Dawntraoz @ianand

thanks 🙏

@mor10
Copy link

mor10 commented Aug 9, 2021

What's the status on this project now?

@rviscomi
Copy link
Member Author

@mor10 just posted a project update to the GitHub team page: https://github.com/orgs/HTTPArchive/teams/2021-web-almanac/discussions/8

@foxdavidj
Copy link
Contributor

@denar90 Can you create a PR to track the progress of what queries need to be written? Similar to this one for the PWA chapter

Then we can also tick off that "Gather data" checkbox

@rviscomi
Copy link
Member Author

⚠️ @denar90 can you create the draft PR to list all of the queries you'll need? That milestone was due June 30 so this chapter is at risk of slipping. The upcoming milestone to run all of the queries will be wrapping up at the end of the month and I just want to make sure we'll be able to launch on time. Let us know if you run into any blockers and we'll do our best to help!

@denar90 denar90 mentioned this issue Sep 28, 2021
10 tasks
@denar90
Copy link
Member

denar90 commented Sep 28, 2021

I've sent draft PR.

@rviscomi
Copy link
Member Author

Thank you! Great to see the progress.

@logicalphase
Copy link
Contributor

Thanks very much @denar90 !

@logicalphase
Copy link
Contributor

Hey @denar90, is there anything I can do to assist you on outstanding tasks. Please let me know as we're quickly running short on time. Thanks very much.

@rviscomi rviscomi removed the ASAP This issue is blocking progress label Oct 14, 2021
@rviscomi
Copy link
Member Author

⛔ Hi @denar90 the draft is empty in the doc so it's not looking like this chapter will be able to launch on time. Are you still able to commit to writing the chapter? If so we should come up with a more realistic timeline to have something ready by launch day. Let me know if this works for you:

  1. Complete a rough draft by Monday, November 15, written directly in markdown and a PR opened on GitHub.
  2. Assign the PR to your reviewers (@mor10 @satpras @ahmadawais @Dawntraoz @ianand) who will have until Monday, November 22 to leave comments on the PR.
  3. Resolve all feedback and finalize any outstanding figures by Monday, November 29.
  4. Add the chapter to the editing queue and launch on Wednesday, December 1, most likely in an unedited state.
  5. Editors will send you a PR close to or after launch to finalize the chapter.

Does that sound doable? It's a very tight schedule but we don't have many other options at this late stage.

@rviscomi
Copy link
Member Author

📟 Paging reviewers: @mor10 @satpras @ahmadawais @Dawntraoz @ianand

The Jamstack draft is ready for your review. This is a big request, but given that we're only days away from launch, if you have the availability to give it a look and submit your feedback this weekend, that will help us be able to release the chapter on time.

@rviscomi
Copy link
Member Author

rviscomi commented Dec 1, 2021

@denar90 @thomkrupa @mor10 @satpras @ahmadawais @Dawntraoz @ianand @RMHolmlund

🎉 This chapter is fully written, reviewed, edited, and ready to be launched on Wednesday! Thank you to all of the contributors who put in the time and effort to make this a great chapter.

When you get 5 minutes, I'd really appreciate if you could fill out our contributor survey to tell us (the project leads) about your experience. It's super helpful to hear what went well or what could be improved for next time. 🙏

Congratulations and thank you all again. I'm excited for this to launch soon!

@Dawntraoz
Copy link

@denar90 @thomkrupa @mor10 @satpras @ahmadawais @Dawntraoz @ianand @RMHolmlund

🎉 This chapter is fully written, reviewed, edited, and ready to be launched on Wednesday! Thank you to all of the contributors who put in the time and effort to make this a great chapter.

Congratulations and thank you all again. I'm excited for this to launch soon!

So happy to read this 🎉

Congrats everyone for getting it done in record time and special kudos to @denar90 and @tunetheweb for their commitment 💖

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2021 chapter Tracking issue for a 2021 chapter
Projects
None yet
Development

Successfully merging a pull request may close this issue.

10 participants