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 reply info #1716

Closed
quetzalliwrites opened this issue May 25, 2023 · 8 comments
Closed

docs: document adding reply info #1716

quetzalliwrites opened this issue May 25, 2023 · 8 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 stale

Comments

@quetzalliwrites
Copy link
Member

quetzalliwrites commented May 25, 2023

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 reply info - Add info about a reply to a message, explain when one is when the reply is known and hard coded in the spec, but can be dynamic.
@quetzalliwrites quetzalliwrites self-assigned this May 25, 2023
@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 May 25, 2023
@quetzalliwrites quetzalliwrites changed the title Adding reply info docs: document adding reply info May 25, 2023
@quetzalliwrites
Copy link
Member Author

assigned @TRohit20

@TRohit20
Copy link
Collaborator

Working on it!

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

@derberg
Copy link
Member

derberg commented Jul 20, 2023

@smoya reply is a new feature, so no way to base it on 2 😛

@TRohit20

@smoya
Copy link
Member

smoya commented Jul 20, 2023

@smoya reply is a new feature, so no way to base it on 2 😛

I think it is completely worth mentioning anyway. It is not required to be an expert on this matter (AsyncAPI v3) to document, and I assume not all people will know about all features on v3. Just by mentioning this, any contributor will understand the context and know, at least, where to check for documentation or even how to formulate the right questions.

Copy link
Member

derberg commented Jul 20, 2023

I think it is completely worth mentioning anyway. It is not required to be an expert on this matter (AsyncAPI v3) to document, and I assume not all people will know about all features on v3. Just by mentioning this, any contributor will understand the context and know, at least, where to check for documentation or even how to formulate the right questions.

😃 😃 😃
makes sense 😉

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 Jan 18, 2024
@TRohit20
Copy link
Collaborator

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

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 stale
Projects
Status: Done 🚀
Development

No branches or pull requests

4 participants