Skip to content

Commit 4719147

Browse files
authored
feat: Fix minor issues, add docs contribution quickstart. (#3337)
1 parent 47efad6 commit 4719147

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

docs/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# How To Contribute
2+
## Introduction
3+
The NGINX Ingress Controller makes use of the [Hugo](https://gohugo.io/) static site generator.
4+
5+
Documentation is stored within the `docs/` subfolder of the main repository, and is where `hugo` commands should be run.
6+
7+
Hugo will watch and reload any changes made, so you can review your work in real time.
8+
9+
## Set-up
10+
**Requirements**
11+
* [git](https://git-scm.com/downloads)
12+
* [hugo](https://gohugo.io/installation/)
13+
14+
**Quick Start**
15+
```
16+
git clone git@github.com:nginxinc/kubernetes-ingress.git
17+
cd docs/
18+
hugo server
19+
```

docs/content/configuration/virtualserver-and-virtualserverroute-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -757,7 +757,7 @@ Supported NGINX variables: `$args`, `$http2`, `$https`, `$remote_addr`, `$remote
757757
The value supports two kinds of matching:
758758
* *Case-insensitive string comparison*. For example:
759759
* `john` -- case-insensitive matching that succeeds for strings, such as `john`, `John`, `JOHN`.
760-
* `!john` -- negation of the case-incentive matching for john that succeeds for strings, such as `bob`, `anything`, `''` (empty string).
760+
* `!john` -- negation of the case-insensitive matching for john that succeeds for strings, such as `bob`, `anything`, `''` (empty string).
761761
* *Matching with a regular expression*. Note that NGINX supports regular expressions compatible with those used by the Perl programming language (PCRE). For example:
762762
* `~^yes` -- a case-sensitive regular expression that matches any string that starts with `yes`. For example: `yes`, `yes123`.
763763
* `!~^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).

docs/content/tutorials/nginx-ingress-istio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Using `kubectl`, we can see that the namespace for our demo (nginx-ingress) now
5757

5858
```bash
5959

60-
kubectl get namespacess -A --show-labels
60+
kubectl get namespaces -A --show-labels
6161

6262

6363
default Active 28h <none>

0 commit comments

Comments
 (0)