Doc improvements #743

apache · Jul 20, 2023 · 6860bda · 6860bda
1 parent c6cb42c
commit 6860bda
Show file tree

Hide file tree

Showing 43 changed files with 143 additions and 66 deletions.
diff --git a/DEV.md b/DEV.md
diff --git a/README.md b/README.md
@@ -19,32 +19,9 @@ Integrations could be created using visual designer that includes Enterprise Int
 
 https://user-images.githubusercontent.com/1379213/211049026-4496d054-d529-4917-837f-a59b6f2f84b1.mp4
 
-
-## Installation
-
-Two types of applications are available: 
-1. [Cloud-native](karavan-cloud/README.md) application deployed into Kubernetes/OpenShift 
-2. [VS Code extension](karavan-vscode/README.md) available on the [Marketplace](https://marketplace.visualstudio.com/items?itemName=camel-karavan.karavan). Extensions for VS Code Compatible Editors available on [Open VSX Registry](https://open-vsx.org/extension/camel-karavan/karavan)
-
-Both applications share same visual designer and work with Camel YAMl DSL.
-
-## Karavan cloud-native application
-Karavan cloud-native integration toolkit is an application to manage projects, design and monitor integrations, Tekton pipeline to build and deploy integrations. More about [cloud-native Karavan](karavan-cloud/README.md)
-
-![karavan-ipaas-1](images/karavan-ipaas-1.png)
-
-
-## Karavan VS Code extension
-Install Karavan VS Code extension from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=camel-karavan.karavan) or from [Open VSX Registry](https://open-vsx.org/extension/camel-karavan/karavan)
-
-More about [Karavan VS Code Extension](karavan-vscode/README.md)
-
-![karavan-vscode](images/karavan-vscode.png)
-
-
 ## Features
 ### Mode
-* [Cloud-native](karavan-cloud/README.md)
+* [Web application](karavan-cloud/README.md)
 * [VS Code extension](karavan-vscode/README.md)
 ### Visual Designer for Integrations
 * Enterprise Integration Patterns DSL
@@ -61,11 +38,11 @@ More about [Karavan VS Code Extension](karavan-vscode/README.md)
 ### Build and Deploy
 * Maven for local development
 * Tekton Pipelines for Kubernetes/OpenShift
-### Documentation
+### Knowledgebase
 Build-in catalogues:
 * Enterprise Integration Patterns
 * Kamelets
 * Components
 
-## Development
-How to build [Karavan](DEV.md)
+## Documentation
+[Karavan documentation](docs/INDEX.md)
diff --git a/karavan-web/docs/AWS.md → docs/AWS.md b/karavan-web/docs/AWS.md → docs/AWS.md
diff --git a/...eb/docs/AWS/karavan-acl-environments.yaml → docs/AWS/karavan-acl-environments.yaml b/...eb/docs/AWS/karavan-acl-environments.yaml → docs/AWS/karavan-acl-environments.yaml
diff --git a/karavan-web/docs/AWS/karavan-acl.yaml → docs/AWS/karavan-acl.yaml b/karavan-web/docs/AWS/karavan-acl.yaml → docs/AWS/karavan-acl.yaml
diff --git a/...cs/AWS/karavan-app-deployment-public.yaml → docs/AWS/karavan-app-deployment-public.yaml b/...cs/AWS/karavan-app-deployment-public.yaml → docs/AWS/karavan-app-deployment-public.yaml
diff --git a/...van-web/docs/AWS/karavan-app-ingress.yaml → docs/AWS/karavan-app-ingress.yaml b/...van-web/docs/AWS/karavan-app-ingress.yaml → docs/AWS/karavan-app-ingress.yaml
diff --git a/...cs/AWS/karavan-app-service-node-port.yaml → docs/AWS/karavan-app-service-node-port.yaml b/...cs/AWS/karavan-app-service-node-port.yaml → docs/AWS/karavan-app-service-node-port.yaml
diff --git a/karavan-web/docs/AWS/karavan-pvc.yaml → docs/AWS/karavan-pvc.yaml b/karavan-web/docs/AWS/karavan-pvc.yaml → docs/AWS/karavan-pvc.yaml
diff --git a/...eb/docs/AWS/karavan-quarkus-pipeline.yaml → docs/AWS/karavan-quarkus-pipeline.yaml b/...eb/docs/AWS/karavan-quarkus-pipeline.yaml → docs/AWS/karavan-quarkus-pipeline.yaml
diff --git a/...eb/docs/AWS/karavan-quarkus-task-aws.yaml → docs/AWS/karavan-quarkus-task-aws.yaml b/...eb/docs/AWS/karavan-quarkus-task-aws.yaml → docs/AWS/karavan-quarkus-task-aws.yaml
diff --git a/karavan-web/docs/AWS/karavan-sc.yaml → docs/AWS/karavan-sc.yaml b/karavan-web/docs/AWS/karavan-sc.yaml → docs/AWS/karavan-sc.yaml
diff --git a/karavan-web/docs/AWS/karavan-secret.yaml → docs/AWS/karavan-secret.yaml b/karavan-web/docs/AWS/karavan-secret.yaml → docs/AWS/karavan-secret.yaml
diff --git a/...ocs/AWS/karavan-spring-boot-pipeline.yaml → docs/AWS/karavan-spring-boot-pipeline.yaml b/...ocs/AWS/karavan-spring-boot-pipeline.yaml → docs/AWS/karavan-spring-boot-pipeline.yaml
diff --git a/...ocs/AWS/karavan-spring-boot-task-aws.yaml → docs/AWS/karavan-spring-boot-task-aws.yaml b/...ocs/AWS/karavan-spring-boot-task-aws.yaml → docs/AWS/karavan-spring-boot-task-aws.yaml
diff --git a/karavan-web/docs/AWS/kustomization.yaml → docs/AWS/kustomization.yaml b/karavan-web/docs/AWS/kustomization.yaml → docs/AWS/kustomization.yaml
diff --git a/...eb/docs/AWS/pipeline-service-account.yaml → docs/AWS/pipeline-service-account.yaml b/...eb/docs/AWS/pipeline-service-account.yaml → docs/AWS/pipeline-service-account.yaml
diff --git a/docs/DEV.md b/docs/DEV.md
@@ -0,0 +1,55 @@
+## Project structure
+1. karavan-generator  
+Generate Camel Models and Api from Camel sources to Typescript in karavan-core
+2. karavan-core  
+Front-end Camel Models and Api
+3. karavan-Designer  
+KaravanDesigner UI component
+4. karavan-web  
+Karavan Cloud Application
+    * karavan-app
+    Karavan Application to be installed into Kubernetes
+    * karavan-cli
+    Karavan CLI to install into Kubernetes
+    * karavan-operator
+    Karavan Operator to install into Openshift
+5. karavan-vscode  
+VS Code extension based on Karavan Designer
+
+## How to build Karavan Web Application
+1. Generate Camel Models and API for Typescript
+```
+mvn clean compile exec:java -Dexec.mainClass="org.apache.camel.karavan.generator.KaravanGenerator" -f karavan-generator
+```
+
+2. Install Karavan core library
+```
+cd  karavan-core
+npm install
+```
+
+3. Build Karavan app  
+```
+cd karavan-web
+mvn clean package -f karavan-app -Dquarkus.profile=public 
+```
+
+## How to build Karavan VS Code extension
+1. Generate Camel Models and API for Typescript
+```
+mvn clean compile exec:java -Dexec.mainClass="org.apache.camel.karavan.generator.KaravanGenerator" -f karavan-generator
+```
+
+2. Install Karavan core library
+```
+cd  karavan-core
+npm install
+```
+
+3. Build Karavan VS Code extension  
+```
+cd karavan-vscode
+npm update && npm install 
+npm install -g @vscode/vsce
+vsce package
+```
diff --git a/docs/INDEX.md b/docs/INDEX.md
@@ -0,0 +1,27 @@
+![karavan-logo](../images/karavan-logo-dark.png#gh-dark-mode-only)
+![karavan-logo](../images/karavan-logo-light.png#gh-light-mode-only)
+
+# Documentation
+
+## User guide
+
+### Web Application
+
+Karavan Web Application is a container deployed into Kubernetes/OpenShift 
+
+1. [Install](WEB_INSTALL.md)
+2. [How to use](WEB_HOWTO.md)
+
+### VS Code extensions
+
+VS Code extension available on the [Marketplace](https://marketplace.visualstudio.com/items?itemName=camel-karavan.karavan). 
+
+Extensions for VS Code Compatible Editors available on [Open VSX Registry](https://open-vsx.org/extension/camel-karavan/karavan)
+
+1. [Install](VSCODE_INSTALL.md)
+2. [How to use](VSCODE_HOWTO.md)
+
+
+## Developer Guide
+
+1. [How to build Karavan](DEV.md)
diff --git a/karavan-web/karavan-cli/INFINISPAN.md → docs/INFINISPAN.md b/karavan-web/karavan-cli/INFINISPAN.md → docs/INFINISPAN.md
diff --git a/karavan-web/docs/MINIKUBE.md → docs/MINIKUBE.md b/karavan-web/docs/MINIKUBE.md → docs/MINIKUBE.md
diff --git a/karavan-web/docs/OPENSHIFT.md → docs/OPENSHIFT.md b/karavan-web/docs/OPENSHIFT.md → docs/OPENSHIFT.md
diff --git a/karavan-web/docs/OPENSHIFT_DEMO.md → docs/OPENSHIFT_DEMO.md b/karavan-web/docs/OPENSHIFT_DEMO.md → docs/OPENSHIFT_DEMO.md
diff --git a/karavan-web/docs/README.md → docs/README.md b/karavan-web/docs/README.md → docs/README.md
diff --git a/ROADMAP.md → docs/ROADMAP.md b/ROADMAP.md → docs/ROADMAP.md
diff --git a/docs/VSCODE_HOWTO.md b/docs/VSCODE_HOWTO.md
@@ -0,0 +1,36 @@
+# Create and edit integration 
+
+## Create new Integration
+
+![create](../images/create.png)
+
+## Edit an existing Integration
+
+![open](../images/open.png)
+
+
+# Run integration
+
+## Run integration locally
+* Run in UI: click `Run` button 
+
+![run](../images/run.png)
+
+* Run using CLI
+    ```shell
+    jbang -Dcamel.jbang.version=3.21.0 camel@apache/camel run $INTEGRATION.yaml --max-messages=10 --logging-level=info
+    ```
+
+## Export integration to Maven project
+
+* Export using context menu
+![export](../images/export.png)
+
+* Export using CLI
+    ```shell
+    jbang -Dcamel.jbang.version=3.21.0 camel@apache/camel export --directory=export
+    ```
+
+# Issues
+
+If you find a new issue, please [create a new issue report in GitHub](https://github.com/apache/camel-karavan/issues)!
diff --git a/docs/VSCODE_INSTALL.md b/docs/VSCODE_INSTALL.md
@@ -0,0 +1,13 @@
+# Installation
+
+## Prerequisites
+* Microsoft VS Code installed. You can get the most recent version from (https://code.visualstudio.com/) for your chosen operating system.
+* [Camel JBang] installed(https://camel.apache.org/manual/camel-jbang.html)
+
+## How to install
+1. Open your VS Code Integrated Development Environment (IDE).
+2. In the VS Code Activity Bar, select Extensions. (Alternatively, press Ctrl+Shift+X).
+3. In the search bar, type **Karavan**
+4. In the **Apache Camel Karavan** box, click **Install**.
+
+![install](../images/install.png)
diff --git a/docs/WEB_HOWTO.md b/docs/WEB_HOWTO.md
@@ -0,0 +1,6 @@
+## How to use Karavan
+
+
+[![Watch the video](https://img.youtube.com/vi/trsZyzEvbWw/default.jpg)](https://youtu.be/trsZyzEvbWw)
+
+
diff --git a/karavan-web/karavan-cli/CLI.md → docs/WEB_INSTALL.md b/karavan-web/karavan-cli/CLI.md → docs/WEB_INSTALL.md
@@ -1,4 +1,4 @@
-## Install Karavan with CLI
+## Install Karavan Web Application with CLI
 
 ### Requirements
 1. minikube v1.30+ installed with `--driver=hyperkit`

diff --git a/...van-web/docs/keycloack/karavan-realm.json → docs/keycloack/karavan-realm.json b/...van-web/docs/keycloack/karavan-realm.json → docs/keycloack/karavan-realm.json
diff --git a/...eb/docs/minikube/karavan-app-ingress.yaml → docs/minikube/karavan-app-ingress.yaml b/...eb/docs/minikube/karavan-app-ingress.yaml → docs/minikube/karavan-app-ingress.yaml
diff --git a/...van-web/docs/minikube/karavan-secret.yaml → docs/minikube/karavan-secret.yaml b/...van-web/docs/minikube/karavan-secret.yaml → docs/minikube/karavan-secret.yaml
diff --git a/karavan-web/docs/minikube/karavan.yaml → docs/minikube/karavan.yaml b/karavan-web/docs/minikube/karavan.yaml → docs/minikube/karavan.yaml
diff --git a/karavan-web/docs/openshift/catalog.yaml → docs/openshift/catalog.yaml b/karavan-web/docs/openshift/catalog.yaml → docs/openshift/catalog.yaml
diff --git a/...an-web/docs/openshift/gitea-operator.yaml → docs/openshift/gitea-operator.yaml b/...an-web/docs/openshift/gitea-operator.yaml → docs/openshift/gitea-operator.yaml
diff --git a/karavan-web/docs/openshift/gitea.yaml → docs/openshift/gitea.yaml b/karavan-web/docs/openshift/gitea.yaml → docs/openshift/gitea.yaml
diff --git a/...-web/docs/openshift/karavan-operator.yaml → docs/openshift/karavan-operator.yaml b/...-web/docs/openshift/karavan-operator.yaml → docs/openshift/karavan-operator.yaml
diff --git a/...an-web/docs/openshift/karavan-secret.yaml → docs/openshift/karavan-secret.yaml b/...an-web/docs/openshift/karavan-secret.yaml → docs/openshift/karavan-secret.yaml
diff --git a/karavan-web/docs/openshift/karavan.yaml → docs/openshift/karavan.yaml b/karavan-web/docs/openshift/karavan.yaml → docs/openshift/karavan.yaml
diff --git a/...web/docs/openshift/pipeline-operator.yaml → docs/openshift/pipeline-operator.yaml b/...web/docs/openshift/pipeline-operator.yaml → docs/openshift/pipeline-operator.yaml
diff --git a/images/export.png b/images/export.png
diff --git a/images/run.png b/images/run.png
diff --git a/karavan-vscode/README.md b/karavan-vscode/README.md
@@ -26,7 +26,7 @@ Integration project output is a runnable uber-jar or an OCI image for local envi
 ### Runtimes
 * [Camel JBang](https://camel.apache.org/manual/camel-jbang.html)
 * [Camel Quarkus](https://camel.apache.org/camel-quarkus)
-* [Camel Spring-Boot](https://camel.apache.org/camel-spring-boot) (WIP)
+* [Camel Spring-Boot](https://camel.apache.org/camel-spring-boot)
 * [Camel Main](https://camel.apache.org/components/3.18.x/others/main.html) (WIP)
 ### Build and Deploy
 * Maven for local development