Extends metadata of blog documents to enable people to provide canonical URL

[derberg]

Reason/Context

Some people repost important articles in AsyncAPI Blog. To encourage them to do that and promote their projects or educate community, then should know we will not abuse their original source, their original content and SEO of their blogging platform.

So we need to allow the author of an article to provide info what is the canonical URL, where is the original first version of the article.

Description

Best would be to support additional from matter filed in any document from https://github.com/asyncapi/website/tree/master/pages/blog.

so blog author can add:

title: `AsyncAPI vs OpenAPI` #already there, just an example
type: Engineering  #already there, just an example
canonical: https://solace.com/blog/asyncapi-vs-openapi/ #the new field we need

If canonical is provided, we need to make sure that resulting HTML has something like this in head:

<link rel=canonical href="https://solace.com/blog/asyncapi-vs-openapi/"/>

Nice to have is also to extend https://github.com/asyncapi/website/blob/master/scripts/compose.js script so when someone authors an article with npm run write:blog, the author is asked if there is a canonical URL for the article

[derberg]

/gfi js

[octonawish-akcodes]

can I work on this :)

[jessemenning]

@derberg thanks for opening this issue, it would definitely help me/others justify putting up blogs on asyncapi!

[derberg]

@octonawish-akcodes go ahead please. Please include in the PR changes to @jessemenning articles where he needs the canonical URL.

@jessemenning can you provide if there are more articles affected than the one about AsyncAPI vs OpenAPI. There were some other articles from Solace folks afaik

[jessemenning]

@octonawish-akcodes , thank you very much!

Here are the mappings from AsyncAPI blogs to the canonical version on Solace.com

https://www.asyncapi.com/blog/async_standards_compare
https://solace.com/blog/asyncapi-cloudevents-opentelemetry-event-driven-specs-devops/

https://www.asyncapi.com/blog/openapi-vs-asyncapi-burning-questions
https://solace.com/blog/asyncapi-vs-openapi/

https://www.asyncapi.com/blog/asyncapi-discovery-intro
https://solace.com/blog/asyncapi-discovery-tool/

https://www.asyncapi.com/blog/asyncapi_codegen_scst
https://solace.com/blog/asyncapi-codegen-microservices-using-spring-cloud-stream/

[sambhavgupta0705]

Hey @octonawish-akcodes ,are you still working on this issue?
If not then can I work on this one.

[octonawish-akcodes]

Yes I am working on this, will raise a PR soon :)

[Ciggzy1312]

I have made a PR for this issue as I saw no one assigned and no activity on this issue for a week
But I just now noticed the latest comment

@derberg if you want me or if @octonawish-akcodes haven't made any progress on their side I can close my PR, don't want someone else's work to go to waste
Extremely sorry for not following up on the comments

[octonawish-akcodes]

I have made the same changes and was going to raise the PR but no issue you can keep your PR.

[derberg]

Thanks folks for your commitment, just next time lets make sure you do not duplicate efforts 🙏🏼 😄