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

Merge pull request #2457 from Shopify/update-quick-start

Browse source 
Add Getting the Code section to Quick Start
This commit is contained in:
k8s-ci-robot 2018-05-01 10:41:17 -07:00 committed by GitHub
commit 3630084bbd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/development.md
View file

@ -1,10 +1,22 @@
# Developing for NGINX Ingress controller
# Developing for NGINX Ingress Controller
This document explains how to get started with developing for NGINX Ingress controller.
It includes how to build, test, and release ingress controllers.
## Quick Start
### Getting the code
The code must be checked out as a subdirectory of k8s.io, and not github.com.
```
mkdir -p $GOPATH/src/k8s.io
cd $GOPATH/src/k8s.io
# Replace "$YOUR_GITHUB_USERNAME" below with your github username
git clone https://github.com/$YOUR_GITHUB_USERNAME/ingress-nginx.git
cd ingress-nginx
```
### Initial developer environment build
>**Prequisites**: Minikube must be installed.
@ -29,7 +41,6 @@ $ kubectl get pods -n ingress-nginx
$ kubectl delete pod -n ingress-nginx nginx-ingress-controller-<unique-pod-id>
```
## Dependencies
The build uses dependencies in the `vendor` directory, which