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

Updated the Developer guide with New Contributor information (#9114)

Browse source 
Added more clarity to the docs with regards to the getting-started page
for developers.

Signed-off-by: afro-coder <leon9923@gmail.com>

Signed-off-by: afro-coder <leon9923@gmail.com>
This commit is contained in:
Leon(@mediocreDevops) 2022-10-04 16:12:15 +05:30 committed by GitHub
parent fd7281c703
commit 172d30239e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/developer-guide/getting-started.md
View file

@ -1,7 +1,15 @@
# Developing for NGINX Ingress Controller Developing for NGINX Ingress Controller
This document explains how to get started with developing for NGINX Ingress controller. This document explains how to get started with developing for NGINX Ingress controller.
For the really new contributors, who want to contribute to the INGRESS-NGINX project, but need help with understanding some basic concepts,
that are needed to work with the Kubernetes ingress resource, here is a link to the [New Contributors Guide](https://github.com/kubernetes/ingress-nginx/blob/main/NEW_CONTRIBUTOR.md).
This guide contains tips on how a http/https request travels, from a browser or a curl command,
to the webserver process running inside a container, in a pod, in a Kubernetes cluster, but enters the cluster via a ingress resource.
For those who are familiar with those basic networking concepts like routing of a packet with regards to a
http request, termination of connection, reverseproxy etc. etc., you can skip this and move on to the sections below.
(or read it anyways just for context and also provide feedbacks if any)
## Prerequisites ## Prerequisites
Install [Go 1.14](https://golang.org/dl/) or later. Install [Go 1.14](https://golang.org/dl/) or later.
@ -88,6 +96,3 @@ and then publish such version with
```console ```console
docker push $REGISTRY/controller:$TAG docker push $REGISTRY/controller:$TAG
``` ```
### New Contributor Tips
New contributors can refer to the [new contributor tips](https://github.com/kubernetes/ingress-nginx/blob/main/NEW_CONTRIBUTOR.md) which will be updated with examples and tips.