kedro-org / kedro-website

A repository for the official home of Kedro.
https://kedro.org/
3 stars 2 forks source link

Research CMS offerings for blog.kedro.org #61

Closed yetudada closed 2 years ago

yetudada commented 2 years ago

Description

We're starting up our awesome Developer Relations and Technical Writing team and would love to have a home for all of the amazing written content that we will create. This task summarises a design effort to create blog.kedro.org which would allow us to:

Impact areas

We would need to look at how to:

tynandebold commented 2 years ago

To do, part I:

Part II (ticket created here #62):

stichbury commented 2 years ago

Having recent experience of both ghost and contentful, I'd advocate for ghost over contentful, but both are OK-ish

tynandebold commented 2 years ago

From my research, it seems like we'd be fine with the free Community plan that Contentful offers. That would give us:

Ghost doesn't have a free or open-source plan, so we'd have to pay.

Strapi is free if you self host, though to do that we'd need a lot of architectural overhead via AWS or the like, and we'd have to pay for that, so it wouldn't be free.

Contentful also integrates well with Next.js, which is what the Kedro website is built with, and has a lot of documentation on integrating the two.

stichbury commented 2 years ago

In terms of bring-up time, how do they compare? My experience with Contentful is that it took a while to customise it for fairly basic usage. Do you have a sense of work necessary for each @tynandebold ?

tynandebold commented 2 years ago

My experience with Contentful has been quick on the uptake time. I think I could get it up and running in one day.

The others I don't know well enough to estimate.

tynandebold commented 2 years ago

I'm curious what took a while to customize for you though, even if the usage was basic?

stichbury commented 2 years ago

That sounds promising.

So I wasn't directly involved as the other technical content writer in my team took on the burden of working with a (subcontracted) development team to give them requirements. I'm going to ask him now what the main issues he/the team hit upon. It took months

So this is the content -- this is a typical article, which took me about 15 minutes to upload into the format when I had a draft, so that's not too bad, although I didn't include code snippets.

The alternative (ghost) solution is this blog which is also on the Ably site https://ably.com/blog I found Ghost easier to use as a CMS than Contentful because it's the basis of Medium and is like any other blog platform (while Contentful is more complex)...but I've no idea either how long it took to set up.

tynandebold commented 2 years ago

Interesting. So there are two CMS systems driving different parts of that website? I'm perplexed.

I think it would be nice to use Ghost. It looks promising, it just isn't free.

Do let me know what the issues were for the other technical content writer!

tynandebold commented 2 years ago

@stichbury another thought: could we get away with just using Markdown files for posts? Something like this example? Any experience with that in the past? If so, how'd you find it?

stichbury commented 2 years ago

@tynandebold What does that look like when it's rendered?

I've used Jekyll (nice) and dev.to (not so nice) as markdown blog engines. They're OK but my main issue with them is that the workflow for content put into blogs is better done in a non-markdown solution such as google docs (OK, not at QB) or Word. The comment and change tracking workflow is infinitely better IMO.

So I'd be happy with a markdown blog if we could find a way to convert word files into markdown fairly smoothly.

Apart from that, my requirements for a blog are something along these lines:

If we can do that in a markdown solution, I'm happy. WDYT?

tynandebold commented 2 years ago

Great points and thoughts, thanks for that.

I think it would be too much engineering to find something that would convert a Word doc into Markdown when our other options give us nearly all your wants from the list above. I like the idea though and will keep it around. There are advantages to it.

This afternoon I wired up Contentful and have a sparse and basic page already working: https://deploy-preview-63--kedro-website.netlify.app/posts/what-is-kedro-viz

The only thing on your list that I'm unsure of are code snippets. I'll have to do some digging. There must be a way though.

tynandebold commented 2 years ago

@stichbury forgot to show you what that's like when it's rendered. Here it is.

stichbury commented 2 years ago

That's nice! It may be that code snippets are as easy as three backticks in standard text, which creates a markdown block but 🤷

tynandebold commented 2 years ago

Webflow isn't what we want either, as it's more akin so Squarespace or Wix, e.g. a way to build a website from scratch via drag and drop that's then powered by their CMS.

Contentful is the winner.