[📑 Docs]: How to group messages and sidebar using Tags

[TheLand]

What Dev Docs changes are you proposing?

Hi all,

I think it could be useful if you explain better how to use Tags to improve operations and messages grouping. In the documentation there isn't an example and I cannot understand how to get it.

I had a list of Tags in the asyncapi.yaml root file and then in the root messages, badges are appearing but:

1. They seem clickable but, when I click on them, nothing happens
2. Sidebar is not grouped and I don't understand how sidebarOrganization must be used with the CLI

Thank you in advance!

Code of Conduct

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

[github-actions[bot]]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[fmvilas]

Should this issue be in https://github.com/asyncapi/html-template/#supported-parameters? What do you think @alequetzalli?

[magicmatatjahu]

@TheLand

Tags should actually be described in one of the tutorials and an example given of how to use them for grouping a message etc (cc @alequetzalli), however:

• we have to specify that html-template has nothing to do with the specification itself, but only serves to display it in a nice way, so please note that html-template is not a good source for AsyncAPI "best practices".

• They seem clickable but, when I click on them, nothing happens

  They are clickable only when you provide for them externalDocs field and by click you open in new tab link passed by externalDocs.

• Sidebar is not grouped and I don't understand how sidebarOrganization must be used with the CLI.

  You have to define parameter by ag ./asyncapi.yaml @asyncapi/html-template -p sidebarOrganization= {byTags | byTagsNoRoot}. Atm we don' support grouping sidebar by tags in the messages, but only in the operations and in root of document.

[TheLand]

Thank you @magicmatatjahu ! Maybe would html-template be implemented following the AsyncAPI "best practices"? Otherwise it could be "auto-disruptive" for developers who use the default html-template generator to show their documentation.

[magicmatatjahu]

@TheLand No problem :)

The question is what best practices would be. Currently, sidebarOrganization is an old feature that one person in the community needed and we may remove it in the future (I don't know). First we need to define such best practices and then we can move them to html-template :)

[glowreeya-01]

Hello, can I please work on this?

[derberg]

I'm not sure what is the core of the problem here 😄 do we need to update something in README.md of html-template to make it clear how is sidebarOrganization working atm?

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

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 :heart:

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

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 :heart:

[Nabanita29]

I can work on this if available!