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]: document organizing an AsyncAPI document with tags #1518

Closed
1 task done
quetzalliwrites opened this issue Apr 6, 2023 · 4 comments
Closed
1 task done
Assignees
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:

  • Organizing document with tags - Explain different tags info in different parts of AsyncAPI and their purpose.

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

assigned @TRohit20

@TRohit20
Copy link
Collaborator

Working on it

@quetzalliwrites quetzalliwrites moved this from Changes proposed 📄 ✨✨ to In progress 😀👍🏽 in AsyncAPI Docs Board Jul 12, 2023
@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.

@TRohit20
Copy link
Collaborator

The issue in context is now resolved as PR #1957(merged) adds the document intended to the AsyncAPI website. Hence, closing the issue.

@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 gsod This label should be used for issues or discussions related to ideas for Google Season of Docs
Projects
Status: Done 🚀
Development

No branches or pull requests

3 participants