Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add flowchart for GSoC23 project in README.md #719

Closed
wants to merge 49 commits into from

Conversation

14Richa
Copy link
Contributor

@14Richa 14Richa commented May 25, 2023

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

@14Richa 14Richa changed the title doc: added Flowchart for GSoC23 Project in README.md doc: added flowchart for GSoC23 project in README.md May 25, 2023
@14Richa 14Richa changed the title doc: added flowchart for GSoC23 project in README.md docs: added flowchart for GSoC23 project in README.md May 25, 2023
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
mentorship/summerofcode/2023/workflowautomation/README.md Outdated Show resolved Hide resolved
@14Richa 14Richa marked this pull request as ready for review July 4, 2023 15:06
@14Richa 14Richa requested a review from thulieblack as a code owner July 5, 2023 10:13
derberg
derberg previously approved these changes Jul 6, 2023
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@derberg derberg changed the title docs: added flowchart for GSoC23 project in README.md docs: add flowchart for GSoC23 project in README.md Jul 6, 2023
@AceTheCreator
Copy link
Member

AceTheCreator commented Jul 11, 2023

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

Nothing in the docs signifies that it's GSoC related

@14Richa
Copy link
Contributor Author

14Richa commented Jul 13, 2023

@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
Copy link
Member

@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
Copy link
Contributor Author

14Richa commented Jul 18, 2023

@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.

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

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
Copy link
Member

derberg commented Jul 24, 2023

@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
Copy link
Contributor Author

14Richa commented Jul 24, 2023

@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
Copy link
Member

derberg commented Jul 24, 2023

@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"

@14Richa 14Richa closed this Jul 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants