This is an automated email from the ASF dual-hosted git repository.
lburgazzoli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-k.git
commit 1e09ec60beebc47d9157d9b298f99d118619dce0
Author: nferraro <ni.ferr...@gmail.com>
AuthorDate: Tue Sep 25 12:26:58 2018 +0200
Fix some documentation
---
docs/cluster-setup.adoc | 4 +++-
docs/developers.adoc | 8 ++++----
2 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/docs/cluster-setup.adoc b/docs/cluster-setup.adoc
index 2564b78..7e52648 100644
--- a/docs/cluster-setup.adoc
+++ b/docs/cluster-setup.adoc
@@ -7,7 +7,7 @@ There are various options for creating a development cluster:
[[minishift]]
== Minishift
-You can run Camel K integrations on Openshift using the Minishift cluster
creation tool.
+You can run Camel K integrations on OpenShift using the Minishift cluster
creation tool.
Follow the instructions in the
https://github.com/minishift/minishift#getting-started[getting started guide]
for the installation.
After installing the `minishift` binary, you need to enable the `admin-user`
addon:
@@ -16,6 +16,8 @@ After installing the `minishift` binary, you need to enable
the `admin-user` add
minishift addons enable admin-user
```
+NOTE: the admin user addon should be enabled before starting the cluster for
the first time
+
Then you can start the cluster with:
```
diff --git a/docs/developers.adoc b/docs/developers.adoc
index 983f15a..06bb10a 100644
--- a/docs/developers.adoc
+++ b/docs/developers.adoc
@@ -45,7 +45,7 @@ This is a high level overview of the project structure:
| link:/docs[/docs] | Contains this documentation.
| 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.
+| link:/test[/test] | Include integration tests to ensure
that the software interacts correctly with Kubernetes and OpenShift.
| link:/tmp[/tmp] | Scripts and Docker configuration
files used by the operator-sdk.
| /vendor | Project dependencies (not
staged in git).
| link:/version[/version] | Contains the global version of the project.
@@ -88,7 +88,7 @@ make images
Unit tests are executed automatically as part of the build. They use the
standard go testing framework.
-Integration tests (aimed at ensuring that the code integrates correctly with
Kubernetes and Openshift), need special care.
+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.
@@ -102,7 +102,7 @@ integration tests. A integration test should start with the
following line:
Look into the link:/test[/test] directory for examples of integration tests.
-Before running a integration test, you need to be connected to a
Kubernetes/Openshift namespace.
+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:
```
@@ -144,7 +144,7 @@ It should be straightforward: just execute the
link:/cmd/kamel/kamel.go[/cmd/kam
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**:
+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**:
```
// use kubectl in plain Kubernetes
