You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by pc...@apache.org on 2021/11/24 13:26:11 UTC
[camel-k] branch main updated: doc: cleaning * Changing a bit the order of the menu to reflect the user journey * Creating a tidier menu for installation section
This is an automated email from the ASF dual-hosted git repository.
pcongiusti pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-k.git
The following commit(s) were added to refs/heads/main by this push:
new 52a8a14 doc: cleaning * Changing a bit the order of the menu to reflect the user journey * Creating a tidier menu for installation section
52a8a14 is described below
commit 52a8a148056d48576e35b3a37229371e4a7e7ebc
Author: Pasquale Congiusti <pa...@gmail.com>
AuthorDate: Wed Nov 24 12:52:26 2021 +0100
doc: cleaning
* Changing a bit the order of the menu to reflect the user journey
* Creating a tidier menu for installation section
---
docs/modules/ROOT/nav-end.adoc | 5 ++--
docs/modules/ROOT/nav.adoc | 32 ++++++++++++----------
docs/modules/ROOT/pages/cli/cli.adoc | 2 +-
.../advanced/multi.adoc} | 7 -----
.../{scheduling.adoc => advanced/resources.adoc} | 2 +-
.../ROOT/pages/installation/installation.adoc | 5 ++++
.../pages/installation/{ => platform}/crc.adoc | 0
.../installation/{ => platform}/digitalocean.adoc | 0
.../pages/installation/{ => platform}/gke.adoc | 0
.../pages/installation/{ => platform}/iks.adoc | 0
.../pages/installation/{ => platform}/k3s.adoc | 0
.../pages/installation/{ => platform}/kind.adoc | 0
.../installation/{ => platform}/minikube.adoc | 0
.../installation/{ => platform}/openshift.adoc | 0
docs/modules/ROOT/pages/running/dev-mode.adoc | 2 +-
.../ROOT/pages/running/run-from-github.adoc | 8 +++---
docs/modules/ROOT/pages/running/running.adoc | 30 +++++++++++++++-----
17 files changed, 55 insertions(+), 38 deletions(-)
diff --git a/docs/modules/ROOT/nav-end.adoc b/docs/modules/ROOT/nav-end.adoc
index 2eeda4a..1512dfa 100644
--- a/docs/modules/ROOT/nav-end.adoc
+++ b/docs/modules/ROOT/nav-end.adoc
@@ -3,8 +3,8 @@
** xref:troubleshooting/operating.adoc[Operating]
** xref:troubleshooting/known-issues.adoc[Known Issues]
* xref:kamelets/kamelets.adoc[Kamelets]
-** xref:kamelets/kamelets-user.adoc[Kamelets User Guide]
-** xref:kamelets/kamelets-dev.adoc[Kamelets Developer Guide]
+** xref:kamelets/kamelets-user.adoc[User Guide]
+** xref:kamelets/kamelets-dev.adoc[Developer Guide]
* xref:architecture/architecture.adoc[Architecture]
** xref:architecture/operator.adoc[Operator]
*** xref:architecture/cr/integration-platform.adoc[IntegrationPlatform]
@@ -14,7 +14,6 @@
*** xref:architecture/cr/camel-catalog.adoc[CamelCatalog]
** xref:architecture/runtime.adoc[Runtime]
** xref:architecture/traits.adoc[Traits]
-** xref:architecture/advanced.adoc[Advanced Installation]
* xref:apis/camel.adoc[API]
* xref:uninstalling.adoc[Uninstalling]
* xref:contributing/developers.adoc[Contributing]
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index 223a98e..172642a 100644
--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@@ -1,12 +1,13 @@
* xref:installation/installation.adoc[Installation]
-** xref:installation/minikube.adoc[Minikube]
-** xref:installation/crc.adoc[Red Hat CodeReady Containers (CRC)]
-** xref:installation/digitalocean.adoc[DigitalOcean Kubernetes Cluster]
-** xref:installation/gke.adoc[Google Kubernetes Engine (GKE)]
-** xref:installation/openshift.adoc[OpenShift]
-** xref:installation/iks.adoc[IBM Kubernetes Service (IKS)]
-** xref:installation/k3s.adoc[K3s]
-** xref:installation/kind.adoc[Kind]
+** Kubernetes Platform
+*** xref:installation/platform/minikube.adoc[Minikube]
+*** xref:installation/platform/crc.adoc[CRC]
+*** xref:installation/platform/digitalocean.adoc[DigitalOcean]
+*** xref:installation/platform/gke.adoc[GKE]
+*** xref:installation/platform/openshift.adoc[OpenShift]
+*** xref:installation/platform/iks.adoc[IKS]
+*** xref:installation/platform/k3s.adoc[K3s]
+*** xref:installation/platform/kind.adoc[Kind]
** xref:installation/registry/registry.adoc[Configuring Registry]
*** xref:installation/registry/digitalocean.adoc[DigitalOcean]
*** xref:installation/registry/dockerhub.adoc[Docker Hub]
@@ -14,13 +15,16 @@
*** xref:installation/registry/gcr.adoc[Gcr.io]
*** xref:installation/registry/icr.adoc[IBM Container Registry]
*** xref:installation/registry/k3s.adoc[K3s]
-** xref:installation/scheduling.adoc[Pod scheduling]
-* xref:running/running.adoc[Running]
-** xref:running/dev-mode.adoc[Dev Mode]
-** xref:running/run-from-github.adoc[Run from GitHub]
-* xref:tutorials/tutorials.adoc[Tutorials]
-* xref:cli/cli.adoc[CLI]
+** Advanced
+*** xref:installation/advanced/resources.adoc[Resource management]
+*** xref:architecture/advanced/multi.adoc[Multiple Operators]
+* Command Line Interface
+** xref:cli/cli.adoc[Kamel CLI]
** xref:cli/modeline.adoc[Modeline]
+* xref:running/running.adoc[Run an Integration]
+** xref:running/dev-mode.adoc[Developer mode]
+** xref:running/run-from-github.adoc[Run from GitHub]
+** xref:tutorials/tutorials.adoc[Examples]
* xref:configuration/configuration.adoc[Configuration]
** xref:configuration/build-time-properties.adoc[Build time properties]
** xref:configuration/components.adoc[Components]
diff --git a/docs/modules/ROOT/pages/cli/cli.adoc b/docs/modules/ROOT/pages/cli/cli.adoc
index 08668d0..c21e744 100644
--- a/docs/modules/ROOT/pages/cli/cli.adoc
+++ b/docs/modules/ROOT/pages/cli/cli.adoc
@@ -1,6 +1,6 @@
= Camel K CLI (kamel)
-The Camel K command line interface (kamel) is the main entry point for running integrations on a Kubernetes cluster.
+The Camel K command line interface, `kamel`, is the main entry point for running integrations on a Kubernetes cluster.
Releases of the Camel K CLI are available on:
diff --git a/docs/modules/ROOT/pages/architecture/advanced.adoc b/docs/modules/ROOT/pages/installation/advanced/multi.adoc
similarity index 93%
rename from docs/modules/ROOT/pages/architecture/advanced.adoc
rename to docs/modules/ROOT/pages/installation/advanced/multi.adoc
index 8734675..0075748 100644
--- a/docs/modules/ROOT/pages/architecture/advanced.adoc
+++ b/docs/modules/ROOT/pages/installation/advanced/multi.adoc
@@ -1,10 +1,3 @@
-[[advanced-installation]]
-= Advanced Installation
-
-This section provides information about special installation modes for the Camel K operator.
-These are advanced configuration options that normally are not needed by Camel K users,
- but they may be useful for particular use cases.
-
[[advanced-installation-multiple-operators]]
== Multiple Operators and Selective Upgrades
diff --git a/docs/modules/ROOT/pages/installation/scheduling.adoc b/docs/modules/ROOT/pages/installation/advanced/resources.adoc
similarity index 97%
rename from docs/modules/ROOT/pages/installation/scheduling.adoc
rename to docs/modules/ROOT/pages/installation/advanced/resources.adoc
index a288584..47b72fe 100644
--- a/docs/modules/ROOT/pages/installation/scheduling.adoc
+++ b/docs/modules/ROOT/pages/installation/advanced/resources.adoc
@@ -1,5 +1,5 @@
[[scheduling-infra-pod]]
-= Scheduling infrastructure Pods and Resource managment
+= Infrastructure Pods and Resource managment
During the installation procedure you will be able to provide information on how to best "operationalize" your infrastructure. Through the configuration of `--node-selector`, `--toleration` and `--operator-resources` you will be able to drive the operator `Pods` scheduling and to be able to assign resources.
diff --git a/docs/modules/ROOT/pages/installation/installation.adoc b/docs/modules/ROOT/pages/installation/installation.adoc
index 03c669c..e033ed5 100644
--- a/docs/modules/ROOT/pages/installation/installation.adoc
+++ b/docs/modules/ROOT/pages/installation/installation.adoc
@@ -51,3 +51,8 @@ You're now ready to xref:running/running.adoc[run some integrations].
Camel K is also available in Helm Hub for installation.
Follow the instructions on the https://hub.helm.sh/charts/camel-k/camel-k[Camel K] page for more information.
+
+[[advanced]]
+== Advanced configuration
+
+Camel K installation can be configured with certain special settings available for experienced users. You can manage resources such as limiting memory and CPU, provide a policy for `Pod` scheduling and `Toleration`. You can also configure the application to run multiple operators on the same namespace. Have a look at the "advanced" section under the "installation" menu.
diff --git a/docs/modules/ROOT/pages/installation/crc.adoc b/docs/modules/ROOT/pages/installation/platform/crc.adoc
similarity index 100%
rename from docs/modules/ROOT/pages/installation/crc.adoc
rename to docs/modules/ROOT/pages/installation/platform/crc.adoc
diff --git a/docs/modules/ROOT/pages/installation/digitalocean.adoc b/docs/modules/ROOT/pages/installation/platform/digitalocean.adoc
similarity index 100%
rename from docs/modules/ROOT/pages/installation/digitalocean.adoc
rename to docs/modules/ROOT/pages/installation/platform/digitalocean.adoc
diff --git a/docs/modules/ROOT/pages/installation/gke.adoc b/docs/modules/ROOT/pages/installation/platform/gke.adoc
similarity index 100%
rename from docs/modules/ROOT/pages/installation/gke.adoc
rename to docs/modules/ROOT/pages/installation/platform/gke.adoc
diff --git a/docs/modules/ROOT/pages/installation/iks.adoc b/docs/modules/ROOT/pages/installation/platform/iks.adoc
similarity index 100%
rename from docs/modules/ROOT/pages/installation/iks.adoc
rename to docs/modules/ROOT/pages/installation/platform/iks.adoc
diff --git a/docs/modules/ROOT/pages/installation/k3s.adoc b/docs/modules/ROOT/pages/installation/platform/k3s.adoc
similarity index 100%
rename from docs/modules/ROOT/pages/installation/k3s.adoc
rename to docs/modules/ROOT/pages/installation/platform/k3s.adoc
diff --git a/docs/modules/ROOT/pages/installation/kind.adoc b/docs/modules/ROOT/pages/installation/platform/kind.adoc
similarity index 100%
rename from docs/modules/ROOT/pages/installation/kind.adoc
rename to docs/modules/ROOT/pages/installation/platform/kind.adoc
diff --git a/docs/modules/ROOT/pages/installation/minikube.adoc b/docs/modules/ROOT/pages/installation/platform/minikube.adoc
similarity index 100%
rename from docs/modules/ROOT/pages/installation/minikube.adoc
rename to docs/modules/ROOT/pages/installation/platform/minikube.adoc
diff --git a/docs/modules/ROOT/pages/installation/openshift.adoc b/docs/modules/ROOT/pages/installation/platform/openshift.adoc
similarity index 100%
rename from docs/modules/ROOT/pages/installation/openshift.adoc
rename to docs/modules/ROOT/pages/installation/platform/openshift.adoc
diff --git a/docs/modules/ROOT/pages/running/dev-mode.adoc b/docs/modules/ROOT/pages/running/dev-mode.adoc
index 023652e..7f266f7 100644
--- a/docs/modules/ROOT/pages/running/dev-mode.adoc
+++ b/docs/modules/ROOT/pages/running/dev-mode.adoc
@@ -1,5 +1,5 @@
[[dev-mode]]
-= Running in Dev Mode
+= Running an Integration in Dev Mode
Camel K provides a specific flag for quickly iterating on integrations during development and have fast feedbacks on the code you're writing.
It's called *dev mode*.
diff --git a/docs/modules/ROOT/pages/running/run-from-github.adoc b/docs/modules/ROOT/pages/running/run-from-github.adoc
index cce64a7..2cc7449 100644
--- a/docs/modules/ROOT/pages/running/run-from-github.adoc
+++ b/docs/modules/ROOT/pages/running/run-from-github.adoc
@@ -1,9 +1,9 @@
[[run-from-github]]
-= Run from GitHub
+= Run an Integration from GitHub
It is possible to run integrations from a GitHub repository or Gist with dedicated URL syntax:
-== Repository
+== Integration code stored in a Github repository
.Syntax
[source]
@@ -30,7 +30,7 @@ but does not require to type the full GitHub RAW URL.
Declaring the branch query param is not required and defaults to `master` if not explicit set.
-== Gist
+== Integration code stored in a Gist
.Syntax
[source]
@@ -39,7 +39,7 @@ kamel run https://gist.github.com/${user-id}/${gist-id}
kamel run gist:${gist-id}
----
-camel-k will add any file that is part of the Gist as a source.
+Camel k will add any file that is part of the Gist as a source.
As example, assuming there are two files listed as part of a Gist, beans.yaml and routes.yaml, then the following command
diff --git a/docs/modules/ROOT/pages/running/running.adoc b/docs/modules/ROOT/pages/running/running.adoc
index 31287f9..93f655f 100644
--- a/docs/modules/ROOT/pages/running/running.adoc
+++ b/docs/modules/ROOT/pages/running/running.adoc
@@ -1,8 +1,8 @@
-[[running]]
-= Running
+[[running-integration]]
+= Running an Integration
After completing the xref:installation/installation.adoc[installation] you should be connected to a Kubernetes/OpenShift cluster
-and have the "kamel" CLI correctly configured.
+and have the `kamel` CLI correctly configured.
Ensure you're connected to the cluster by executing a simple command using the Kubernetes CLI:
@@ -28,15 +28,31 @@ You can run it on the cluster by executing:
kamel run hello.groovy
```
-Integrations can be written in multiple languages. We provide an archive with common examples in the https://github.com/apache/camel-k/releases[release page].
+Integrations can be written in multiple languages. We are collecting examples in our https://github.com/apache/camel-k/[Github repository].
-You can change the content of the `hello.groovy` file and execute the command again to see the changes, or use the xref:running/dev-mode.adoc[dev mode] to have even quicker turnaround times.
-
-== Monitoring the Status
+[[monitoring-integration]]
+== Monitoring the application status
Camel K integrations follow a lifecycle composed of several steps before getting into the `Running` state.
+
You can check the status of all integrations by executing the following command:
```
kamel get
```
+
+[[logging-integration]]
+== Log the standard output
+
+Camel K integrations follow a lifecycle composed of several steps before getting into the `Running` state.
+
+You can check the status of all integrations by executing the following command:
+
+```
+kamel logs hello
+```
+
+[[dev-mode-integration]]
+== Running an Integration in Development mode
+
+Camel K provide a very nice **dev mode** feature that will allow you to apply any change to your Integration code reactively. Check out the xref:running/dev-mode.adoc[Camel K dev mode]
\ No newline at end of file