foxdavidj commented 4 years ago

Part III Chapter 15: CMS

Content team

Authors	Reviewers	Analysts	Draft	Queries	Results
@alexdenning	@sirjonathan @ernee @amedina	@GregBrimble @rviscomi	Doc	*.sql	Sheet

Content team lead: @alexdenning

Welcome chapter contributors! You'll be using this issue throughout the chapter lifecycle to coordinate on the content planning, analysis, and writing stages.

The content team is made up of the following contributors:

New contributors: If you're interested in joining the content team for this chapter, just leave a comment below and the content team lead will loop you in.

Note: To ensure that you get notifications when tagged, you must be "watching" this repository.

Milestones

0. Form the content team

[x] Jul 6th: Project owners have selected an author to be the content team lead
[x] Jul 13th: The content team has at least one author, reviewer, and analyst (minimally viable team formed)

1. Plan content

[x] Jul 20th: The content team has completed the chapter outline in the draft doc
[x] Jul 27th: Analysts have triaged the feasibility of all proposed metrics

2. Gather data

[x] Jul 27th: Analysts have added all necessary custom metrics and drafted a PR to track query progress
Aug 1 - 31: August crawl
[x] Sep 7th: Analysts have queried all metrics and saved the output to the results sheet

3. Validate results

[x] Sep 14th: The content team has reviewed the results sheet

4. Draft content

[x] Nov 12th: Authors have completed the first draft in the doc
[x] Nov 26th: The content team has prototyped all data visualizations

5. Publication

[x] Nov 26th: The content team has reviewed the final draft, converted to markdown, and filed a PR to add it to the 2020 content directory
Dec 9th: Target launch date

ernee commented 4 years ago

Some updates on the nomination front for the CMS chapter. @sirjonathan and myself are interested in contributing to the chapter again this year as reviewers. Potential nominees for authors are not available to contribute this year, so there is a need for an author or co-authors.

rviscomi commented 4 years ago

Thank you @ernee! I've added you both to the reviewers list. We'll continue to look for a lead author.

sirjonathan commented 4 years ago

I’m interested as a potential lead author. I’d need to evaluate it a bit more closely to see if I can make the commitment.

When is the deadline?

Also, if you find a strong lead you’re happy with don’t hesitate to move forward.

On Thu, Jul 2, 2020 at 10:11 AM Rick Viscomi notifications@github.com wrote:

Thank you @ernee https://github.com/ernee! I've added you both to the reviewers list. We'll continue to look for a lead author.

— 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/915#issuecomment-653125765, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAZNVMJP2RWDXTBFNL2F4TRZS5T5ANCNFSM4OJ2CVWA .

-- Jonathan Wold | Automattic | Mobile: +1 530-416-2216 Community Lead for WooCommerce

rviscomi commented 4 years ago

@sirjonathan we're hoping to have the content team nailed down by the end of the week. Alternatively, feel free to @ anyone else in the CMS space that you think might be good candidates to author this chapter.

sirjonathan commented 4 years ago

OK, perfect. I'm asking around, I have a few ideas.

And once you've got the authors lined up, what's the actual publishing timeline?

On Tue, Jul 7, 2020 at 10:01 AM Rick Viscomi notifications@github.com wrote:

@sirjonathan https://github.com/sirjonathan we're hoping to have the content team nailed down by the end of the week. Alternatively, feel free to @ anyone else in the CMS space that you think might be good candidates to author this chapter.

— 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/915#issuecomment-654997175, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAZNVMCSPJJD7TTQFEIQYTR2NIGDANCNFSM4OJ2CVWA .

rviscomi commented 4 years ago

Thanks! The milestones in the top comment and the chapter lifecycle doc give a good overview of the timeline.

sirjonathan commented 4 years ago

I just connected with Alex Denning and he's interested! I'll send him to this thread to read up and follow-up accordingly.

alexdenning commented 4 years ago

Hi! @sirjonathan pinged me about this, and I'm keen to be involved! I had a read through the docs and looks good. For a bit of context this is me: https://twitter.com/AlexDenning

foxdavidj commented 4 years ago

@alexdenning thank you for agreeing to be the lead author for the CMS chapter! As the lead, you'll be responsible for driving the content planning and writing phases in collaboration with your content team, which will consist of yourself as lead, any coauthors you choose as needed, peer reviewers, and data analysts.

The immediate next steps for this chapter are:

Establish the rest of your content team. Several other people were interested or nominated (see below), so that's a great place to start. The larger the scope of the chapter, the more people you'll want to have on board.
Start sketching out ideas in your draft doc.
Catch up on last year's chapter and the project methodology to get a sense for what's possible.

There's a ton of info in the top comment, so check that out and feel free to ping myself or @rviscomi with any questions!

@sirjonathan @ernee I've put you down as reviewers for now, and will leave it to @alexdenning to reassign at their discretion

alexdenning commented 4 years ago

@obto many thanks! I'm at capacity this week, so I'll dig into this properly next week and start making some progress then.

foxdavidj commented 4 years ago

Hey @alexdenning, hope you had a great weekend :)

As you know, we're tying to have the outline and metrics settled on by the end of the week so we have time to configure the Web Crawler to track everything you need. So is there anything you need from me to keep things moving forward?

Also, can you remind your team to properly add and credit themselves in your chapter's Google Doc?

alexdenning commented 4 years ago

Heya @obto cheers – I will review properly later today and get back to you :)

alexdenning commented 4 years ago

okey, following up on this. A couple of things I need to double check and confirm:

@obto are you the person whom I can ask these questions?
"Team" is @sirjonathan @ernee yes? If yes, could you both of you add your details here? https://docs.google.com/document/d/1XL87z5MOk7QDLhpFsaMWT3DaIXdOQV32qs57noGwDVQ/edit
Are we expecting to use this issue for all our comms?
To what extent is this chapter going to be an update on last year vs new takes? I understand you're to some extent looking to me to define that; would be good to get more of an idea of what's possible.
Who's "owning" project management?

Thanks :)

foxdavidj commented 4 years ago

@obto are you the person whom I can ask these questions?

Yup!

"Team" is @sirjonathan @ernee yes?

Yes. And please feel free to recruit others you'd like to work together with on this chapter

Are we expecting to use this issue for all our comms?

Let me point you to a great answer @bazzadp wrote on this https://github.com/HTTPArchive/almanac.httparchive.org/issues/899#issuecomment-653488485

Who's "owning" project management?

For this chapter it would be you as the Content team lead. We've highlighted the key deadlines in the first comment above, but leave the organization and selection of those you'd like to work with up to you.

Right now the next task for this chapter is to have a outline and list of proposed metrics by the end of the week so we have time to set up the Web Crawler :)

foxdavidj commented 4 years ago

@alexdenning

To what extent is this chapter going to be an update on last year vs new takes? I understand you're to some extent looking to me to define that; would be good to get more of an idea of what's possible.

Totally understand. Here are the metrics that were used in last year's chapter. Hopefully looking at these will give you some ideas and show you what kind of queries are possible: https://docs.google.com/spreadsheets/d/1FDYe6QdoY3UtXodE2estTdwMsTG-hHNrOe9wEYLlwAw/edit#gid=0

In general though, feel free to go wild with what metrics you'd like to measure. Your analyst can then look through the list of metrics with you and let you know what might not be possible.

Also regarding this chapter's analyst, we're still actively recruiting more analysts and will keep you posted!

sirjonathan commented 4 years ago

I've requested access to the Document.

On Thu, Jul 16, 2020 at 7:55 AM alexdenning notifications@github.com wrote:

okey, following up on this. A couple of things I need to double check and confirm:

@obto https://github.com/obto are you the person whom I can ask these questions?

"Team" is @sirjonathan https://github.com/sirjonathan @ernee https://github.com/ernee yes? If yes, could you both of you add your details here? https://docs.google.com/document/d/1XL87z5MOk7QDLhpFsaMWT3DaIXdOQV32qs57noGwDVQ/edit

Are we expecting to use this issue for all our comms?

To what extent is this chapter going to be an update on last year vs new takes? I understand you're to some extent looking to me to define that; would be good to get more of an idea of what's possible.

Who's "owning" project management?

Thanks :)

— 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/915#issuecomment-659466231, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAZNVIZFZVHUTAGU4PFI2DR34IE3ANCNFSM4OJ2CVWA .

rviscomi commented 4 years ago

Granted! 🔑

@alexdenning I can fill in as the data analyst for this chapter until a more permanent contributor steps up

alexdenning commented 4 years ago

@obto awesome, many thanks for the updates and clarifications :) I'll make some time for this over the weekend and update in time for the next milestone on Monday.

alexdenning commented 4 years ago

Alrighty, outline is ready! Built on last year's topics, but as I'm not a developer I've taken out a couple of more technical items I'm not qualified to write about. Couple of talking points on the doc: I'd like to explore why a bit more this year, and would also like to look at feasibility of understanding environmental impact.

Happy to discuss, and looking forward to next steps!

GregBrimble commented 4 years ago

Hello! I'd love to volunteer as an analyst, if you are still looking for people to join. It would be my first year contributing to the Web Almanac, and I'd be happy to help in any way that I can 🙂

rviscomi commented 4 years ago

Thanks @GregBrimble great to have you! Here are some resources to get you up to speed:

The next milestone is due July 27. We should work together in the doc to go through @alexdenning's outline and assess what needs to be queried.

rviscomi commented 4 years ago

I've triaged all of the metrics in the outline and no custom metrics are needed, so this chapter is ready to go!

@GregBrimble could you also request edit access to the doc?

foxdavidj commented 4 years ago

@alexdenning @GregBrimble @rviscomi for the two milestones overdue on July 27 could you check the boxes if:

the outline has been reviewed and all feasible metrics have been identified
any necessary custom metrics have been created and you've created a draft PR to track which feasible metrics have had their queries implemented (we've updated the milestone description to clarify this)

Keeping the milestone checklist up to date helps us to see at a glance how all of the chapters are progressing. Thanks for helping us to stay on schedule!

alexdenning commented 4 years ago

@rviscomi I think those are your areas and that they're done, would you be able to confirm?

rviscomi commented 4 years ago

Yes, we're all set!

foxdavidj commented 4 years ago

I've updated the chapter metadata at the top of this issue to link to the public spreadsheet that will be used for this chapter's query results. The sheet serves 3 purposes:

Enable authors/reviewers to analyze the results for each metric without running the queries themselves
Generate data visualizations to be embedded in the chapter
Serve as a public audit trail of this chapter's data collection/analysis, linked from the chapter footer

alexdenning commented 4 years ago

Could I confirm the results sheet is up-to-date in line with: "Sep 7th: Analysts have queried all metrics and saved the output to the results sheet", and thus ready for me? Thanks :)

rviscomi commented 4 years ago

@alexdenning yes the queries have been written, reviewed, and run. The results are available for you to review in the chapter spreadsheet. Let both @GregBrimble and me know if you have any questions about the results. And just a reminder that the Lighthouse-based performance stats are invalid in the August dataset.

@sirjonathan @ernee you're also invited to review the results sheet to make sure everything looks to be in line with your expectations.

alexdenning commented 4 years ago

@rviscomi thank you! All looks good for me. I will wait for any other comments, and then make a start on writing :)

rviscomi commented 4 years ago

@alexdenning in lieu of any other analysis feedback, let's get started on the rough draft.

alexdenning commented 4 years ago

@rviscomi thanks -- was on vacation last week, am planning on getting stuck in from tomorrow :)

alexdenning commented 4 years ago

Hi all,

Very pleased to report I have my first draft ready :) This is in the doc: https://docs.google.com/document/d/1XL87z5MOk7QDLhpFsaMWT3DaIXdOQV32qs57noGwDVQ/edit#

I'm pretty pleased with it overall! Some places I have copied and pasted from last year where I didn't feel I could/needed to improve on the existing content. Others I've made assumptions and/or felt my arguments were weak; I've highlighted this with comments on the doc.

Tagging @rviscomi, and @sirjonathan, @ernee for review :)

Looking forward to feedback!

rviscomi commented 4 years ago

Thanks @alexdenning it's great to see the first draft taking shape! I've also added @amedina as a reviewer.

sirjonathan commented 4 years ago

@alexdenning I've given the document a thorough review. Great work!

I've left my feedback as suggestions and comments. My feedback is minor overall with a few areas where I'd love to see a bit more clarity and my other suggestions focused on improving readability / flow.

alexdenning commented 4 years ago

Many thanks @sirjonathan! Will review those tomorrow. @rviscomi shared some extra data which answers the mobile question; will add that, review all the comments, and add an extra section on WP plugin usage before EOW :)

alexdenning commented 4 years ago

Hi all, many thanks for the feedback. Been through and addressed all the comments I can. Mainly need @rviscomi to clarify a couple of technical details for me, and then this should be ready soon after :)

foxdavidj commented 4 years ago

@alexdenning in case you missed it, we've adjusted the milestones to push the launch date back from November 9 to December 9. This gives all chapters exactly 7 weeks from now to wrap up the analysis, write a draft, get it reviewed, and submit it for publication. So the next milestone will be to complete the first draft by November 12.

However if you're still on schedule to be done by the original November 9 launch date we want you to know that this change doesn't mean your hard work was wasted, and that you'll get the privilege of being part of our "Early Access" launch.

Please see the link above for more info and reach out to @rviscomi or me if you have any questions or concerns about the timeline. We hope this change gives you a bit more breathing room to finish the chapter comfortably and we're excited to see it go live!

alexdenning commented 4 years ago

@obto I did miss that, thanks for highlighting!

I think this is nearly done. I just have one chart which needs sorting (Rick is helping), and then we're good to go.

alexdenning commented 3 years ago

Alrighty, I think this is done. I had a bit of trouble getting my head round the final graph edits, but pretty sure that's all sorted now. Perhaps @rviscomi could confirm it's accurate. Unsure what happens next, so also tagging @obto :)

rviscomi commented 3 years ago

@alexdenning the page weight distribution results still seem like they need to be updated. I commented in the doc.

alexdenning commented 3 years ago

@rviscomi cheers – just need some help finishing it up if that's alright. Replied to you on the doc.

alexdenning commented 3 years ago

All comments are resolved, I think we're good to go!

rviscomi commented 3 years ago

Ok great! @alexdenning can you review the chapter metadata at the top of this thread to ensure that the milestone checklist is up to date and everyone who meaningfully contributed is appropriately credited?

Once those are done we can move on to the final milestone, which is for you to submit your final draft as a PR. And when that's merged we can get this chapter out in the early access release! 🎉

alexdenning commented 3 years ago

@rviscomi as I understand that's all correct, yup! I might need you to help me do the PR – not totally sure what I'm doing 😅

tunetheweb commented 3 years ago

Hey @alexdenning if you open a draft PR with the cms.md file in src/content/2020 folder with (base it on the 2019 version) I can help tell you if you're on the right track.

See here for some good guidance I gave to the Markup team: https://github.com/HTTPArchive/almanac.httparchive.org/issues/899#issuecomment-716806684

The Capabilities PR has already started theirs if you want an example - though still a work in progress and they've included the SQL queries in their PR as they weren't submitted previously but you're queries have already been merged by @rviscomi so only need the markdown file and the figure images.

Any questions give us a shout either here or on Slack!

tunetheweb commented 3 years ago

Oh and your discuss id for this year is 2051.

So your src/content/2020/cms.md markdown file should start like like this I imagine (assuming all the contributors at the top of this issue are accurate):

 --- 
 part_number: III
 chapter_number: 15
 title: CMS
 description: CMS chapter of the 2020 Web Almanac covering CMS adoption, how CMS suites are built, User experience of CMS powered websites, and CMS innovation.
 authors: [alexdenning]
 reviewers: [sirjonathan, ernee, amedina]
 analysts: [GregBimble, rviscomi]
 translators: []
 discuss: 2051
 results: https://docs.google.com/spreadsheets/d/1vTf459CcCbBuYeGvgo-RSidppR62SfM-VTkW-dfS3K4/
 queries: 15_CMS
 published: 2020-11-03T00:00:00.000Z
 last_updated: 2020-11-03T00:00:00.000Z
 --- 

## Introduction

The term Content Management System (CMS) refers to systems enabling individuals and organizations to create, manage, and publish content. A CMS for web content, specifically, is a system aimed at creating, managing, and publishing content to be consumed and experienced via the internet.

Each CMS implements some subset of a wide range of content management capabilities and the corresponding mechanisms for users to build websites easily and effectively around their content. Content is often stored in a type of database, providing users with the flexibility to reuse it wherever needed for their content strategy. CMSs also provide admin capabilities aimed at making it easy for users to upload and manage content as needed.

...etc

alexdenning commented 3 years ago

Cheers – so do I need to create a markdown version of the Google Doc? Is there a convenient way of doing that? What about image hosting? And is the content/2020 folder a folder I need to create? Cheers :)

tunetheweb commented 3 years ago

Cheers – so do I need to create a markdown version of the Google Doc? Is there a convenient way of doing that? What about image hosting? And is the content/2020 folder a folder I need to create? Cheers :)

Yes you need to convert to markdown and yes to the src/content/2020/ folder - it's not there yet as no one's merged their 2020 chapter yet (though Capabilities and Markup are pretty close so might be there soon enough!). I saw someone suggesting Docs to Markdown but looking at your document I'd say it's probably easier to just copy and paste it into a cms.md file and change the headings and links as, other than the images, those seem to be the only special formatting you have. Reminder to include the meta data at the top of the file that I gave in a previous comment.

For images, please see our Figures Guide. Basically, you'll need to include the images @rviscomi has provided in your doc as part of the PR, saving them to src/static/images/2020/cms/ folder, then refer to them with markup like this as mentioned in the guide:

{{ figure_markup(
  image="direction-popularity.png",
  caption="Popularity of direction values.",
  description="Bar chart showing the popularity of direction values ltr and rtl. ltr is used by 32% of desktop pages and 40% of mobile pages. rtl is used by 32% of desktop pages and 36% of mobile pages.",
  chart_url="https://docs.google.com/spreadsheets/d/e/2PACX-1vQO5CabwLwQ5Lj1_9bbEFnFM1qEqCorymaBHrcaNiMSJ7sYDKHUI5iish5VAS-SxN447UTW-1-5-OjE/pubchart?oid=136847988&format=interactive",
  sheets_gid="693111191",
  sql_file="direction-popularity.sql"
  )
}}

Try to give nice descriptions for SEO and Accessibility reasons if you can.

This function will automatically display the images correctly and give them a unique figure id when the site is built and served. I can give you a dev version link of your chapter once we reach that stage to show you want it's looking like, or you can run the website locally by following the instructions in the src/README.md if you want.

foxdavidj commented 3 years ago

@alexdenning Any update on this? Would love to get this chapter published :)

alexdenning commented 3 years ago

@obto oh whoops, my apologies. Managed to completely lose this on my task list!

I'm not super-familiar with markdown, but I can try and do this by Friday for you :)

HTTPArchive / almanac.httparchive.org

CMS 2020 #915

Part III Chapter 15: CMS

Content team

Milestones

0. Form the content team

1. Plan content

2. Gather data

3. Validate results

4. Draft content

5. Publication