E545 fix: docops-551 extra backslashes in KIC docs by JTorreG · Pull Request #2272 · nginx/kubernetes-ingress · GitHub
[go: up one dir, main page]
Skip to content

fix: docops-551 extra backslashes in KIC docs #2272

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Dec 15, 2021
Merged

fix: docops-551 extra backslashes in KIC docs #2272

merged 2 commits into from
Dec 15, 2021

Conversation

JTorreG
Copy link
Contributor
@JTorreG JTorreG commented Dec 14, 2021

@github-actions github-actions bot added bug An issue reporting a potential bug documentation Pull requests/issues for documentation labels Dec 14, 2021
@thresheek
Copy link
Member

I think one more place is missing, here's a patch to fix:

diff --git a/docs/content/configuration/global-configuration/configmap-resource.md b/docs/content/configuration/global-configuration/configmap-resource.md
index 31f1ed00..214ac675 100644
--- a/docs/content/configuration/global-configuration/configmap-resource.md
+++ b/docs/content/configuration/global-configuration/configmap-resource.md
@@ -125,7 +125,7 @@ See the doc about [VirtualServer and VirtualServerRoute resources](/nginx-ingres
 | ---| ---| ---| --- |
 |``redirect-to-https`` | Sets the 301 redirect rule based on the value of the ``http_x_forwarded_proto`` header on the server block to force incoming traffic to be over HTTPS. Useful when terminating SSL in a load balancer in front of the Ingress controller — see [115](https://github.com/nginxinc/kubernetes-ingress/issues/115) | ``False`` |  |
 |``ssl-redirect`` | Sets an unconditional 301 redirect rule for all incoming HTTP traffic to force incoming traffic over HTTPS. | ``True`` |  |
-|``hsts`` | Enables [HTTP Strict Transport Security (HSTS)](https://www.nginx.com/blog/http-strict-transport-security-hsts-and-nginx/)\ : the HSTS header is added to the responses from backends. The ``preload`` directive is included in the header. | ``False`` |  |
+|``hsts`` | Enables [HTTP Strict Transport Security (HSTS)](https://www.nginx.com/blog/http-strict-transport-security-hsts-and-nginx/) : the HSTS header is added to the responses from backends. The ``preload`` directive is included in the header. | ``False`` |  |
 |``hsts-max-age`` | Sets the value of the ``max-age`` directive of the HSTS header. | ``2592000`` (1 month) |  |
 |``hsts-include-subdomains`` | Adds the ``includeSubDomains`` directive to the HSTS header. | ``False`` |  |
 |``hsts-behind-proxy`` | Enables HSTS based on the value of the ``http_x_forwarded_proto`` request header. Should only be used when TLS termination is configured in a load balancer (proxy) in front of the Ingress Controller. Note: to control redirection from HTTP to HTTPS configure the ``nginx.org/redirect-to-https`` annotation. | ``False`` |  |

Other than that, LGTM!

@JTorreG
Copy link
Contributor Author
JTorreG commented Dec 15, 2021

removed the extra \ reported by @thresheek via commit. P 8000 lease approve.

thresheek
thresheek approved these changes Dec 15, 2021
View reviewed changes
Copy link
Member
@thresheek thresheek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@JTorreG JTorreG enabled auto-merge (squash) December 15, 2021 16:32
@lucacome lucacome disabled auto-merge December 15, 2021 20:57
@lucacome lucacome removed the bug An issue reporting a potential bug label Dec 15, 2021
@lucacome lucacome merged commit 21f176e into master Dec 15, 2021
@lucacome lucacome deleted the DOCOPS-551 branch December 15, 2021 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thresheek thresheek thresheek approved these changes

@ciarams87 ciarams87 ciarams87 approved these changes

@jputrino jputrino Awaiting requested review from jputrino

@travisamartin travisamartin Awaiting requested review from travisamartin

@ashutoshpradhan-f5 ashutoshpradhan-f5 Awaiting requested review from ashutoshpradhan-f5

Assignees
No one assigned
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@JTorreG @thresheek @ciarams87 @lucacome
0