[📑 Docs]: document AsyncAPI reusable parts

[quetzalliwrites]

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:

• AsyncAPI reusable parts - Explain the $ref concept, introduce and explain that $ref can point to the same document, other documents in a local system, and external URLs.

Code of Conduct

• I agree to follow this project's Code of Conduct

[quetzalliwrites]

Assigned to @kakabisht

[smoya]

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

[github-actions]

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 ❤️

[TRohit20]

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