asyncapi / chatbot Goto Github PK

There're some inbuilt validations in place already, but we need to also utilize the existing validation library

Reason/Context

Current bot output when generating an AsyncAPI file is the plain text representation of it.
This won't show up pretty well especially because AsyncAPI files could be big.

Description

Instead, show a URL to the Studio https://github.com/asyncapi/studio that loads the resulting AsyncAPI file into it.

Note: The feature of shared URL's on the Studio is not yet developed. See asyncapi/studio#127

I'd love to see suggestions on how to structure the questions that can be asked by the bot about generating a valid asyncapi document

This issue defines a list of tasks that need to be performed in this repo to make sure it's ci/cd automation works long term without any issues.

It is up to maintainers to decide if it must be addressed in one or multiple PRs.

Below are 3 different sections describing 3 different important ci/cd changes.

IMPORTANT-START
For GitHub workflows that contain This workflow is centrally managed in https://github.com/asyncapi/.github/ you do not have to perform any work. These workflows were already updated through the update in .github. The only exception is the workflows related to nodejs release. More details in Upgrade Release pipeline - in case of nodejs projects section
IMPORTANT-END

Deprecation of way data is shared between steps

Every single GitHub Action workflow that has echo "::set-output name={name}::{value}" need to be updated to follow echo "{name}={value}" >> $GITHUB_OUTPUT

We do not yet know when set-output will stop working. Previous disable date was 31.05 but now then say community needs more time.

For more details read official article from GitHub

Deprecation of node12

2nd bullet point is still relevant for you even if your projects in not nodejs project

• Every single workflow that uses setup-node action needs an update to follow v3 version of this action, and make sure minimum node 14 is used
• Now this part is more complex. Problem with node12 is that node-based GitHub Actions were using it in majority as a runtime environment. Look for example at this action.yaml file for setup-node action v2. So the job that you have to do is go through all the workflows, and verify every single action that you use, make sure you are using the latest version that is not based on node12. I already did review a lot of actions as part of this PR so maybe you will find some actions there and can copy from me. For example action/checkout needs to be updated to v3.

Node12 end of support in action is probably September 27th.

For more details read official article from GitHub

Upgrade Release pipeline - in case of nodejs projects

ignore this section if your project is not nodejs project

You have 2 options. You can:

A. choose to switch to new release pipeline using instruction from asyncapi/.github#205

B. stay with old release pipeline, and manually update GitHub workflows and actions used in it, you can inspire a lot from this PR asyncapi/.github#226

I definitely recommend going with A

Workflows related to release:

• .github/workflows/if-nodejs-release.yml
• .github/workflows/if-nodejs-version-bump.yml
• .github/workflows/bump.yml

@AceTheCreator and I have been discussing ways to rebuild our chatbot using new LLM technologies. Our Idea is to train an LLM model on our spec and tools documentation so that it can accurately answer questions related to AsyncAPI.

The project is however in the very early stage, and we still have to figure out a lot of things, I am opening this Issue so that we can openly plan the project and others in the community can collaborate.

Reason/Context

Parser-JS requires now Node.js 14 and npm7 or higher.
This means package-lock.json version should be always set to 2.

Description

In order to unify development requirements, I suggest all repositories to stick with that requirements. In order to do that, the following is needed:

• Clarify this requirement under Development section on this repository README file.
• To update package-lock.json to version 2. This is automatically done when running npm install if the npm version used is 7 or higher.

Related:

• asyncapi/.github#177

We've decided to release a beta version of the AsyncAPI Chatbot with the ability to enable chatbot support for Studio and Website and CLI and others.

The following is a list of proposed features for the beta release:
Target release date: March 2022

The following list is categorized into 3 sections and is arranged in the level of importance.

AI

• Data migration from WIT.AI to Rasa AI
• What it will cost to fully migrate to Rasa AI
• Train Chatbot

SERVER

• Write AsyncAPI file for the chatbot WebSocket API server
• Bootstrap glee project using the chatbot AsyncAPI file
• Migration of the business logic from the old server to the new server
• Docker support
• Deployment to Digitalocean
• Add support for JSON Schema model
• Chatbot capacity to help lift question burden off Lukasz

CLIENT

• Remove custom CLI from chatbot repo
• Add new command to AsyncAPI CLI (“start chatbot”)
• Enhance Chatbot User Interface
• #60

Hello 👋
We need ideas on the kind of questions that is most likely to be asked from Lukasz(name of the bot) about anything related to asyncapi

• Readme makes promises that were not realized since 13months. We should remove them
• Remove extra <br> from the headers
• About the project rename to Overview
• Add link in Contributing section

It would be of great Ideal if the documentation entails details of how users can test the chatbot using docker

@AceTheCreator I think it is a time to officially plan archiving of this project - nothing really happens here and it never really got out of PoC

Hello 👋. We need suggestions on how Lukasz's (it's the name of the chatbot) first engagement message should be 🙏🏻.

Lukasz just currently introduces himself by saying Hello I'm Lukasz, I can help you out writing an AsyncAPI document. Try me!. So I need suggestions on how Lukasz can make the user engage with him.

Our initial suggestion is Lukasz should ask the user Would you love to generate an asyncapi document or you wanna ask a question about asyncapi?