feat: Fix minor issues, add docs contribution quickstart. (#3337)

nginxinc · Jan 11, 2023 · 4719147 · 4719147
1 parent 47efad6
commit 4719147
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,19 @@
+# How To Contribute
+## Introduction
+The NGINX Ingress Controller makes use of the [Hugo](https://gohugo.io/) static site generator.
+
+Documentation is stored within the `docs/` subfolder of the main repository, and is where `hugo` commands should be run.
+
+Hugo will watch and reload any changes made, so you can review your work in real time.
+
+## Set-up
+**Requirements**
+* [git](https://git-scm.com/downloads)
+* [hugo](https://gohugo.io/installation/)
+
+**Quick Start**
+```
+git clone git@github.com:nginxinc/kubernetes-ingress.git
+cd docs/
+hugo server
+```
diff --git a/docs/content/configuration/virtualserver-and-virtualserverroute-resources.md b/docs/content/configuration/virtualserver-and-virtualserverroute-resources.md
@@ -757,7 +757,7 @@ Supported NGINX variables: `$args`, `$http2`, `$https`, `$remote_addr`, `$remote
 The value supports two kinds of matching:
 * *Case-insensitive string comparison*. For example:
   * `john` -- case-insensitive matching that succeeds for strings, such as `john`, `John`, `JOHN`.
-  * `!john` -- negation of the case-incentive matching for john that succeeds for strings, such as `bob`, `anything`, `''` (empty string).
+  * `!john` -- negation of the case-insensitive matching for john that succeeds for strings, such as `bob`, `anything`, `''` (empty string).
 * *Matching with a regular expression*. Note that NGINX supports regular expressions compatible with those used by the Perl programming language (PCRE). For example:
   * `~^yes` -- a case-sensitive regular expression that matches any string that starts with `yes`. For example: `yes`, `yes123`.
   * `!~^yes` -- negation of the previous regular expression that succeeds for strings like `YES`, `Yes123`, `noyes`. (The negation mechanism is not part of the PCRE syntax).

diff --git a/docs/content/tutorials/nginx-ingress-istio.md b/docs/content/tutorials/nginx-ingress-istio.md
@@ -57,7 +57,7 @@ Using `kubectl`, we can see that the namespace for our demo (nginx-ingress) now
 
 ```bash
 
-kubectl get namespacess -A --show-labels
+kubectl get namespaces -A --show-labels
 
 
 default                Active   28h   <none>