You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by st...@apache.org on 2021/06/03 06:32:09 UTC

[apisix-ingress-controller] branch master updated: doc: update development.md (#524)

This is an automated email from the ASF dual-hosted git repository.

starsz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git


The following commit(s) were added to refs/heads/master by this push:
     new d510a8a  doc: update development.md (#524)
d510a8a is described below

commit d510a8abdc6d4f94d2478eefb53fca16c4b88eb4
Author: Alex Zhang <zc...@gmail.com>
AuthorDate: Thu Jun 3 14:32:01 2021 +0800

    doc: update development.md (#524)
---
 docs/en/latest/development.md | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/docs/en/latest/development.md b/docs/en/latest/development.md
index 014f25b..b118212 100644
--- a/docs/en/latest/development.md
+++ b/docs/en/latest/development.md
@@ -26,13 +26,13 @@ This document explains how to get started with developing for Apache APISIX Ingr
 ## Prerequisites
 
 * Install [Go 1.13](https://golang.org/dl/) or later, and we use go module to manage the go package dependencies.
-* Prepare an available Kubernetes cluster in your workstation, we recommend you to use [Minikube](https://github.com/kubernetes/minikube).
+* Prepare an available Kubernetes cluster in your workstation, we recommend you to use [Kind](https://kind.sigs.k8s.io/).
 * Install Apache APISIX in Kubernetes by [Helm Chart](https://github.com/apache/apisix-helm-chart).
 
 ## Fork and Clone
 
 * Fork the repository from [apache/apisix-ingress-controller](https://github.com/apache/apisix-ingress-controller) to your own GitHub account.
-* Clone the forked repository to your workstation.
+* Clone the fork repository to your workstation.
 * Run `go mod download` to download modules to local cache. By the way, if you are a developer in China, we suggest you setting `GOPROXY` to `https://goproxy.cn` to speed up the downloading.
 
 ## Build
@@ -61,6 +61,9 @@ make e2e-test
 
 Note the running of e2e cases is somewhat slow, so please be patient.
 
+> See [here](https://onsi.github.io/ginkgo/#focused-specs) to learn
+how to just run partial e2e cases.
+
 ### Build docker image
 
 ```shell
@@ -68,7 +71,14 @@ cd /path/to/apisix-ingress-controller
 make build-image IMAGE_TAG=a.b.c
 ```
 
-The Dockerfile in this repository is only for development, not for release.
+> Note: The Dockerfile in this repository is only for development, not for release.
+
+If you're coding for apisix-ingress-controller and adding some e2e test cases to verify your changes,
+you should push the images to the image registry that your Kubernetes cluster can access, if you're using Kind, just run the following command:
+
+```shell
+make push-images-to-kind
+```
 
 ## Run apisix-ingress-controller locally