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 adding channel #1510

Closed
1 task done
quetzalliwrites opened this issue Apr 6, 2023 · 4 comments
Closed
1 task done

[📑 Docs]: document adding channel #1510

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

  • Adding channel - Explain the purpose of channels, different names for it, and what users should put here. Add a simple channel there, and explain how it relates to the server. If you specify a channel and server, it is expected that a given channel is present on all servers. Explain that the channel can also specify that it is present only on server A or server B.

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

@mhmohona assigned

@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.

@mhmohona
Copy link
Contributor

Submitted PR for it.

@TRohit20
Copy link
Collaborator

TRohit20 commented Mar 5, 2024

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

@TRohit20 TRohit20 closed this as completed Mar 5, 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: Changes proposed 📄
Development

No branches or pull requests

4 participants