DevFW-CICD/ingress-nginx-helm
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor fixes for Development Documentation

Browse source 
Further cleans up the development documentation with spacing and
more readable text.
This commit is contained in:
Fernando Diaz 2017-08-03 11:29:02 -05:00
parent 86b52fa957
commit ef499aaff1
6 changed files with 17 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/dev/README.md
View file

@ -12,7 +12,7 @@ branch, but release branches of Kubernetes should not change.
## Navigation
* [Build, test, release](getting_started.md) an existing controller
* [Setup a cluster](setup_cluster.md) to hack at an existing controller
* [Write your own](custom_controller.md) controller
* [Build, test, release](getting-started.md) an existing controller
* [Setup a cluster](setup-cluster.md) to hack at an existing controller
* [Write your own](custom-controller.md) controller

0
docs/dev/custom_controller.md → docs/dev/custom-controller.md
View file

18
docs/dev/getting_started.md → docs/dev/getting-started.md
View file

@ -9,7 +9,7 @@ The build uses dependencies in the `ingress/vendor` directory, which
must be installed before building a binary/image. Occasionally, you
might need to update the dependencies.
This guide requires you to install the[godep](https://github.com/tools/godep)dependency
This guide requires you to install the [godep](https://github.com/tools/godep) dependency
tool.
Check the version of `godep` you are using and make sure it is up to date.
@ -32,7 +32,7 @@ $ cd $GOPATH/src/ingress
$ godep save ./...
```
In general, you can follow [this guide](https://github.com/kubernetes/kubernetes/blob/release-1.5/docs/devel/godep.md#using-godep-to-manage-dependencies)to update dependencies.
In general, you can follow [this guide](https://github.com/kubernetes/kubernetes/blob/release-1.5/docs/devel/godep.md#using-godep-to-manage-dependencies) to update dependencies.
To update a particular dependency, eg: Kubernetes:
```console
$ cd $GOPATH/src/k8s.io/ingress
@ -54,10 +54,10 @@ requirements you can build a raw server binary, a local container image,
or push an image to a remote repository.
In order to use your local Docker, you may need to set the following environment variables:
* export TAG=0.0 # or whatever you want the version to be named
* export DOCKER=docker
* export REGISTRY=index.docker.io
```console
$ export DOCKER=docker
$ export REGISTRY=<your-docker-registry>
```
To find the registry simply run: `docker system info | grep Registry`
Otherwise by default you will be using the [Google Cloud Platform](https://cloud.google.com/sdk/gcloud/):
@ -75,12 +75,12 @@ $ make controllers
Build a local container image
```console
$ make docker-build PREFIX=$USER/ingress-controller
$ make docker-build TAG=<tag> PREFIX=$USER/ingress-controller
```
Push the container image to a remote repository
```console
$ make docker-push PREFIX=$USER/ingress-controller
$ make docker-push TAG=<tag> PREFIX=$USER/ingress-controller
```
### GCE Controller
@ -90,7 +90,7 @@ $ make docker-push PREFIX=$USER/ingress-controller
## Deploying
There are several ways to deploy the ingress controller onto a cluster. If you don't have a cluster start by
creating one [here](setup_cluster.md).
creating one [here](setup-cluster.md).
* [nginx controller](../../examples/deployment/nginx/README.md)
* [gce controller](../../examples/deployment/gce/README.md)

2
docs/dev/setup_cluster.md → docs/dev/setup-cluster.md
View file

@ -1,4 +1,4 @@
# Cluster getting Started
# Cluster Getting Started
This doc outlines the steps needed to setup a local dev cluster within which you
can deploy/test an ingress controller. Note that you can also setup the ingress controller