Commit graph

12 commits

Author SHA1 Message Date
guessi
788b3606b1
Keep project name display aligned (#9920) 2023-05-05 09:31:13 -07:00
Josh Soref
1614027cd4
Minor documentation cleanup (#7826)
* clarify link

* Add section headers

* console blocks

* grpc example json was not valid

* multi-tls update text

The preceding point 1 related to 4f2cb51ef8/ingress/controllers/nginx/examples/ingress.yaml
and the deployments referenced in 4f2cb51ef8/ingress/controllers/nginx/examples/README.md

They are not relevant to the current instructions.

* add whitespace around parens

* grammar

setup would be a proper noun, but it is not the intended concept, which is a state

* grammar

* is-only
* via

* Use bullets for choices

* ingress-controller

nginx is a distinct brand.

generally this repo talks about ingress-controller, although it is quite inconsistent about how...

* drop stray paren

* OAuth is a brand and needs an article here

also GitHub is a brand

* Indent text under numbered lists

* use e.g.

* Document that customer header config maps changes do not trigger updates

This should be removed if
https://github.com/kubernetes/ingress-nginx/issues/5238
is fixed.

* article

* period

* infinitive verb + period

* clarify that the gRPC server is responsible for listening for TCP traffic and not some other part of the backend application

* avoid using ; and reword

* whitespace

* brand: gRPC

* only-does is the right form

`for` adds nothing here

* spelling: GitHub

* punctuation

`;` is generally not the right punctuation...

* drop stray `to`

* sentence

* backticks

* fix link

* Improve readability of compare/vs

* Renumber list

* punctuation

* Favor Ingress-NGINX and Ingress NGINX

* Simplify custom header restart text

* Undo typo damage

Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2022-01-16 16:57:28 -08:00
iugastefan922
5c6a28464b
additional info for the custom-headers documentation page (#7603)
* added another documentation example

* added end of file newline

* Revert "added end of file newline"

This reverts commit 2d196ffba3.

* added another documentation example
2021-09-16 14:23:27 -07:00
Ricardo Katz
2d90ba14f5
Change all master reference to main (#7369) 2021-08-06 17:07:29 -07:00
wi1dcard
be5be27a8e Fix kubectl exec deprecated usage in docs.
See:

* https://github.com/kubernetes/kubernetes/pull/88460
* https://github.com/kubernetes/kubectl/blob/master/pkg/cmd/exec/exec.go#L180
2020-07-09 09:24:50 +08:00
Edgars Beigarts
c0ca846bcd
Update configmap name in custom-headers/README.md 2020-05-18 11:02:52 +03:00
Edgars Beigarts
c52d55a2ed
Use ingress-nginx-* naming in docs to match the default deployment 2020-05-17 21:27:56 +03:00
Alan J Castonguay
5eda92b1c9
Explain references in custom-headers documentation
Augment description of custom-headers behavior. Explain the purpose of the two configmaps, making explicit that one cites the other by `namespace/name`. Link the two example yaml files, so they're more easily navigated to from a browser looking at https://kubernetes.github.io/ingress-nginx/examples/customization/custom-headers/

Campfire: grammar, standard installation is in the `ingress-nginx` namespace.
2019-05-13 17:50:59 -04:00
Aarni Koskela
4b80166d76 Fix some document titles 2018-04-26 13:57:18 +03:00
Manuel de Brito Fontes
6537ff3ebf Auto stash before merge of "master" and "master/master" 2017-10-20 22:38:27 -03:00
Manuel de Brito Fontes
32ca583a51 Update documentation and examples [ci skip] 2017-10-16 09:55:46 -03:00
Manuel de Brito Fontes
a9168f276e Split documentation 2017-10-13 18:13:51 -03:00
Renamed from examples/customization/custom-headers/README.md (Browse further)