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 Bug 🐞 report]: Improve Create AsyncAPI document article #1545

Closed
1 task done
janvi01 opened this issue Apr 11, 2023 · 10 comments
Closed
1 task done

[Docs Bug 🐞 report]: Improve Create AsyncAPI document article #1545

janvi01 opened this issue Apr 11, 2023 · 10 comments
Assignees
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 🐞 docs bug stale

Comments

@janvi01
Copy link
Contributor

janvi01 commented Apr 11, 2023

Describe the bug you found in AsyncAPI Docs.

While going through the Create AsyncAPI document article , there are many minor errors like word of choice, punctuation, etc.

Attach any resources that can help us understand the issue.

Screenshot 2023-04-11 at 1 09 33 PM

I would like to fix this to enhance the effectiveness of the documentation.

pinging @alequetzalli, Kindly assist me. Thanks!

Code of Conduct

  • I agree to follow this project's Code of Conduct
@janvi01
Copy link
Contributor Author

janvi01 commented Apr 14, 2023

Hey @golu-99 , before creating a PR for any issue, First you need to ask if anybody is working or not.

@derberg
Copy link
Member

derberg commented Apr 24, 2023

@alequetzalli please have a look

@princerajpoot20
Copy link
Member

I would like to work on this.

@princerajpoot20
Copy link
Member

Hello, I have made the requested changes to fix minor typos and grammatical errors in the create-asyncapi-document.md file. I would appreciate it if someone could review my pull request.

@janvi01 , could you please take a look when you have a moment? Your feedback would be greatly appreciated. Thank you!

@janvi01
Copy link
Contributor Author

janvi01 commented Apr 26, 2023

Hey @princerajpoot20 Kindly stick to the guidelines. Before making a PR you should wait for the maintainer (@alequetzalli ) to approve this issue whether the changes are needed or not at the moment.

If the issue is approved, I would review your PR so kindly wait. Thanks.

@quetzalliwrites
Copy link
Member

Hey there @janvi01, I use Volta for notifications and I don't know how I didn't see this one before O_O .. so sorry about that! (Also, interviewing and onboarding the 2023 GSoD interns accidentally took up too much of my mental space, so I think that also caused my delay here, partially.. oops 😬✌🏽)

I just grabbed the content from that document and ran it through Grammarly and I too see some ideas of grammar improvements. Definitely feel free to open a PR and show us your take on how to improve some of the grammar choices.

Thank you again for reaching out and I hope we still get to see your contribution! ✨

@quetzalliwrites quetzalliwrites added the area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. label Jun 10, 2023
@quetzalliwrites quetzalliwrites moved this to In progress 😀👍🏽 in AsyncAPI Docs Board Jun 10, 2023
@janvi01
Copy link
Contributor Author

janvi01 commented Jun 13, 2023

Thanks @alequetzalli for assigning, I will create a PR soon.

@github-actions
Copy link

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Oct 12, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 2, 2024
@AnimeshKumar923
Copy link
Contributor

is this actually resolved? @alequetzalli @janvi01 @derberg
cc: @TRohit20 @Arya-Gupta @J0SAL

Copy link
Member

This is fine to remain closed.

@quetzalliwrites quetzalliwrites moved this from In progress 😀👍🏽 to Done 🚀 in AsyncAPI Docs Board Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 🐞 docs bug stale
Projects
Status: Done 🚀
5 participants