Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 14 commits into from
Jan 11, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 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.
ADubhlaoich marked this conversation as resolved.
Show resolved Hide resolved

We use a feature branch workflow: changes should be made from a branch originating from `main`.

Commits should be squashed, and pull requests (PRs) should then target the `main` branch.

Once a PR has been accepted, its changes should be cherry picked onto the release branch.

## 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 -e production -b "http://127.0.0.1"
ADubhlaoich marked this conversation as resolved.
Show resolved Hide resolved
```
## Style Guide
NGINX (and F5) has its own style guide, but broadly speaking, you can stick to the [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/).

We prefer the active voice, and plain language. When possible, be concise and avoid jargon - don't assume the reader knows as much as you.
ADubhlaoich marked this conversation as resolved.
Show resolved Hide resolved

If an acronym or abbreviation could cause confusion to someone, explicitly define it during its first use, e.g *Security Operations Center (SOC)*.
ADubhlaoich marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion docs/content/installation/installation-with-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This document describes how to install the NGINX Ingress Controller in your Kube
* For NGINX Plus Ingress Controller, see [here](/nginx-ingress-controller/installation/pulling-ingress-controller-image) for details on how to pull the image from the F5 Docker registry.
* To pull from the F5 Container registry, configure a docker registry secret using your JWT token from the MyF5 portal by following the instructions from [here](/nginx-ingress-controller/installation/using-the-jwt-token-docker-secret).
* It is also possible to build your own image and push it to your private Docker registry by following the instructions from [here](/nginx-ingress-controller/installation/building-ingress-controller-image).
2. Install the NGINX Ingress Operator following the [instructions](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v1.2.1/docs/installation.md).
2. Install the NGINX Ingress Operator following the [instructions](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/main/docs/manual-installation.md).
ADubhlaoich marked this conversation as resolved.
Show resolved Hide resolved
3. Create the default server secret and SecurityContextConstraint as outlined in the [instructions](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v1.2.1/docs/installation.md).

## 1. Create the NginxIngressController manifest
Expand Down
2 changes: 1 addition & 1 deletion docs/content/tutorials/nginx-ingress-istio.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down