From 07bbcae59cc598c3b9531b6e6d5e9eee21d14e8b Mon Sep 17 00:00:00 2001 From: Andrew Louis Date: Tue, 1 May 2018 13:12:27 -0400 Subject: [PATCH] Add Getting the Code section to Quick Start --- docs/development.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/development.md b/docs/development.md index 2879d4be2..5c5fd2a7a 100644 --- a/docs/development.md +++ b/docs/development.md @@ -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- ``` - ## Dependencies The build uses dependencies in the `vendor` directory, which