This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-k.git
The following commit(s) were added to refs/heads/master by this push:
new ea74e66 Polished docs
ea74e66 is described below
commit ea74e66e349223d4719645ea9611f1b648dab0f0
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Thu May 28 06:54:35 2020 +0200
Polished docs
---
docs/modules/ROOT/pages/cli/cli.adoc | 8 +++++-
docs/modules/ROOT/pages/developers.adoc | 45 ++++++++++++++++++-------------
docs/modules/ROOT/pages/uninstalling.adoc | 15 ++++++-----
3 files changed, 43 insertions(+), 25 deletions(-)
diff --git a/docs/modules/ROOT/pages/cli/cli.adoc
b/docs/modules/ROOT/pages/cli/cli.adoc
index a388d17..b90044c 100644
--- a/docs/modules/ROOT/pages/cli/cli.adoc
+++ b/docs/modules/ROOT/pages/cli/cli.adoc
@@ -21,7 +21,7 @@ Some of the most used commands are:
|`kamel help`
|init
-|Initialize empty Camel K files
+|Initialize empty Camel K files (besides Java you can also do this for other
languages like Groovy, Kotlin, XML, YMAL)
|`kamel init Routes.java`
|run
@@ -47,6 +47,12 @@ Some of the most used commands are:
|===
The list above is not the full list of available commands. You can run `kamel
help` to obtain the full list.
+And each command also takes `--help` as parameter to output more information,
eg
+
+[source]
+----
+kamel run --help
+----
== Modeline
diff --git a/docs/modules/ROOT/pages/developers.adoc
b/docs/modules/ROOT/pages/developers.adoc
index 97ef744..c3664dc 100644
--- a/docs/modules/ROOT/pages/developers.adoc
+++ b/docs/modules/ROOT/pages/developers.adoc
@@ -59,9 +59,10 @@ This is a high-level overview of the project structure:
To build the whole project you now need to run:
-```
+[source]
+----
make
-```
+----
This execute a full build of both the Java and Go code. If you need to build
the components separately you can execute:
@@ -71,9 +72,10 @@ This execute a full build of both the Java and Go code. If
you need to build the
After a successful build, if you're connected to a Docker daemon, you can
build the operator Docker image by running:
-```
+[source]
+----
make images
-```
+----
[[push-snapshot]]
== Push runtime snapshot
@@ -84,7 +86,8 @@ For the Java bits in runtime you can push to the Apache
Snapshot repository with
In your settings.xml you'll need to have the correct ASF credentials to push.
-```
+[source,xml]
+----
<server>
<id>apache.snapshots.https</id>
<username>username</username>
@@ -95,15 +98,16 @@ In your settings.xml you'll need to have the correct ASF
credentials to push.
<username>username</username>
<password>password</password>
</server>
-```
+----
Don't forget to first run a `make build-runtime` before pushing the snapshot.
The above command produces a `camel-k` image with name
`docker.io/apache/camel-k`. Sometimes you might need to produce camel-k images
that need to be pushed to the custom repository e.g.
`docker.io/myrepo/camel-k`, to do that you can pass a parameter
`imgDestination` to the make as shown below:
-```
+[source]
+----
make imgDestination='docker.io/myrepo' images
-```
+----
[[testing]]
== Testing
@@ -118,18 +122,20 @@ Integration tests are all in the
https://github.com/apache/camel-k/tree/master/e
Since both names end with `_test.go`, both would be executed by go during
build, so you need to put a special **build tag** to mark
integration tests. A integration test should start with the following line:
-```
+[source]
+----
// +build integration
-```
+----
Look into the https://github.com/apache/camel-k/tree/master/e2e[/e2e]
directory for examples of integration tests.
Before running a integration test, you need to be connected to a
Kubernetes/OpenShift namespace.
After you log in into your cluster, you can run the following command to
execute **all** integration tests:
-```
+[source]
+----
make test-integration
-```
+----
[[running]]
== Running
@@ -153,15 +159,17 @@ This command assumes you have an already running Minikube
instance.
Now you can play with Camel K:
-```
+[source]
+----
./kamel run examples/Sample.java
-```
+----
To add additional dependencies to your routes:
-```
+[source]
+----
./kamel run -d camel:dns examples/dns.js
-```
+----
[[debugging]]
== Debugging and Running from IDE
@@ -178,10 +186,11 @@ It is a bit more complex (but not so much).
You are going to run the operator code **outside** OpenShift in your IDE so,
first of all, you need to **stop the operator running inside**:
-```
+[source]
+----
// use kubectl in plain Kubernetes
oc scale deployment/camel-k-operator --replicas 0
-```
+----
You can scale it back to 1 when you're done and you have updated the operator
image.
diff --git a/docs/modules/ROOT/pages/uninstalling.adoc
b/docs/modules/ROOT/pages/uninstalling.adoc
index 29c9514..ca05c4b 100644
--- a/docs/modules/ROOT/pages/uninstalling.adoc
+++ b/docs/modules/ROOT/pages/uninstalling.adoc
@@ -3,14 +3,17 @@
If you really need to, it is possible to completely uninstall Camel K from
OpenShift or Kubernetes with the following command:
-```
+[source]
+----
kamel uninstall
-```
+----
This will uninstall from the cluster namespace all Camel K resources along
with the operator.
- To verify that all resources have been removed you can use the following
command:
-```
-kubectl get
all,pvc,configmap,rolebindings,clusterrolebindings,secrets,sa,roles,clusterroles,crd
-l 'app=camel-k'
+To verify that all resources have been removed you can use the following
command:
+
+[source]
+----
+kubectl get
all,pvc,configmap,rolebindings,clusterrolebindings,secrets,sa,roles,clusterroles,crd
-l 'app=camel-k'
No resources found in default namespace.
-```
+----
