From 172d30239e8eef73b2db85be5ae5990300bed13a Mon Sep 17 00:00:00 2001 From: "Leon(@mediocreDevops)" <8469842+afro-coder@users.noreply.github.com> Date: Tue, 4 Oct 2022 16:12:15 +0530 Subject: [PATCH] Updated the Developer guide with New Contributor information (#9114) Added more clarity to the docs with regards to the getting-started page for developers. Signed-off-by: afro-coder Signed-off-by: afro-coder --- docs/developer-guide/getting-started.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/developer-guide/getting-started.md b/docs/developer-guide/getting-started.md index fbf2517901..9f4be8fcc8 100644 --- a/docs/developer-guide/getting-started.md +++ b/docs/developer-guide/getting-started.md @@ -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. +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 Install [Go 1.14](https://golang.org/dl/) or later. @@ -88,6 +96,3 @@ and then publish such version with ```console 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.