asyncapi/website

[๐Ÿ“‘ Docs]: Automation Github Workflows

Opened this issue ยท 2 comments

What Dev Docs changes are you proposing?

This is the main effort the Maintainers Growth Working Group is working at this moment.

Based on the feedback provided by @derberg to the Maintainers Growth Working Group, to create a new section under the community section, that contains documentation about the GitHub Workflows used globally across the AsyncAPI org.

Those workflows are located under https://github.com/asyncapi/.github/tree/master/.github.

Ideally, the documentation should live in https://github.com/asyncapi/.github repository. That means we would need to somehow deploy it to our website (for example, by creating an automated PR to website repo every time a doc changes).

This is a very first and vague draft of an issue. That means help is more than welcome to turn this into a detailed project. I suggest we rely heavily on @alequetzalli criteria, who during our last WG meeting showed that this was already on its mind since got sent as part of the GSOD submission.

cc all MGWG members + stakeholders: @alequetzalli @Mayaleeeee @thulieblack @AceTheCreator @smoya @derberg

Code of Conduct

  • I agree to follow this project's Code of Conduct

Yes! We'll add these docs to the plan outlined for expanding our Community Docs, as noted here: https://github.com/orgs/asyncapi/discussions/1136.

Once I have the basics sent my way, I can write these docs.

@derberg will create a video explaining how globally automation works on AsyncAPI GH org. Based on that, we will create brand new documentation.