Add automation to push bindings docs to website

[derberg]

under https://asyncapi.com/docs/reference/ we have specification rendered and also now extensions

We just need to add workflow like https://github.com/asyncapi/extensions-catalog/blob/master/.github/workflows/update-extensions-in-website.yml to copy over markdown files with proper names and render in website

It's not important only for visibility and discoverability of info (navingate from one place and search integration) but also all keywords used in bindings increase SEO position for asyncapi.com

[ibishal]

hey @derberg we need similar workflow like this one(https://github.com/asyncapi/extensions-catalog/blob/master/.github/workflows/update-extensions-in-website.yml ) but to be adapted for binding

[derberg]

@ibishal exactly, added it to bounty

[akshatnema]

@derberg I wish to work on this issue, under the Bounty program.

[aeworxet]

Bounty Issue's service comment

Text labels: bounty/2024-Q3, bounty/medium, bounty/coding
First assignment to third-party contributors: 2024-06-21 00:00:00 UTC+12:00
End Of Life after: 2024-07-31 23:59:59 UTC-12:00

@asyncapi/bounty_team

The Bounty Program is not a Mentorship Program. The accepted level of Bounty Program Participants is Middle/Senior.

Third-party contributors should coherently articulate how they are going to approach the resolution process when expressing a desire to work on this Bounty Issue.

[derberg]

@akshatnema really? nice ❤️

I assign to @akshatnema that is a maintainer in AsyncAPI org, a maintainer in website. This automation is actually also website related as the automation will be pushing markdown files to website. So not much onboarding is needed

[akshatnema]

So not much onboarding is needed

Really? But I do have certain questions with me 😅 .

What are the files you need to show them in the website? Like I don't see any docs folder inside this repo. So, which files have to be copied to website and in which order?

[derberg]

@akshatnema please check extensions catalog repo, there is no docs either. Get familiar with what automation does there

[derberg]

I noticed I forgot that I was suppose to wait 3 days before I publish a decision who will work on issues.

I don't have a better excuse other than "Monday". My apologies.

[akshatnema]

@akshatnema please check extensions catalog repo, there is no docs either. Get familiar with what automation does there

Yeah, I looked in its implementations, but as per the current bindings repo, we don't have exclusive md files like that. Here, we actually work in a fashion of having README.md file for each service. Hence, I would prefer to have these files as http.md, kafka.md in the website docs, instead of README.md files being used directly, with subdirectories.

wdyt? @derberg

[akshatnema]

One of the suggestions could be to change the name of README.md to index.md, as we can't have a pathname for a doc inside website, ending with README.md. IMO, README files are specifically designed for github repos, and we shouldn't copy this same structure at website as well.