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

CMS 2020 #915

Closed
10 tasks done
foxdavidj opened this issue Jun 27, 2020 · 58 comments
Closed
10 tasks done

CMS 2020 #915

foxdavidj opened this issue Jun 27, 2020 · 58 comments
Assignees
Labels
2020 chapter Tracking issue for a 2020 chapter writing Related to wording and content

Comments

@foxdavidj
Copy link
Contributor

foxdavidj commented Jun 27, 2020

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

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

1. Plan content

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

2. Gather data

  • Aug 1 - 31: August crawl
  • Sep 7th: Analysts have queried all metrics and saved the output to the results sheet

3. Validate results

4. Draft content

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

5. Publication

  • 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
@foxdavidj foxdavidj added help wanted Extra attention is needed analysis Querying the dataset writing Related to wording and content labels Jun 27, 2020
@foxdavidj foxdavidj added this to the 2020 Content Planning milestone Jun 27, 2020
@rviscomi rviscomi added 2020 chapter Tracking issue for a 2020 chapter help wanted: reviewers This chapter is looking for reviewers help wanted: analysts This chapter is looking for data analysts and removed help wanted Extra attention is needed labels Jun 27, 2020
@ernee
Copy link
Contributor

ernee commented Jul 2, 2020

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
Copy link
Member

rviscomi commented Jul 2, 2020

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

@sirjonathan
Copy link

sirjonathan commented Jul 2, 2020 via email

@paulcalvano paulcalvano removed the help wanted: analysts This chapter is looking for data analysts label Jul 6, 2020
@rviscomi
Copy link
Member

rviscomi commented Jul 7, 2020

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

@paulcalvano paulcalvano added the help wanted: analysts This chapter is looking for data analysts label Jul 7, 2020
@sirjonathan
Copy link

sirjonathan commented Jul 7, 2020 via email

@rviscomi
Copy link
Member

rviscomi commented Jul 7, 2020

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

@sirjonathan
Copy link

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
Copy link
Contributor

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
Copy link
Contributor Author

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

  1. 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.
  2. Start sketching out ideas in your draft doc.
  3. 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
Copy link
Contributor

@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
Copy link
Contributor Author

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
Copy link
Contributor

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

@alexdenning
Copy link
Contributor

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

Thanks :)

@foxdavidj
Copy link
Contributor Author

@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 #899 (comment)

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
Copy link
Contributor Author

@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
Copy link

sirjonathan commented Jul 17, 2020 via email

@rviscomi
Copy link
Member

rviscomi commented Jul 17, 2020

Granted! 🔑

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

@alexdenning
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor Author

@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
Copy link
Contributor

@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
Copy link
Contributor

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
Copy link
Member

rviscomi commented Oct 28, 2020

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

@alexdenning
Copy link
Contributor

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

@alexdenning
Copy link
Contributor

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

@rviscomi
Copy link
Member

rviscomi commented Nov 2, 2020

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
Copy link
Contributor

@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
Copy link
Member

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: #899 (comment)

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
Copy link
Member

tunetheweb commented Nov 3, 2020

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
Copy link
Contributor

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
Copy link
Member

tunetheweb commented Nov 3, 2020

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
Copy link
Contributor Author

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

@alexdenning
Copy link
Contributor

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

@alexdenning
Copy link
Contributor

@OBTo I've got as far as converting the text to markdown, but I need to carve out a solid hour next week to get my head around the images. I don't know how to do a PR, though, so I'll have to post it all here and ask someone else to take it forward 🙏

@tunetheweb
Copy link
Member

@alexdenning i can help out here if you want. Should be able to knock it up pretty quickly over the weekend. Send on what you’ve got to Barry at tunetheweb.com.

@alexdenning
Copy link
Contributor

@bazzadp that'd be much appreciated! Will email the MD file over.

@tunetheweb
Copy link
Member

No problem @alexdenning . Need a few things from you while I work on this:

  1. Can I get a sentence or two about your self for the bio? Here's last year's one as an example:

2019 CMS Author bios

  1. Can you give me your social media info that you are happy to publish:
  • GitHub user name - alexdenning
  • Twitter user name - AlexDenning
  • LinkedIn user name - ???
  • Website - ??

Don't need them all so can go with just the two we have if ok.

  1. Can I have a quote from the chapter and three interesting stats for part of our Random featured chapter section on our home page. Here's last year's one:

2019 CMS Featured Quote

I can pick this from the chapter, but better to come from you if you can.

@tunetheweb tunetheweb mentioned this issue Nov 13, 2020
2 tasks
@alexdenning
Copy link
Contributor

@bazzadp sure!

Bio:

Alex Denning is the Founder of Ellipsis Marketing, a marketing agency for WordPress businesses. Alex is a WordPress Core Contributor and has helped organise WordCamp London.

Website: getellipsis.com

Let's use the same intro quote as last year:

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.

Stats:

  1. 42% of web pages are powered by a CMS
  2. 1.5g of CO2 emitted by the median CMS page load
  3. 74% of sites using a CMS use WordPress (same as last year!)

@tunetheweb
Copy link
Member

Added these in 21d0a09 and ffb9806. You can edit yourself as as you do the contents of that chapter in that open pull request.

@rviscomi rviscomi added ASAP This issue is blocking progress and removed analysis Querying the dataset labels Nov 30, 2020
@alexdenning
Copy link
Contributor

Many thanks all for your help supporting me on this :) Really pleased with the end result, and great to see it live!

@tunetheweb
Copy link
Member

Many thanks to the whole team for this and think we can now close this issue. Great job and looks fantastic!

@rviscomi rviscomi removed the ASAP This issue is blocking progress label Dec 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2020 chapter Tracking issue for a 2020 chapter writing Related to wording and content
Projects
None yet
Development

No branches or pull requests

8 participants