docs: add flowchart for GSoC23 project in README.md

[14Richa]

Description
This pull request adds a flowchart for the GSoC23 project in the README.md file. The flowchart, made using Mermaid, provides a visual representation of the project's workflow and helps to better understand the different stages involved in the project.

Related issue(s)
asyncapi/.github#210
#810

[derberg]

I'm missing a flow or sequence diagram that depicts all the workflows in one diagram, like the order of triggering

left also some comments

this is looking really good, just some tweaks are needed

[derberg]

I left some comments

I'm not 100% sure the way you choose to represent relation between diagrams is the best. Now they look like everything starts with codeowner edit but it is not true. Might be that someone is maintainer for months and decides to become tsc member later.

We should have workflows relations for each "starting action"

• one diagram for CODEOWNER add/remove (not 2 separate and use flow type please, use diamond shapes please)
• one diagram for tsc member flag add/remove or rather any human edits

I think it is safe to say, we need human-focused diagrams? so flows that show what happens in the system when human makes a change

does it make sense?

[derberg]

All good from my side

@AceTheCreator pinging you so you are aware there is some new content getting in, /workflowautomation/README.md under mentorship/summerofcode/2023, I hope that is fine?

[AceTheCreator]

@14Richa @derberg, so why are these changes targeting the mentorship directory?

Nothing in the docs signifies that it's GSoC related

[14Richa]

@AceTheCreator, Thanks for your question. I understand the confusion. I've recently added a paragraph at the start of the README, which outlines that these changes are part of our project for Google Summer of Code 2023.
If there are any more questions or anything else you'd like to know or suggest, please feel free to share. :)

[AceTheCreator]

@AceTheCreator, Thanks for your question. I understand the confusion. I've recently added a paragraph at the start of the README, which outlines that these changes are part of our project for Google Summer of Code 2023. If there are any more questions or anything else you'd like to know or suggest, please feel free to share. :)

@14Richa, while the changes make sense, I disagree that these changes should be in the mentorship dir but instead in the docs dir. cc @derberg

[14Richa]

@AceTheCreator , Thank you for your feedback on the changes. I have created a new folder in the doc directory named GSOC-23 and added the readme file to this folder.

[derberg]

There is one problem with this approach because long plan is that whatever is in docs goes to community bucket in asyncapi.com/docs

This markdown file is not the final documentation that will end up in docs, it is more a project documentation

[AceTheCreator]

There is one problem with this approach because long plan is that whatever is in docs goes to community bucket in asyncapi.com/docs

This markdown file is not the final documentation that will end up in docs, it is more a project documentation

Where do suggest it resides then? Cuz I don't think it belongs in the mentorship dir 🤔

[derberg]

@AceTheCreator project documentation for sure do not belong to product documentation. This is why for @14Richa it was natural to put it under mentorship as it is purely mentorship related.

@14Richa maybe we should just convert it into an issue here in community repo? and then when all is ready from implementation point of view, we will decide what should end up in the final documentation?

[14Richa]

@AceTheCreator project documentation for sure do not belong to product documentation. This is why for @14Richa it was natural to put it under mentorship as it is purely mentorship related.

@14Richa maybe we should just convert it into an issue here in community repo? and then when all is ready from implementation point of view, we will decide what should end up in the final documentation?

@derberg, I've created the issue as suggested by you and linked it to the pull request. Please feel free to review and add any additional details you think would be helpful. Let's continue with the implementation, and I'll keep updating the issue with our progress. Once everything is ready, we can discuss and finalize the documentation together.

[derberg]

@14Richa oh, sorry, I mean't convert PR to issue, so in the issue, add what you already have in the markdown in this PR, and close this PR. So issue is basically "project" documentation that we will later use for final "product documentation"