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]: suggestions on 'create-asyncapi-document.md' file #1945

Closed
1 task done
AnimeshKumar923 opened this issue Jul 14, 2023 · 14 comments · Fixed by #2860
Closed
1 task done

[📑 Docs]: suggestions on 'create-asyncapi-document.md' file #1945

AnimeshKumar923 opened this issue Jul 14, 2023 · 14 comments · Fixed by #2860
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers

Comments

@AnimeshKumar923
Copy link
Contributor

AnimeshKumar923 commented Jul 14, 2023

What Dev Docs changes are you proposing?

I have some questions and suggestions to discuss that may improve this doc:

  • Can this line be changed at the end from environmental lighting to environmental lighting conditions as the same is given here?

  • Can the Event-driven architecture (EDA) here put in bold letters?

  • Removing one extra full stop (.) from the end of this line

  • The d in the Id here can capitalized.

  • Let's break it down into pieces: can be changed to Let's break the above code snippet down into pieces: here

  • lets can be changed to let's here

  • Also on the same line as above, This section is used to describe the event names your API will be publishing and/or subscribing to., we can change it to This section is used to describe the event names that your API will be publishing and/or subscribing to.

  • Next is the payload property which is used to understand how the event should look like when publishing to that channel: it can be changed to Next is the payload property. It is used to understand how the event should look like when publishing to that channel here

cc: @alequetzalli @derberg @thulieblack

Code of Conduct

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

/gfi docs

@asyncapi-bot asyncapi-bot added area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. good first issue Good for newcomers labels Jul 14, 2023
@depleur
Copy link

depleur commented Jul 14, 2023

I can work on this if no one else is interested.

@AnimeshKumar923
Copy link
Contributor Author

AnimeshKumar923 commented Jul 14, 2023

I can work on this if no one else is interested.

@depleur
We have to discuss with the maintainers about the changes that I've proposed above.
After that we can decide whether to work on this or not.

@thulieblack please give your feedback on the changes proposed 👀
cc: @Mayaleeeee

@AnimeshKumar923
Copy link
Contributor Author

/enhancement

@alaminthetrustworthy
Copy link
Contributor

@AnimeshKumar923 I would like to work on this issue, if was not assigned to anyone.

@AnimeshKumar923
Copy link
Contributor Author

@AnimeshKumar923 I would like to work on this issue, if was not assigned to anyone.

@alaminthespecial We have to discuss with the maintainers about the changes that I've proposed above.
After that we can decide whether to work on this or not.

@TheEques
Copy link
Contributor

Hey @AnimeshKumar923, any reply from the maintainers?
If yes, I would like to work on this issue

@AnimeshKumar923
Copy link
Contributor Author

AnimeshKumar923 commented Sep 11, 2023

@TheEques
Not right now, as there are more important issues to tackle.
Let's wait a little more before proceeding with this.
This comes under enhancement hence it can be delayed a bit.

@akshitdevelper
Copy link

akshitdevelper commented Dec 8, 2023

Hey @AnimeshKumar923 any progress on the issue status. LMK if it is up for any implementation.

@puwun
Copy link

puwun commented Jan 7, 2024

can you please assign me this issue?

@AnimeshKumar923
Copy link
Contributor Author

AnimeshKumar923 commented Jan 7, 2024

@puwun @akshitdevelper currently waiting for feedback from @alequetzalli
you can see earlier comments for more context on this issue

@demoiverrakada
Copy link

@AnimeshKumar923 , Hi , I am looking for some good first issue to solve, and i guess, i can do i it properly, if possible, can you assign this issue to me, it would be a great help.

@AnimeshKumar923
Copy link
Contributor Author

@demoiverrakada please see this comment for context.
Please see the issues section for some other good first issues

@quetzalliwrites
Copy link
Member

Heyo, stuff like bolding and italicizing randomly goes against our style guide. That said, thank you for taking the time to propose some ideas! Accepted @sharmaachintya08's PR so we can finally close this one 😸

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 good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

9 participants