cncf / cncf.io

☁️♮🏛🚧 The CNCF.io WordPress website
https://cncf.io
MIT License
83 stars 37 forks source link

Consistent of web address for case studies #40

Closed KimMcMahon closed 4 years ago

KimMcMahon commented 4 years ago

On the current site, the case study page uses "case-studies" https://www.cncf.io/newsroom/case-studies/

Individual case studies: "case-study" https://www.cncf.io/case-study/adform_prometheus/

To help with pulling numbers from Google Analytics, can we use the same words - either "case-studies" or "case-study"

thetwopct commented 4 years ago

While working earlier I noticed another inconsistency with the URLs

Announcements category https://www.cncf.io/newsroom/announcements/

Single post in that category (missing 'newsroom', 'announcement' instead of 'announcements') https://www.cncf.io/announcement/2020/03/12/cloud-native-computing-foundation-announces-splunk-gold-member/

cjyabraham commented 4 years ago

Here's another: Speakers Bureau https://www.cncf.io/speakers/

Speaker https://www.cncf.io/speaker/puja/

cjyabraham commented 4 years ago

@KimMcMahon for now, are you able to just search for "case-stud" in the analytics search? Does that get you what you need?

KimMcMahon commented 4 years ago

There is also the same issue with the China case studies https://www.cncf.io/newsroom/case-studies-cn/ https://www.cncf.io/case-study-cn/bookingcom/

cjyabraham commented 4 years ago

There is some debate on whether to use singular or plural in folder names. Here is a list of prominent sites that use one or the other:

Singular https://alistapart.com/article/cross-cultural-design/ https://calendar.google.com/calendar/r/month/2020/6/1 https://www.youtube.com/channel/UC3XTzVzaHQEd30rQbuvCtTQ https://lists.cncf.io/g/newsletter/topic/cncf_newsletter_january_2020/69834710

Plural https://serverfault.com/questions/73682/standard-for-singular-vs-plural-type-names-in-urls https://stackoverflow.com/questions/6845772/rest-uri-convention-singular-or-plural-name-of-resource-while-creating-it https://github.com/cncf/cncf.io/issues/39 https://www.facebook.com/groups/cmnomads https://twitter.com/messages/21658515-22508586 https://jobs.cncf.io/jobs/31901051-engineering-manager-site-reliability-at-wikimedia-foundation

I like the point this article makes for using plural so that the url is hackable. There are some other considerations as well regarding urls, such as having shorter ones is generally better for SEO. With all that in mind, I propose the following new url structure for cncf.io (I've also discussed these with @thetwopct ):

  1. https://www.cncf.io/people/end-user-community/ remains as it is
  2. https://www.cncf.io/events-well-be-at/isc-high-performance-2020/ should change to https://www.cncf.io/events/isc-high-performance-2020/
  3. https://www.cncf.io/webinars/democratizing-analytics-cloud-native-data-warehouses-on-k8s/ remains as is
  4. https://www.cncf.io/speaker/randy.abernethy/ should change to https://www.cncf.io/speakers/randy.abernethy/
  5. https://www.cncf.io/announcement/2020/03/12/cloud-native-computing-foundation-announces-splunk-gold-member/ should change to https://www.cncf.io/announcements/2020/03/12/cloud-native-computing-foundation-announces-splunk-gold-member/
  6. https://www.cncf.io/news/2020/03/12/computing-whats-happening-with-serverless-cloud/ should remain as is
  7. https://www.cncf.io/newsroom/in-the-news/ should change to https://www.cncf.io/news/
  8. https://www.cncf.io/blog/2020/03/17/how-to-setup-role-based-access-to-kubernetes-cluster/ remain as is
  9. https://www.cncf.io/newsroom/blog/ will change to https://www.cncf.io/blog/
  10. https://www.cncf.io/newsroom/case-studies/ should change to https://www.cncf.io/case-studies/
  11. https://www.cncf.io/case-study/adform/ should change to https://www.cncf.io/case-studies/adform/
  12. https://www.cncf.io/newsroom/case-studies-cn/ should change to https://www.cncf.io/case-studies-cn/
  13. https://www.cncf.io/case-study-cn/frameio/ should change to https://www.cncf.io/case-studies-cn/frameio/

Do we want to change https://www.cncf.io/certification/cka/ to https://www.cncf.io/certifications/cka/?

Any thoughts on all of this? Of course we will setup redirects for all changes so that we don't lose any traffic.

(cc @dankohn )

dankohn commented 4 years ago

Plural for consistency is fine with me, with appropriate redirects

KimMcMahon commented 4 years ago

Consistency is the most important consideration for me!

KimMcMahon commented 4 years ago

@cjyabraham I also have some case studies that are not consistent. /case-study-adform-prometheus/ /case-study/adform_prometheus/

/case-study/antfinancial/ /case-study/ant-financial/

And there are about 5 more. Is there some instruction we should give Alex going forward to use when she posts the case studies?

cjyabraham commented 4 years ago

@KimMcMahon Where do you see /case-study-adform-prometheus/? It may be an old piece of content. I believe all the case studies published on the case studies page do follow a consistent url structure. We won't be copying over any of the legacy unpublished case studies to the new site.

cjyabraham commented 4 years ago

I have noted all these redirects in our rebuild plan. Let me know if you see any issues. I'll close this issue since we'll follow the sheet from here.

cjyabraham commented 4 years ago

Reopening because I've run into an issue: it seem that the Speakers Bureau plugin (Ultimate Member) requires a different url for the directory https://www.cncf.io/speakers/ and the individual user profiles path https://www.cncf.io/speaker/puja/ so we wouldn't be able to have both on https://www.cncf.io/speakers/.

One alternative I thought of is having the directory at https://www.cncf.io/speakers/search/ so that we can move the speakers profiles to https://www.cncf.io/speakers/puja/. It's not ideal but may be slightly preferable. We could redirect https://www.cncf.io/speakers/ to https://www.cncf.io/speakers/search/. Or we can just leave things as they currently are... Any thoughts?

cjyabraham commented 4 years ago

Actually, cancel that, that idea doesn't work either with the way UM routes paths... I recommend we just stay with what we have for now even though it won't be perfectly consistent with the way we'll use plurals on other parts of the site. Feel free to reopen if you disagree.