You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by zr...@apache.org on 2019/07/17 11:15:44 UTC
[camel-k] branch master updated: chore(docs): cleanup contributors
guide
This is an automated email from the ASF dual-hosted git repository.
zregvart 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 40a2f55 chore(docs): cleanup contributors guide
new 17ec307 Merge pull request #829 from zregvart/pr/contributing-guide-cleanup
40a2f55 is described below
commit 40a2f5517ab5c69d8b9e81a079b2e8887ad7ca9e
Author: Zoran Regvart <zr...@apache.org>
AuthorDate: Wed Jul 17 12:34:15 2019 +0200
chore(docs): cleanup contributors guide
This updates the contributors guide with the latest directory structure
on `master` and converts the links to absolute GitHub URLs which helps
when the documentation is rendered outside of the GitHub preview -- for
instance on the Camel wbsite.
Also adds the contributors guide to the navigation.
---
docs/modules/ROOT/nav.adoc | 3 ++-
docs/modules/ROOT/pages/developers.adoc | 28 ++++++++++++++--------------
2 files changed, 16 insertions(+), 15 deletions(-)
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index 43770b0..dc2578a 100644
--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@@ -17,4 +17,5 @@
** xref:languages/java.adoc[Java]
** xref:languages/xml.adoc[XML]
* xref:traits.adoc[Traits]
-* xref:uninstalling.adoc[Uninstalling]
\ No newline at end of file
+* xref:uninstalling.adoc[Uninstalling]
+* xref:developers.adoc[Contributing to Camel K]
diff --git a/docs/modules/ROOT/pages/developers.adoc b/docs/modules/ROOT/pages/developers.adoc
index 749ff32..3bff97a 100644
--- a/docs/modules/ROOT/pages/developers.adoc
+++ b/docs/modules/ROOT/pages/developers.adoc
@@ -3,7 +3,7 @@
We love contributions!
-The project is written in https://golang.org/[go] and contains some parts written in Java for the link:/runtime[integration runtime]
+The project is written in https://golang.org/[go] and contains some parts written in Java for the https://github.com/apache/camel-k-runtime/[integration runtime]
Camel K is built on top of Kubernetes through *Custom Resource Definitions*. The https://github.com/operator-framework/operator-sdk[Operator SDK] is used
to manage the lifecycle of those custom resources.
@@ -38,15 +38,15 @@ This is a high-level overview of the project structure:
[options="header"]
|=======================
| Path | Content
-| link:/cmd[/cmd] | Contains the entry points (the *main* functions) for the **camel-k** binary (manager) and the **kamel** client tool.
-| link:/build[/build] | Contains build data used by the operator-sdk.
-| link:/deploy[/deploy] | Contains Kubernetes resource files that are used by the **kamel** client during installation. The `/deploy/resources.go` file is kept in sync with the content of the directory (`make build-embed-resources`), so that resources can be used from within the go code.
-| link:/docs[/docs] | Contains the documentation website based on https://antora.org/[Antora].
-| link:/pkg[/pkg] | This is where the code resides. The code is divided in multiple subpackages.
-| link:/runtime[/runtime] | The Java runtime code that is used inside the integration Docker containers.
-| link:/script[/script] | Contains scripts used during make operations for building the project.
-| link:/test[/test] | Include integration tests to ensure that the software interacts correctly with Kubernetes and OpenShift.
-| link:/version[/version] | Contains the global version of the project.
+| https://github.com/apache/camel-k/tree/master/build[/build] | Contains the Docker and Maven build configuration.
+| https://github.com/apache/camel-k/tree/master/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/master/build[/build] | Contains build data used by the operator-sdk.
+| https://github.com/apache/camel-k/tree/master/deploy[/deploy] | Contains Kubernetes resource files that are used by the **kamel** client during installation. The `/deploy/resources.go` file is kept in sync with the content of the directory (`make build-embed-resources`), so that resources can be used from within the go code.
+| https://github.com/apache/camel-k/tree/master/docs[/docs] | Contains the documentation website based on https://antora.org/[Antora].
+| https://github.com/apache/camel-k/tree/master/e2e[/e2e] | Include integration tests to ensure that the software interacts correctly with Kubernetes and OpenShift.
+| https://github.com/apache/camel-k/tree/master/examples[/examples] | Various examples of Camel K usage.
+| https://github.com/apache/camel-k/tree/master/pkg[/pkg] | This is where the code resides. The code is divided in multiple subpackages.
+| https://github.com/apache/camel-k/tree/master/script[/script] | Contains scripts used during make operations for building the project.
|=======================
[[building]]
@@ -110,7 +110,7 @@ Unit tests are executed automatically as part of the build. They use the standar
Integration tests (aimed at ensuring that the code integrates correctly with Kubernetes and OpenShift), need special care.
The **convention** used in this repo is to name unit tests `xxx_test.go`, and name integration tests `yyy_integration_test.go`.
-Integration tests are all in the link:/test[/test] dir.
+Integration tests are all in the https://github.com/apache/camel-k/tree/master/e2e[/e2e] dir.
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:
@@ -119,7 +119,7 @@ integration tests. A integration test should start with the following line:
// +build integration
```
-Look into the link:/test[/test] directory for examples of integration tests.
+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:
@@ -167,7 +167,7 @@ Sometimes it's useful to debug the code from the IDE when troubleshooting.
.**Debugging the `kamel` binary**
-It should be straightforward: just execute the link:/cmd/kamel/main.go[/cmd/kamel/main.go] file from the IDE (e.g. Goland) in debug mode.
+It should be straightforward: just execute the https://github.com/apache/camel-k/tree/master/cmd/kamel/main.go[/cmd/kamel/main.go] file from the IDE (e.g. Goland) in debug mode.
.**Debugging the operator**
@@ -182,7 +182,7 @@ 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.
-You can setup the IDE (e.g. Goland) to execute the link:/cmd/camel-k/main.go[/cmd/camel-k/main.go] file in debug mode.
+You can setup the IDE (e.g. Goland) to execute the https://github.com/apache/camel-k/blob/master/cmd/manager/main.go[/cmd/manager/main.go] file in debug mode.
When configuring the IDE task, make sure to add all required environment variables in the *IDE task configuration screen*: