This is an automated email from the ASF dual-hosted git repository.
nferraro pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-k.git
commit 3dc73b03e7c7b3cc0272aeedccc9dd0baa879a27
Author: nferraro <ni.ferr...@gmail.com>
AuthorDate: Mon Jan 7 15:03:25 2019 +0100
Fix #237: document changes
---
README.adoc | 4 ++--
docs/developers.adoc => contributing.adoc | 11 +++++------
2 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/README.adoc b/README.adoc
index ce55217..28236c7 100644
--- a/README.adoc
+++ b/README.adoc
@@ -31,7 +31,7 @@ Other cluster types (such as OpenShift clusters) should not
need prior configura
To start using Camel K you need the **"kamel"** binary, that can be used to
both configure the cluster and run integrations.
Look into the https://github.com/apache/camel-k/releases[release page] for
latest version of the `kamel` tool.
-If you want to contribute, you can also **build it from source!** Refer to the
link:/docs/developers.adoc[developer's guide]
+If you want to contribute, you can also **build it from source!** Refer to the
link:/contributing.adoc[contributing guide]
for information on how to do it.
Once you have the "kamel" binary, log into your cluster using the standard
"oc" (OpenShift) or "kubectl" (Kubernetes) client tool and execute the
following command to install Camel K:
@@ -244,7 +244,7 @@ kamel get
We love contributions and we want to make Camel K great!
-Contributing is easy, just take a look at our
link:/docs/developers.adoc[developer's guide].
+Contributing is easy, just take a look at our
link:/contributing.adoc[developer's guide].
[[uninstalling]]
== Uninstalling
diff --git a/docs/developers.adoc b/contributing.adoc
similarity index 96%
rename from docs/developers.adoc
rename to contributing.adoc
index 9589be3..032ea6a 100644
--- a/docs/developers.adoc
+++ b/contributing.adoc
@@ -1,6 +1,5 @@
-[[developers]]
-Developer's Guide
-=================
+[[contributing]]
+= Contributing to Camel K
We love contributions!
@@ -15,7 +14,7 @@ In order to build the project, you need to comply with the
following requirement
* **Go version 1.10+**: needed to compile and test the project. Refer to the
https://golang.org/[Go website] for the installation.
* **Dep version 0.5.0**: for managing dependencies. You can find installation
instructions in the https://github.com/golang/dep[dep GitHub repository].
-* **Operator SDK v0.0.7+**: used to build the operator and the Docker images.
Instructions in the https://github.com/operator-framework/operator-sdk[Operator
SDK website] (binary downloads available in the release page).
+* **Operator SDK v0.3.0+**: used to build the operator and the Docker images.
Instructions in the https://github.com/operator-framework/operator-sdk[Operator
SDK website] (binary downloads available in the release page).
* **GNU Make**: used to define composite build actions. This should be already
installed or available as package if you have a good OS
(https://www.gnu.org/software/make/).
[[checks]]
@@ -50,7 +49,7 @@ This is a high level overview of the project structure:
| link:/cmd[/cmd] | Contains the entry points (the *main*
functions) for the **camel-k** binary and the **kamel** client tool.
| link:/build[/build] | Contains scripts used during make operations
for building the project.
| 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 this documentation.
+| 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:/test[/test] | Include integration tests to ensure
that the software interacts correctly with Kubernetes and OpenShift.
@@ -183,4 +182,4 @@ After you setup the IDE task, you can run and debug the
operator process.
NOTE: The operator can be fully debugged in Minishift, because it uses
OpenShift S2I binary builds under the hood.
The build phase cannot be (currently) debugged in Minikube because the Kaniko
builder requires that the operator and the publisher pod
-share a common persistent volume.
+share a common persistent volume.
\ No newline at end of file
