Automation for pushing docs to the Community content bucket of AsyncAPI website

[smoya]

Description

Part of the effort the Maintainers Growth WG is doing in order to help maintainers of this repository to facilitate and attract new maintainers.

We need a GH Workflow that copies Markdown documentation from this repository to the Community content bucket in https://github.com/asyncapi/website/tree/master/markdown/docs/community, so it gets displayed under https://www.asyncapi.com/docs/community (under maintainer subsection, as stated in https://github.com/orgs/asyncapi/discussions/1136).

The GH Workflow should be triggered every time documentation is changed in this repository.

Regarding the directories where the documentation will exist:

• The source of docs will be under /docs/maintainer-onboarding-guide on this right repository (.github).
• The target where the docs should be copied from source dir will be under /docs/maintainer-onboarding-guide in Community repository

cc @asyncapi/maintainers_growth_wg

[akkshitgupta]

I would like to work on this issue.

[akshatnema]

@smoya @aeworxet I would like to take this bounty issue and work on it 😊

(if @smoya don't have any problem 😅 )

[smoya]

I removed this issue from the bounty due to the fact I wrongly set up complexity. I didn't know most of the job is done in https://github.com/asyncapi/cli/blob/master/.github/workflows/update-docs-in-website.yml and that there is an ongoing PR very very similar to the work we need to do here.

cc @akkshitgupta @akshatnema

[akkshitgupta]

willing to continue if I am eligible as I was not for the bounty one 😅

[akshatnema]

Sure @akkshitgupta, go ahead 🚀

[akkshitgupta]

@smoya I have some questions

• The content copied to website/docs/community via a pull request or directly pushed to it (as it has already been processed before pushing to production)
• Will we be having the docs from the root of the .github repo or a new directory containing all the docs specific to the website needs to be created.

More details about the final bucket name inside community content bucket will be provided soon.

[smoya]

• The content copied to website/docs/community via a pull request or directly pushed to it (as it has already been processed before pushing to production)

Pull Request, as in https://github.com/asyncapi/cli/blob/master/.github/workflows/update-docs-in-website.yml. As the user of such a PR is asyncapi-bot, the automerge workflow will autoapprove and automerge the PR.

Will we be having the docs from the root of the .github repo or a new directory containing all the docs specific to the website needs to be created.

That's actually a good question. I would move forward with the second option: to have a new dir called /docs with all of the documentation we want to copy to the other repo.

cc @derberg @alequetzalli just in case

[smoya]

Regarding the directories where the documentation will exist:

• The source of docs will be under /docs/maintainer-onboarding-guide on this right repository (.github).
• The target where the docs should be copied from source dir will be under /docs/maintainer-onboarding-guide in Community repository

[smoya]

@akkshitgupta are you still willing to work on this 😄 ?