You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "squakez (via GitHub)" <gi...@apache.org> on 2024/04/19 13:28:48 UTC
Re: [PR] doc(#5386): Contributing page updated [camel-k]
squakez commented on code in PR #5393:
URL: https://github.com/apache/camel-k/pull/5393#discussion_r1572373763
##########
docs/modules/ROOT/pages/contributing/developers.adoc:
##########
@@ -157,30 +164,29 @@ Note `--olm=false` is necessary as otherwise the OLM bundle version is preferred
If you want to test Helm installation
-* Build the Helm chart `make release-helm`
+* Build the Helm chart: `make release-helm`
* Build the project and the image: `make images`
-* Set the internal registry `export REGISTRY_ADDRESS=$(kubectl -n kube-system get service registry -o jsonpath='{.spec.clusterIP}')`
+* Set the internal registry: `export REGISTRY_ADDRESS=$(kubectl -n kube-system get service registry -o jsonpath='{.spec.clusterIP}')`
* Install with Helm (look at the latest version produced by `make release-helm`)
-```
- helm install camel-k-dev docs/charts/camel-k-2.1.0-SNAPSHOT.tgz --set platform.build.registry.address=${REGISTRY_ADDRESS} --set platform.build.registry.insecure=true --set operator.image=apache/camel-k:2.1.0-SNAPSHOT
-```
-
-To uninstall: `helm uninstall camel-k-dev`
-
-=== Use
-
-Now you can play with Camel K:
[source]
----
-./kamel run examples/Sample.java
+helm install camel-k-dev docs/charts/camel-k-2.4.0-SNAPSHOT.tgz --set platform.build.registry.address=${REGISTRY_ADDRESS} --set platform.build.registry.insecure=true --set operator.image=apache/camel-k:2.4.0-SNAPSHOT
----
-To add additional dependencies to your routes:
+* To uninstall: `helm uninstall camel-k-dev`
+
+=== Examples
+
+Camel K examples are located in separate git repository https://github.com/apache/camel-k-examples/[camel-k-examples]. You can clone it and run the examples locally.
+
+=== Use
+
+Now you can play with Camel K:
[source]
----
-./kamel run -d camel:dns examples/dns.js
+./kamel run <kamel-k-examples>/01-basic/Basic.java
Review Comment:
```suggestion
./kamel run <camel-k-examples>/01-basic/Basic.java
```
##########
docs/modules/ROOT/pages/contributing/developers.adoc:
##########
@@ -56,14 +54,18 @@ This is a high-level overview of the project structure:
[options="header"]
|=======================
| Path | Content
+| https://github.com/apache/camel-k/tree/main/addons[/addons] | Contains various of addons.
| https://github.com/apache/camel-k/tree/main/build[/build] | Contains the Docker and Maven build configuration.
| https://github.com/apache/camel-k/tree/main/cmd[/cmd] | Contains the entry points (the *main* functions) for the **camel-k** binary (manager) and the **kamel** client tool.
-| https://github.com/apache/camel-k/tree/main/config[/config] | Contains Kubernetes resource files, specifically for use with the operator-sdk, that are used by the **kamel** client during installation. The `/pkg/resources/resources.go` file is kept in sync with the content of the directory (`make build-resources`), so that resources can be used from within the go code.
-| https://github.com/apache/camel-k/tree/main/deploy[/deploy] | Contains Kubernetes resource files, used by the **kamel** client during installation. The `/pkg/resources.go` file is kept in sync with the content of the directory (`make build-resources`), so that resources can be used from within the go code.
| https://github.com/apache/camel-k/tree/main/docs[/docs] | Contains the documentation website based on https://antora.org/[Antora].
| https://github.com/apache/camel-k/tree/main/e2e[/e2e] | Include integration tests to ensure that the software interacts correctly with Kubernetes and OpenShift.
-| https://github.com/apache/camel-k/tree/main/examples[/examples] | Various examples of Camel K usage.
+| https://github.com/apache/camel-k/tree/main/examples[/examples] | Camel K examples were moved to separete git repository https://github.com/apache/camel-k-examples[camel-k-examples].
Review Comment:
```suggestion
| https://github.com/apache/camel-k/tree/main/examples[/examples] | Camel K examples were moved to separate git repository https://github.com/apache/camel-k-examples[camel-k-examples].
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org