docs: minor improvements of dev docs (#1092)

Makefile

@@ -195,7 +195,7 @@ rm -rf $$TMP_DIR ;\
 endef
 
 .PHONY: tools
-tools: $(PROJECT_DIR)/bin/operator-sdk $(PROJECT_DIR)/bin/controller-gen $(PROJECT_DIR)/bin/kustomize
+tools: $(PROJECT_DIR)/bin/operator-sdk $(PROJECT_DIR)/bin/controller-gen $(PROJECT_DIR)/bin/kustomize ## Installs required tools
 tools: $(PROJECT_DIR)/bin/golangci-lint $(PROJECT_DIR)/bin/goimports $(PROJECT_DIR)/bin/go-bindata
 tools: $(PROJECT_DIR)/bin/protoc-gen-go $(PROJECT_DIR)/bin/yq $(PROJECT_DIR)/bin/ginkgo
 

docs/modules/ROOT/pages/cli_reference.adoc

@@ -2,7 +2,7 @@
 
 In this section you will learn about:
 
-* [x] ways to configure `ike` (through flags, files et al.)
+* [x] ways to configure `ike` (through flags, files etc)
 * [x] complete list of commands, and their available flags
 
 [#completion]

docs/modules/ROOT/pages/contribution_guide.adoc

@@ -2,7 +2,7 @@
 
 First and foremost thank you very much for your interest in our project and willing to make it better by contributing. 
 
-Before we dive into technicalities on how to build and run it let's emphasize that there are other means of contributing which we value as much.
+Before we dive into technicalities on how to build and run it let's emphasize that there are other means of contributing  \besides submitting pull requests, which we value as much.
 
 * Issues and feature requests.
 * Documentation improvements.
@@ -17,7 +17,7 @@ Filing issues is extremely valuable contribution and to make it easier for you,
 
 == Pull Requests
 
-We would love to see a pull request from, even if it's a typo.
+We would love to see a pull request from you, even if it's a typo.
 
 There are not many strict rules or guidelines to follow, as we strive to automate as much as possible, however, if your work is non-trivial please make sure there's associated issue with it. This will help us to prepare release notes.
 
@@ -39,13 +39,12 @@ and management of different versions of Go.
 
 We rely on following tools:
 
-* https://golang.github.io/dep/[`dep`] for dependency management,
 * https://github.com/golangci/golangci-lint[`golang-ci`] linter,
 * https://github.com/onsi/ginkgo[`ginkgo`] for testing,
 * https://godoc.org/golang.org/x/tools/cmd/goimports[`goimports`] for formatting,
 * https://github.com/operator-framework/operator-sdk[`operator-sdk`] for code generation.
 
-Build process takes care of installing those binaries on your behalf. You can also run `make tools` to install them.
+Build process takes care of installing those binaries on your behalf when you run default `make` target. You can also run `make tools` to install them.
 
 === Coding
 
@@ -55,11 +54,11 @@ TIP: Run `make help` to see what other targets are available.
 
 === Testing
 
-The default `make` target executes unit tests. When developing you can also use https://onsi.github.io/ginkgo/#watching-for-changes[`ginkgo watch`], so they are run whenever the change in the code occur. This makes feedback loop faster.
+The default `make` target executes unit tests, but to only run those you can always invoke `make test`. 
 
-We also have end-to-end tests (`make test-e2e`) for which you need to have Kubernetes cluster with Istio installed. 
+When developing you can also use https://onsi.github.io/ginkgo/#watching-for-changes[`ginkgo watch`], so they are run whenever the change in the code occur. This makes feedback loop faster.
 
-In our CI we rely on https://maistra.io/[Maistra] which bundles OpenShift and Istio. Visit their https://maistra.io/docs/getting_started/install/[installation guide] to see how else you can enable Istio in your cluster.
+We also have end-to-end tests (`make test-e2e`) for which you need to have Kubernetes cluster with Istio installed. 
 
 TIP: Check our xref:dev_guide.adoc[Development Guide] for more details!
 

docs/modules/ROOT/pages/dev_guide.adoc

@@ -42,13 +42,13 @@ First, create `minikube.env`. As each time some variables can differ (such as IP
 [source,bash]
 .minikube.env
 ----
-cat <<EOF > minikubea.env                                         
+cat <<EOF > minikube.env                                         
 IKE_E2E_MANAGE_CLUSTER=false
 ISTIO_NS=istio-system
 IKE_IMAGE_TAG=latest
 TELEPRESENCE_VERSION=0.109
 IKE_CLUSTER_HOST=$(minikube ip)
-IKE_ISTIO_INGRESS=http://$(k get svc istio-ingressgateway -n istio-system -o jsonpath='{.spec.clusterIP}')/
+IKE_ISTIO_INGRESS=http://$(kubectl get svc istio-ingressgateway -n istio-system -o jsonpath='{.spec.clusterIP}')/
 IKE_INTERNAL_CONTAINER_REGISTRY=quay.io
 IKE_EXTERNAL_CONTAINER_REGISTRY=quay.io
 IKE_CONTAINER_REPOSITORY=maistra-dev

docs/modules/ROOT/pages/getting_started.adoc

@@ -25,15 +25,15 @@ Before you can start using CLI we have to add few backend bits to the cluster, s
 
 If you're using Openshift you can install the `istio-workspace operator` via the Operator Hub in the web console.
 
-If you're on vanilla Kubernetes you can install it by installing the `Operator Lifecycle Management` using the https://sdk.operatorframework.io/docs/installation/[Operator SDK]:
+If you're on vanilla Kubernetes you can install `Operator Lifecycle Management` using the https://sdk.operatorframework.io/docs/installation/[Operator SDK]:
 
 [source,bash]
 ----
 operator-sdk install
 operator-sdk run bundle quay.io/maistra/istio-workspace-operator-bundle:latest
 ----
 
-NOTE: The images are available in our Quay repository https://quay.io/repository/maistra/istio-workspace?tab=tags
+NOTE: The images are available in our Quay.io repository https://quay.io/repository/maistra/istio-workspace?tab=tags
 
 === Additional steps 
 

docs/modules/ROOT/pages/integration/tekton/overview.adoc

@@ -3,7 +3,7 @@
 You can use Istio Workspace to prepare special routes from a CI system, e.g. per
 PR to test/preview the changes before merging.
 
-The Istio Workspace Tekton tasks wraps the Istio Workspace CLI into a Tekton Task
+The Istio Workspace https://tekton.dev/[Tekton] tasks wraps the Istio Workspace CLI into a Tekton Task
 for easy usage within the Tekton/Openshift Pipelines CI system.
 
 == Tasks

docs/modules/ROOT/pages/integration/tekton/tasks/ike-create.adoc

@@ -8,12 +8,10 @@ include::cmd:yq[args="e '.spec.description' ike-create.yaml ", cwd="$PROJECT_DIR
 
 include::cmd:yq[args="e '.spec.params' -P -j -I4 ike-create.yaml | jq -r '. | map(if .default then \"* `\(.name)`(\(.type)): \(.description).\n** default value: \(.default)\" else \"* `\(.name)`(\(.type)): \(.description).\"  end) | .[]' || echo -e '[NOTE]\nThe task does not define any results to be consumed further in the pipeline.' ", cwd="$PROJECT_DIR/integration/tekton/tasks/ike-create"]
 
-
 === Results
 
 include::cmd:yq[args="e '.spec.results' -P -j -I4 ike-create.yaml | jq -r '. | map(\"* `\(.name)`: \(.description).\") | .[]' || echo -e '[NOTE]\nThe task does not define any results to be consumed further in the pipeline.'", cwd="$PROJECT_DIR/integration/tekton/tasks/ike-create"]
 
-
 === Usage
 
 include::cmd:yq[args="e '{\"params\": .spec.params}' -I2 samples/ike-create.yaml", cwd="$PROJECT_DIR/integration/tekton/tasks/ike-create",block=true,format=yaml]

docs/modules/ROOT/pages/integration/tekton/tasks/ike-session-url.adoc

@@ -8,12 +8,10 @@ include::cmd:yq[args="e '.spec.description' ike-session-url.yaml ", cwd="$PROJEC
 
 include::cmd:yq[args="e '.spec.params' -P -j -I4 ike-session-url.yaml | jq -r '. | map(if .default then \"* `\(.name)`(\(.type)): \(.description).\n** default value: \(.default)\" else \"* `\(.name)`(\(.type)): \(.description).\"  end) | .[]' || echo -e '[NOTE]\nThe task does not define any results to be consumed further in the pipeline.' ", cwd="$PROJECT_DIR/integration/tekton/tasks/ike-session-url"]
 
-
 === Results
 
 include::cmd:yq[args="e '.spec.results' -P -j -I4 ike-session-url.yaml | jq -r '. | map(\"* `\(.name)`: \(.description).\") | .[]' || echo -e '[NOTE]\nThe task does not define any results to be consumed further in the pipeline.'", cwd="$PROJECT_DIR/integration/tekton/tasks/ike-session-url"]
 
-
 === Usage
 
 include::cmd:yq[args="e '{\"params\": .spec.params}' -I2 samples/ike-session-url.yaml", cwd="$PROJECT_DIR/integration/tekton/tasks/ike-session-url",block=true,format=yaml]