Commit graph

29 commits

Author SHA1 Message Date
Mitchell Mohorovich
4c00085c17
fix broken kubernetes.io/user-guide/ docs links (#10055) 2023-06-08 08:52:14 -07:00
longwuyuan
40957d43cc add faq section in docs 2023-05-28 22:46:23 +05:30
Aarni Koskela
ea629a175e
Move and spell-check Kubernetes 1.22 migration FAQ (#9544)
* Move Kubernetes 1.22 migration guide to a separate file

* Reformat and spell-check Kubernetes 1.22 migration doc
2023-01-25 01:44:11 -08:00
Gabriel Gosselin
f6af3b460a
Missing controller.ingressClass (#9304)
The missing controller.ingressClass would set the deployment to the default class but the controller.ingressClassResource.name would set the creation of a new IngressClass object.

For now this needs to be done twice, could be a fix in the chart later on.
2022-11-14 18:58:41 -08:00
qilong.qiu
a581a7bebc
Add docs on Election ID to Multiple Ingress Controller guide (#8855) 2022-07-22 04:21:38 -07:00
Stefan Lasiewski
6e4ccf2025
Fix several typos (#8701)
* Fix minor typo - "Kubernetess"

* Fix more typos

* Fix typo: double "the"
2022-06-15 14:33:11 -07:00
Jintao Zhang
53ac0ddd42
Using Go install for misspell (#8191)
* chore: using go install misspell

Signed-off-by: Jintao Zhang <zhangjintao9020@gmail.com>

* chore: fix typo

Signed-off-by: Jintao Zhang <zhangjintao9020@gmail.com>
2022-01-26 18:52:50 -08:00
Frederik-Baetens
39e721de73
Docs: add documentation about default ingress helm value, corrections to only ingress section (#7943)
* add explanation about ingressClassResource.default for helm users

Also cleaned up the entire "I have only one instance of the
Ingress-NGINX controller in my cluster" section

* docs: default ingressclass only when running one controller

* fix link to what is the flag watch ingress

* clarify usage of default ingress class annotation
2022-01-20 01:17:52 -08: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
Mani Kanth
2ff5af08d4
docs_multiple_instances_one_cluster_ticket_7543 (#8042) 2021-12-22 02:53:35 -08:00
Tim Bannister
ec21629b81
Revise main documentation page (#8019)
- Revise to be more in line with the style guide for Kubernetes official docs
- Avoid recommending that readers use `k8s.io` namespaced controller names
  for their own custom controller configuration.

Co-authored-by: James Strong <strong.james.e@gmail.com>

Co-authored-by: James Strong <strong.james.e@gmail.com>
2021-12-12 05:21:58 -08:00
Jessica Andersson
4da87d128d
improves text format for readability (#7855)
Small text format changes to section "I have more than one controller running in my cluster, and I want to use the new spec?" to allow for better readability.
2021-10-27 06:31:26 -07:00
Maxence Boutet
8611ecb7c9
Fix not rendered markdown list (#7825) 2021-10-19 20:37:57 -07:00
Jun Gu
0963a45922
docs: Remove extra symbol (#7765)
Signed-off-by: jun.gu <gujun4990@outlook.com>
2021-10-08 05:44:59 -07:00
Long Wu Yuan
5fec4e885d
removed space in example helm install command from docs (#7775) 2021-10-07 18:55:51 -07:00
Zackky Muhammad
b219555e75
docs(index): fix typo helm value example (#7734) 2021-10-03 13:59:07 -07:00
Long Wu Yuan
be9a7bea4a
added example to install multiple instances of controller (#7718) 2021-09-28 09:08:43 -07:00
Austin Wise
15385c6d56
Tweak documentation formating about deprecated apiVersion values. (#7663)
* Tweak documentation formating about deprecated `apiVersion` values.

* retweak after rebase
2021-09-26 10:48:22 -07:00
pierre villard
1a5c0b7ed2
Correct a mistake (#7690) 2021-09-24 04:01:24 -07:00
Long Wu Yuan
c6bf056327
added example multiple controller install to faq (#7668) 2021-09-20 03:28:10 -07:00
Yuhao Zhang
e7791941ba
fix cli flag typo in faq (#7606) 2021-09-07 09:11:16 -07:00
Long Wu Yuan
9f9122c381
fix 7591 (#7598) 2021-09-05 11:22:28 -07:00
Long Wu Yuan
4eeb1dfb56
improve faq for migration to ingress api v1 (#7540) 2021-09-04 20:45:20 -07:00
Long Wu Yuan
1510c06045
docs for migration to apiVersion networking.k8s.io/v1 (#7524) 2021-08-24 04:57:13 -07:00
Manuel Alejandro de Brito Fontes
d1eea794e9
Fix broken links in documentation (#4746) 2019-11-08 16:22:52 -03:00
Aarni Koskela
dc18dff431 Move deployment documentation under docs/deploy/ 2018-04-26 13:57:18 +03:00
Aarni Koskela
4b80166d76 Fix some document titles 2018-04-26 13:57:18 +03:00
Aarni Koskela
d1479a2d21 Move miscellaneous tidbits from README to miscellaneous.md and other files 2018-04-26 13:57:18 +03:00
Aarni Koskela
0aa9d2e89f Move all documentation under docs/ 2018-04-26 13:57:18 +03:00