spec icon indicating copy to clipboard operation
spec copied to clipboard

Adding some new tools to the list

Open jemacineiras opened this issue 3 years ago • 7 comments
trafficstars

Hi community,

here at Corunet by Sngular are developing some interesting tools using your awesome specification. They are close to mature, so we want to share them with you. If you consider them interesting to add them to your available tool list, we will be pleased.

Maven plugin to generate Spring cloud stream code base on Asyncapi and OpenApi https://github.com/corunet/scs-multiapi-plugin

Maven plugin to generate Spring cloud Contracts base on Asyncapi and OpenApi https://github.com/corunet/scc-multiapi-converter

Cheers

jemacineiras avatar Jun 24 '22 07:06 jemacineiras

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.

github-actions[bot] avatar Jun 24 '22 07:06 github-actions[bot]

@jemacineiras Hi! We are happy with these projects! If you wanna add them to our list, you should update that md file and create PR https://github.com/asyncapi/website/blob/master/pages/docs/tools/index.md Let me know if you will have any problems :) Of course, if you won't find appropriate category, please create the new one.

magicmatatjahu avatar Jun 24 '22 09:06 magicmatatjahu

Side comment: really cool to see my fellow Spanish devs contributing to AsyncAPI 🙌

fmvilas avatar Jun 24 '22 10:06 fmvilas

Hey @jemacineiras nice to see that you want to add tools and contribute to the AsyncAPI. Recently, we have a project idea Create a new page for /tools/ to list all the tools of AsyncAPI, whether they are maintained inside the organization or maintained by external contributors. You can hope on to the issue https://github.com/asyncapi/website/issues/383 to see the plan discussed by me, @magicmatatjahu and @derberg. So, the approach for adding new tools to the website are as follows:

We are planning to add a file .asyncapi-tool in the tool repo which will help us to identify the tool via GitHub API and thus collect the information related to the tool on the basis of the meta data present in the file. Thus, in this way, you can add the tools to the list easily. We are on the way to start implementing this approach, I just need feedback from you on whether it will be fine from your perspective to add a file in the tool to recognize and add it to the list on the website.

If you are not suitable with the above approach, we also have an alternative to this, but the above one will be considered as primary. Thanks.

akshatnema avatar Jun 30 '22 07:06 akshatnema

Hi @akshatnema,

The proposed solution looks interesting, if the tool is only using asyncapi, but in our case, our tools give support for openapi and asyncapi, and we don't like to attach the project to only one API solution, just in case openapi decide the same, or we want to integrate future solutions...

So we prefer the second approach, what your thoughts about?

Cheers!

jemacineiras avatar Jul 04 '22 06:07 jemacineiras

Fine, thanks for your feedback. So, if you prefer the second approach, you need to add the details of your tool in a markdown file in the website in the website, with the appropriate technologies used and the links of the tool. That markdown information will be converted to JSON and then rendered on the website as other tools. Right now, the format of the markdown file has not been decided yet and we are proceeding with the first approach right now.

The reason why we primarily focus on first is that we want the tools to be discovered automatically using API searching instead of manually adding them to the website repository. Hence, we are forwarding that. @derberg, anything more you want to add?

akshatnema avatar Jul 04 '22 07:07 akshatnema

@akshatnema lgtm, we know some folks will prefer the manual way of adding tools to the list, this is fine. @jemacineiras just like @magicmatatjahu mentioned, open a PR against this file https://github.com/asyncapi/website/blob/master/pages/docs/tools/index.md to add your tool to the list

derberg avatar Jul 04 '22 13:07 derberg

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] avatar Nov 02 '22 00:11 github-actions[bot]