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.

Sign up for GitHub

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

Jump to bottom

docs: update Introduction section and add flowchart #552

Merged
merged 10 commits into from
Jul 26, 2023
Merged

docs: update Introduction section and add flowchart #552

merged 10 commits into from
Jul 26, 2023

Conversation

mhmohona
Copy link
Contributor

Description
Updated the Introduction section of the AsyncAPI CLI documentation and adds a flowchart to show the process flow of the CLI. The flowcharts shows the high-level process that occurs when using the CLI, helping users better understand the tool and its capabilities.

cc: @derberg @alequetzalli

Related issue(s)

derberg
derberg reviewed May 11, 2023
View reviewed changes
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.

Thank for the PR

I left some comments

Maybe example command usage should be here as well?

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@quetzalliwrites
Copy link
Member

whoa cool, @mhmohona! ✨ I will let Lukasz review the technical accuracy piece first. Once he says it's correct, I will give it a TW editorial pass ✌🏽

@mhmohona mhmohona requested a review from derberg May 15, 2023 07:12
@sonarcloud
Copy link

sonarcloud bot commented May 15, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

derberg
derberg requested changes May 15, 2023
View reviewed changes
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.

left some comments, getting better!

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@derberg
Copy link
Member

derberg commented Jul 10, 2023

@mhmohona do you plan to continue with this one or should we close it?

@mhmohona
Copy link
Contributor Author

I actually forgot about this PR 😓 I will work on it.

@mhmohona
Copy link
Contributor Author

@derberg I have updated the changes as per review. Please have a look at it.

@mhmohona mhmohona requested a review from derberg July 25, 2023 07:58
derberg
derberg requested changes Jul 25, 2023
View reviewed changes
docs/index.md Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@mhmohona mhmohona requested a review from derberg July 25, 2023 13:49
derberg
derberg approved these changes Jul 26, 2023
View reviewed changes
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.

Thanks!!!

@sonarcloud
Copy link

sonarcloud bot commented Jul 26, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@derberg
Copy link
Member

derberg commented Jul 26, 2023

/rtm

@asyncapi-bot asyncapi-bot merged commit 699ade2 into asyncapi:master Jul 26, 2023
11 checks passed
@derberg
Copy link
Member

derberg commented Jul 26, 2023

@allcontributors please add @mhmohona for docs

@allcontributors allcontributors bot mentioned this pull request Jul 26, 2023
Merged
@allcontributors
Copy link
Contributor

@derberg

I've put up a pull request to add @mhmohona! 🎉

@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 0.51.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@derberg derberg derberg approved these changes

@Souvikns Souvikns Awaiting requested review from Souvikns Souvikns is a code owner

@magicmatatjahu magicmatatjahu Awaiting requested review from magicmatatjahu

@boyney123 boyney123 Awaiting requested review from boyney123

@asyncapi-bot-eve asyncapi-bot-eve Awaiting requested review from asyncapi-bot-eve asyncapi-bot-eve is a code owner

Assignees
No one assigned
Labels
ready-to-merge released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mhmohona @quetzalliwrites @derberg @asyncapi-bot