Add more descriptive steps in Dev Documentation #1065
Conversation
Adds more descriptive steps in the Development Documentation, like more information on obtaining dependencies, building, and deploying an image of the ingress controller. Also adds more descriptive information on deploying as well as some fixes on grammar and spelling.
k8s-ci-robot
added
the
cncf-cla: yes
|
This change is |
docs/dev/README.md
Outdated
| * [Build, test or release](releases.md) an existing controller | ||
| * [Setup a cluster](setup.md) to hack at an existing controller | ||
| * [Write your own](devel.md) controller | ||
| * [Build, test, release](getting_started.md) an existing controller |
There was a problem hiding this comment.
Would prefer hyphens than underscores - like the main docs (eg https://github.com/kubernetes/kubernetes.github.io/tree/master/docs).
docs/dev/getting_started.md
Outdated
| 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 |
docs/dev/getting_started.md
Outdated
| $ 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. |
docs/dev/getting_started.md
Outdated
| 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 |
There was a problem hiding this comment.
I would prefer this TAG to be set in each command, vs exported once.
There was a problem hiding this comment.
Makes sense in case you want different images
docs/dev/getting_started.md
Outdated
| 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 |
There was a problem hiding this comment.
Can you wrap these exports in a code block please?
docs/dev/getting_started.md
Outdated
| 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 |
There was a problem hiding this comment.
I'm not a fan of opinionating on a registry here, could you just show all available options (or keep to the defaults)?
There was a problem hiding this comment.
The default is set to gcr.io/google_containers which can cause a problem for first time developers or anyone not using gcloud. I can set it to something more like .
docs/dev/setup_cluster.md
Outdated
| @@ -1,9 +1,10 @@ | |||
| # Developer setup | |||
| # Cluster getting Started | |||
examples/deployment/nginx/README.md
Outdated
| 3. [Build the image](../../../docs/dev/getting_started.md) | ||
| 4. Create the [default-backend](default-backend.yaml): | ||
| ```console | ||
| $ kubectl apply -f default-backend.yaml |
There was a problem hiding this comment.
This is already done in the top of this readme.
| @@ -13,7 +13,7 @@ a 404 page. | |||
|
|
|||
| ## Controller | |||
|
|
|||
| The Nginx Ingress Controller uses nginx (surprisingly!) to loadbalance requests that are coming to | |||
| The Nginx Ingress Controller uses nginx (surprisingly!) to loadbalancer requests that are coming to | |||
There was a problem hiding this comment.
"load balance" or "loadbalance" is the right term to use here.
Further cleans up the development documentation with spacing and more readable text.
docs/dev/getting-started.md
Outdated
|
|
||
| ```console | ||
| $ export DOCKER=docker | ||
| $ export REGISTRY=<your-docker-registry> |
There was a problem hiding this comment.
How about this as a tradeoff, list common options like:
# "gcloud docker" (default) or "docker"
$ export DOCKER=<docker>
# "gcr.io/google_containers" (default), "index.docker.io", or your own registry
$ export REGISTRY=<registry>
Adds common options to the environment variables for docker, and registry.
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
@diazjf thanks! |
Adds more descriptive steps in the Development Documentation,
like more information on obtaining dependencies, building, and
deploying an image of the ingress controller. Also adds more
descriptive information on deploying as well as some fixes
on grammar and spelling, and some file renames.