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: moving root properties tags and externalDocs to info #1439

Closed
Tracked by #1433 ...
quetzalliwrites opened this issue Mar 15, 2023 · 4 comments
Closed
Tracked by #1433 ...

docs: moving root properties tags and externalDocs to info #1439

quetzalliwrites opened this issue Mar 15, 2023 · 4 comments
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs stale

Comments

@quetzalliwrites
Copy link
Member

quetzalliwrites commented Mar 15, 2023

Per the scheduled release of spec 3.0 on June 2023, a major update to AsyncAPI docs is needed.

To this end, Jonas added a discussion point for Docs to upcoming Spec 3.0 community meetings. We'll use this time to help guide and support the community contributors who help us document these changes in docs in the weeks leading to the June release.


Overview of spec 3.0 release changes that require documentation in this task:


⚠️ PLEASE NOTE:
Each of these tasks converted to issues does not imply a single PR; the community should expect to review multiple PRs PER task issue because each spec change introduces updates across all Docs content buckets. (i.e., The request/reply change introduces a need to create a Concepts doc, document further in upcoming new Spec 3.0 docs, and implies huge changes to current tutorials.)

@quetzalliwrites quetzalliwrites changed the title Moving root properties tags and externalDocs to info docs: moving root properties tags and externalDocs to info Apr 4, 2023
@quetzalliwrites quetzalliwrites added 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Apr 4, 2023
@quetzalliwrites quetzalliwrites moved this to Changes proposed 📄 ✨✨ in AsyncAPI Docs Board Apr 4, 2023
@jonaslagoni
Copy link
Member

@magicmatatjahu as you were the champion, would you be able to kick-start this issue with TLDR with links to additional resources to study the change further?

If you do not have the bandwidth for this, please let me know 🙂

@smoya
Copy link
Member

smoya commented May 4, 2023

This new change is pretty much straightforward; moving a couple of fields from the root document to the Info object.
Do we really need anything else regarding docs than just the changes in the spec? I don't think so.

WDYT? cc @magicmatatjahu @alequetzalli @jonaslagoni

@magicmatatjahu
Copy link
Member

magicmatatjahu commented May 4, 2023

I don't think so, it's just moving some fields from root to info object as you wrote :)

@github-actions
Copy link

github-actions bot commented Sep 2, 2023

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 Sep 2, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 7, 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 stale
Projects
Status: Changes proposed 📄
Development

No branches or pull requests

4 participants