Minor documentation cleanup #7826

jsoref · 2021-10-20T02:21:19Z

I'm happy to split or fold this as requested. My initial work is designed such that each change tries to explain what it is doing individually.

What this PR does / why we need it:

addresses brands
adds section headers
fixes indentation
fixes links
fixes random punctuation
fixes whitespace
improves console block tags/style
improves grammar
improves link text
fixes errant carryover from the old contrib repository
fixes gprc example output (?)
documents the current state of Update configuration on add-headers and proxy-set-headers ConfigMap change #5238

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation only

Which issue/s this PR fixes

How Has This Been Tested?

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.
I've read the CONTRIBUTION guide
I have added tests to cover my changes.
All new and existing tests passed.

k8s-ci-robot · 2021-10-20T02:21:27Z

Hi @jsoref. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

longwuyuan · 2021-10-20T14:36:32Z

docs/examples/affinity/cookie/README.md

@@ -66,8 +66,8 @@ Accept-Ranges: bytes
 ```

 In the example above, you can see that the response contains a `Set-Cookie` header with the settings we have defined.
-This cookie is created by NGINX, it contains a randomly generated key corresponding to the upstream used for that request (selected using [consistent hashing][consistent-hashing]) and has an `Expires` directive.
-If the user changes this cookie, NGINX creates a new one and redirects the user to another upstream.
+This cookie is created by the NGINX Ingress Controller, it contains a randomly generated key corresponding to the upstream used for that request (selected using [consistent hashing][consistent-hashing]) and has an `Expires` directive.


Can we use the phrase "ingress-nginx controller" ?

Certainly. Note that a whole bunch of phrases are used, if that's your preferred one, I'll try to apply it consistently across the markdown files.

Please do. It was talked about and I am certain we want consistent "ingress-NGINX controller" everywhere. "NGINX" in caps or not is left to you. Thanks for the improvement. Helps.

longwuyuan · 2021-10-20T14:38:31Z

docs/examples/auth/oauth-external-auth/README.md

@@ -6,7 +6,7 @@ The `auth-url` and `auth-signin` annotations allow you to use an external
 authentication provider to protect your Ingress resources.

 !!! Important
-    This annotation requires `nginx-ingress-controller v0.9.0` or greater.)


Can we change this to "ingress-nginx-controller" ?

strongjz · 2021-10-25T14:11:06Z

docs/examples/auth/oauth-external-auth/README.md

-kubectl create -f https://raw.githubusercontent.com/kubernetes/kops/master/addons/kubernetes-dashboard/v1.10.1.yaml
-```
+    ```console
+    kubectl create -f https://raw.githubusercontent.com/kubernetes/kops/master/ddons/kubernetes-dashboard/v1.10.1.yaml


the url is https://raw.githubusercontent.com/kubernetes/kops/master/addons/kubernetes-dashboard/v1.10.1.yaml

Hmm, not sure how that got damaged

strongjz · 2021-10-25T14:17:37Z

docs/examples/customization/custom-headers/README.md

@@ -1,5 +1,18 @@
 # Custom Headers

+## Caveats
+
+ingress-nginx-controllers do not live apply changes made to customer header config maps.


This phrasing is a little odd to me. Can we try something, like "Changes to the customer header config maps do not force a reload of the ingress-nginx-controllers"

strongjz · 2021-10-25T14:18:57Z

docs/examples/customization/custom-headers/README.md

+
+In order to workaround this limitation, you can:
+
+* make a change to some other tracked configuration field and then revert it


Unnecessary changes to force a reload of the config to me seem not optimal. A rolling restart of the deployment would be better advice.

strongjz · 2021-11-05T20:40:51Z

/kind documentation
/ok-to-test
/triage accepted
/priority important-soon

…ffic and not some other part of the backend application

`for` adds nothing here

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

rikatz

/lgtm
We can fix the other things in followups, overall looks great.

k8s-ci-robot · 2022-01-17T00:56:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jsoref, rikatz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [rikatz]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

* clarify link * Add section headers * console blocks * grpc example json was not valid * multi-tls update text The preceding point 1 related to https://github.com/kubernetes-retired/contrib/blob/4f2cb51ef82b4dddb625f6053ad132c1faf07aa1/ingress/controllers/nginx/examples/ingress.yaml and the deployments referenced in https://github.com/kubernetes-retired/contrib/blob/4f2cb51ef82b4dddb625f6053ad132c1faf07aa1/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 kubernetes#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>

k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Oct 20, 2021

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 20, 2021

k8s-ci-robot requested review from strongjz and tao12345666333 October 20, 2021 02:22

k8s-ci-robot added area/docs cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Oct 20, 2021

jsoref force-pushed the docs branch from c47c08f to 874f394 Compare October 20, 2021 05:11

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 20, 2021

longwuyuan reviewed Oct 20, 2021

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 23, 2021

jsoref force-pushed the docs branch from 2b85a0c to 454bf50 Compare October 24, 2021 05:08

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 24, 2021

strongjz reviewed Oct 25, 2021

View reviewed changes

jsoref added 19 commits January 12, 2022 16:06

period

bbaec16

infinitive verb + period

c46a2bf

clarify that the gRPC server is responsible for listening for TCP tra…

abbd832

…ffic and not some other part of the backend application

avoid using ; and reword

82af094

whitespace

f5512de

brand: gRPC

0158859

only-does is the right form

77c4185

`for` adds nothing here

spelling: GitHub

56b360a

punctuation

7e66194

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

drop stray to

e2c3d94

sentence

b995864

backticks

cf6da8e

fix link

1c528d3

Improve readability of compare/vs

50444a9

Renumber list

ec65187

punctuation

4e49830

Favor Ingress-NGINX and Ingress NGINX

d5a748f

Simplify custom header restart text

e53694a

Undo typo damage

edd9a3b

jsoref force-pushed the docs branch from 105c030 to edd9a3b Compare January 12, 2022 21:07

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 12, 2022

rikatz approved these changes Jan 17, 2022

View reviewed changes

k8s-ci-robot assigned rikatz Jan 17, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 17, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 17, 2022

k8s-ci-robot merged commit 1614027 into kubernetes:main Jan 17, 2022

jsoref deleted the docs branch January 17, 2022 00:59

tao12345666333 mentioned this pull request Feb 27, 2022

v1.1.2 Release #8274

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Minor documentation cleanup #7826

Minor documentation cleanup #7826

jsoref commented Oct 20, 2021

k8s-ci-robot commented Oct 20, 2021

longwuyuan Oct 20, 2021

jsoref Oct 20, 2021

longwuyuan Oct 20, 2021

longwuyuan Oct 20, 2021

strongjz Oct 25, 2021

jsoref Oct 25, 2021

strongjz Oct 25, 2021

strongjz Oct 25, 2021

strongjz commented Nov 5, 2021

rikatz left a comment

k8s-ci-robot commented Jan 17, 2022


		In order to workaround this limitation, you can:

		* make a change to some other tracked configuration field and then revert it

Minor documentation cleanup #7826

Minor documentation cleanup #7826

Conversation

jsoref commented Oct 20, 2021

What this PR does / why we need it:

Types of changes

Which issue/s this PR fixes

How Has This Been Tested?

Checklist:

k8s-ci-robot commented Oct 20, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

strongjz commented Nov 5, 2021

rikatz left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jan 17, 2022