Fix docs (#279)

* updating docs * update documentation * updating docs * updating docs * updating docs * converting to go modules * converting to go modules * move to go mod * move to go mod * move to go mod * move to go mod * move to go mod * update documentation * add lock file * update documentation * update documentation * update documentation * update documentation
argoproj · May 11, 2019 · 4884b37 · 4884b37
1 parent b68b94a
commit 4884b37
Show file tree

Hide file tree

Showing 33 changed files with 1,000 additions and 772 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -20,7 +20,6 @@ before_install:
   # Load cached docker images
   - if [[ -d $HOME/docker ]]; then ls $HOME/docker/*.tar.gz | xargs -I {file} sh -c "zcat {file} | docker load"; fi
   - go get github.com/mattn/goveralls
-  - go get sigs.k8s.io/kind
   - if [ ! -d $HOME/bin/kubectl ]; then
       mkdir -p $HOME/bin;
       curl -o $HOME/bin/kubectl -L https://storage.googleapis.com/kubernetes-release/release/v1.13.4/bin/linux/amd64/kubectl;
@@ -32,7 +31,6 @@ before_cache:
   - >
     mkdir -p $HOME/docker && docker images -a --filter='dangling=false' --format '{{.Repository}}:{{.Tag}} {{.ID}}'
     | xargs -n 2 -t sh -c 'test -e $HOME/docker/$1.tar.gz || docker save $0 | gzip -2 > $HOME/docker/$1.tar.gz'
-
 install:
   - curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
   - dep version
@@ -42,8 +40,6 @@ script:
   - make all
   - make test coverage
   - $GOPATH/bin/goveralls -coverprofile=profile.cov -service=travis-ci
-  - make build-e2e-images
-  - make kind-e2e
 
 deploy:
   provider: releases

diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/Gopkg.toml b/Gopkg.toml
@@ -132,4 +132,4 @@ required = [
 
 [[constraint]]
   name = "k8s.io/gengo"
-  revision = "b90029ef6cd877cb3f422d75b3a07707e3aac6b7"
+  revision = "b90029ef6cd877cb3f422d75b3a07707e3aac6b7"
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ and trigger Kubernetes objects after successful event dependencies resolution.
 * Ability to manage event sources at runtime.
 
 ## Documentation
-To learn more about Argo Events, [go to complete documentation](docs/)
+To learn more about Argo Events, [go to complete documentation](https://argoproj.github.io/argo-events/)
 
 ## Contribute
 Read and abide by the [Argo Events Code of Conduct](https://github.com/argoproj/argo-events/blob/master/CODE_OF_CONDUCT.md)

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.10
+0.9.2
diff --git a/docs/assets/argo-events-logo.png → docs/assets/logo.png b/docs/assets/argo-events-logo.png → docs/assets/logo.png
diff --git a/docs/communication.md b/docs/communication.md
@@ -1,4 +1,4 @@
-# Internal Communication
+# Persisting Events
 
 1. [How gateway forwards events to sensor](#how-gateway-forwards-events-to-sensor)
 2. [HTTP](#http)

diff --git a/docs/controllers-guide.md → docs/controllers.md b/docs/controllers-guide.md → docs/controllers.md
@@ -1,7 +1,7 @@
 ## Controllers
 
-* Sensor and Gateway controllers are the components which manage Sensor and Gateway resources. 
-* Sensor and Gateway are Kubernetes Custom Resources. For more information on K8 CRDs visit, https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
+* Sensor and Gateway controllers are the components which manage Sensor and Gateway resources respectively. 
+* Sensor and Gateway are Kubernetes Custom Resources. For more information on K8 CRDs visit [here.](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
 
 
 ### Controller configmap
@@ -21,11 +21,11 @@ data:
 
 <b>`namespace`</b>: If you don't provide namespace, controller will watch all namespaces for gateway resource.
 
-<b>`instance-id`</b>: it is used to map a gateway or sensor to a controller. 
+<b>`instanceID`</b>: it is used to map a gateway or sensor to a controller. 
 e.g. when you create a gateway with label `gateways.argoproj.io/gateway-controller-instanceid: argo-events`, a
- controller with label `argo-events` will process that gateway. `instance-id` for controller are managed using [controller-configmap](https://raw.githubusercontent.com/argoproj/argo-events/master/hack/k8s/manifests/gateway-controller-configmap.yaml).
-Basically `instance-id` is used to horizontally scale controllers, so you won't end up overwhelming a controller with large
- number of gateways or sensors. Also keep in mind that `instance-id` has nothing to do with namespace where you are
+ controller with label `argo-events` will process that gateway. `instanceID` for controller are managed using [controller-configmap](https://raw.githubusercontent.com/argoproj/argo-events/master/hack/k8s/manifests/gateway-controller-configmap.yaml).
+Basically `instanceID` is used to horizontally scale controllers, so you won't end up overwhelming a controller with large
+ number of gateways or sensors. Also keep in mind that `instanceID` has nothing to do with namespace where you are
  deploying controllers and gateways/sensors.