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]: document extending the AsyncAPI specification #1519

Closed
1 task done
quetzalliwrites opened this issue Apr 6, 2023 · 3 comments · Fixed by #2407
Closed
1 task done

[📑 Docs]: document extending the AsyncAPI specification #1519

quetzalliwrites opened this issue Apr 6, 2023 · 3 comments · Fixed by #2407
Assignees
@mhmohona @quetzalliwrites
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs gsod This label should be used for issues or discussions related to ideas for Google Season of Docs

Comments

@quetzalliwrites
Copy link
Member

What Dev Docs changes are you proposing?

As part of Google Season of Docs 2023 at AsyncAPI, we're going to write in-depth explanations of the different sections of an AsyncAPI document to avoid difficulties in implementing EDAs.

This task is part of the Docs EPIC: #1507.

For this issue, we'll cover:

  • Extending AsyncAPI specification - Explain what to do when the specification does not yet support something you need, some field is missing, and more.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@quetzalliwrites quetzalliwrites added 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. gsod This label should be used for issues or discussions related to ideas for Google Season of Docs labels Apr 6, 2023
@quetzalliwrites quetzalliwrites self-assigned this Apr 6, 2023
@quetzalliwrites quetzalliwrites moved this to Changes proposed 📄 ✨✨ in AsyncAPI Docs Board Apr 6, 2023
@quetzalliwrites quetzalliwrites mentioned this issue Apr 6, 2023
Closed
18 tasks
@quetzalliwrites
Copy link
Member Author

assigned @mhmohona

@mhmohona mhmohona mentioned this issue Jul 18, 2023
Closed
@smoya
Copy link
Member

smoya commented Jul 20, 2023

I suggest we clarify in the description of this issue that this doc should be based on AsyncAPI Spec version 3.

@quetzalliwrites quetzalliwrites moved this from Changes proposed 📄 ✨✨ to In progress 😀👍🏽 in AsyncAPI Docs Board Aug 17, 2023
@mhmohona
Copy link
Contributor

Submitted PR for it.

@quetzalliwrites quetzalliwrites assigned mhmohona and unassigned mhmohona Sep 1, 2023
@mhmohona mhmohona mentioned this issue Dec 8, 2023
Merged
@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
Assignees

@mhmohona mhmohona

@quetzalliwrites quetzalliwrites

Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs gsod This label should be used for issues or discussions related to ideas for Google Season of Docs
Projects
AsyncAPI Docs Board
Status: Done 🚀
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: adding document for extending the AsyncAPI specification mhmohona/asyncapi-website
3 participants
@smoya @mhmohona @quetzalliwrites