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

How can I get more documentations on using and configuring karavan? #743

Open
trickMin opened this issue Apr 23, 2023 · 3 comments
Open
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed question Further information is requested

Comments

@trickMin
Copy link

Karavan looks like a very interesting and powerful integration platform. I found the abundant documentations of camel-core on the official website, but did not see the relevant documentation of karavan. Is there any corresponding usage and component configuration guidance at present? What about the content planning of subsequent documents?

@davsclaus
Copy link
Contributor

What kind of documentation are you looking for?

A goal of karavan is to make the UI designer intuitive so users can start learning to use it by reading a little bit of docs, and then try some examples, play on their own etc. And watch existing videos etc.

Apache Camel in general is a large framework, and if you need to go deeper, then it takes time to master. For that the documentation on the Camel website can help, or for some users then buying one of the recent Camel books makes them get a lot more out of Camel than users whom dont do that.

ASF is an open community so help is very welcome.
https://camel.apache.org/community/contributing/

If you get more experienced with Karavan, then what others have done in the past, is to write their own blog post about their journey and share this with the internet. Its also possible to have a blog post published on the Camel website.
https://github.com/apache/camel-website

However back to your question. Can you elaborate a bit more what specific documentation you are looking for, with Karavan

@davsclaus davsclaus added documentation Improvements or additions to documentation question Further information is requested labels Apr 24, 2023
@trickMin
Copy link
Author

I have browsed the content on the Camel docs website (https://camel.apache.org/docs/) and found very detailed documentation for Camel-core and Camel-k. However, for Karavan, I only found the introduction documentation on the GitHub README.md.

I am sure that Karavan provides a wealth of visual components, but I do not know how to build a complete demo with them, such as configuring the runtime environment or exporting a usable program. I probably need a guide to help me get started with Karavan quickly. I think I can study more advanced and complex functions on my own.

I try runtime for Karavan, but VS code prompt "no application", How can I configure it?
image

There are three default modules in VS Code. What is the relation between RestAPI and Routes? If I configure Beans, where should I put the Bean class?
image

These are just a few examples I have cited, and there may be more. I have not found any relevant documentation to guide me on these issues. Therefore, I hope there is a step-by-step guide to help me use a complete integrated application with Karavan smoothly

mgubaidullin added a commit that referenced this issue Jul 20, 2023
mgubaidullin added a commit that referenced this issue Jul 20, 2023
mgubaidullin added a commit that referenced this issue Jul 20, 2023
@cdia8890
Copy link

@mgubaidullin is it possible to add a small explanation on how to configure and use Beans using Karavan UI? This will be a great help.

Thanks.

@mgubaidullin mgubaidullin added the help wanted Extra attention is needed label Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants