[user-guide configmap] fix doc for global-auth-snippet

[tomislater]

What this PR does / why we need it:

I wanted to add global auth-snippet, so I started reading the documentation and then I encountered the wrong sentence. It fixes the wrong sentence.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• CVE Report (Scanner found CVE and adding report)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation only

Which issue/s this PR fixes

N/A

How Has This Been Tested?

N/A

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I've read the CONTRIBUTION guide
• I have added unit and/or e2e tests to cover my changes.
• All new and existing tests passed.
• Added Release Notes.

Does my pull request need a release note?

Any user-visible or operator-visible change qualifies for a release note. This could be a:

• CLI change
• API change
• UI change
• configuration schema change
• behavioral change
• change in non-functional attributes such as efficiency or availability, availability of a new platform
• a warning about a deprecation
• fix of a previous Known Issue
• fix of a vulnerability (CVE)

No release notes are required for changes to the following:

• Tests
• Build infrastructure
• Fixes for unreleased bugs

For more tips on writing good release notes, check out the Release Notes Handbook

PLACE RELEASE NOTES HERE

[k8s-ci-robot]

@tomislater: This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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.

[k8s-ci-robot]

Welcome @tomislater!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/ingress-nginx has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @tomislater. 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]

@tomislater , thanks for the contribution
Request that you edit the description of the PR to improve it

• Add the reason you came across this problem
• Add the context and the scenario description where you applied the suggested changed documented config
• Anyone stumbling upon this does not get to know the background and the feature, along with what was the problem with the old content and how the new content solves what problem

[tomislater]

The description has been updated.

[longwuyuan]

Thanks @tomislater . I think we can merge this now.

• But I wanted to express an opinion that this is not just a tip but a real config spec, so anyone approving this should ideally test this config. And then post the state of the cluster, ingress, service etc, in addition to posting the curl request used to tetst and the corresponding logs of the ingress-controller pod.

• Alternatively, I was wondering if you would be open to posting information like copy/paste state of cluster, ingress, service etc in addition to the curl request sent and the logs observed. Information that is backing this change as proof of validity for this change.

We could easily go ahead and merge this simple one liner change but I hope you understand what I am trying to express. Waiting to know your thoughts.

[tomislater]

Hmm, but it is just a change in the documentation. Why would I need to run tests 🤔I don't change any logic here. I observed that this sentence was wrong and I wanted to fix it.

8cc9afe - looks that here someone 4 years ago added this to the documentation and just inserted annotation from the previous block? And forgot to change it?

[longwuyuan]

@tomislater understood. Thank you.

/ok-to-test

[longwuyuan]

/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: longwuyuan, tomislater

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:

• docs/OWNERS [longwuyuan]

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