-
Notifications
You must be signed in to change notification settings - Fork 2k
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.
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
Add security recommendations documentation #1702
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @soneillf5
Could you update https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/master/docs-web/configuration/index.rst so that the document is visible via TOC -- https://deploy-preview-1702--nginx-kubernetes-ingress.netlify.app/nginx-ingress-controller/configuration/security/ ?
done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing the
in front of the product name (NGINX Ingress Controller) as it seems to be the standard form in the rest of the docs.
Kept it there for the NGINX Ingress Controller service
, as it's referring to the service itself.
Proposed changes
This change introduces a new section into docs-web/configuration for security best practices.
It should highlight risks, mitigations and best practices that a user should be aware of and responsible for.
Checklist
Before creating a PR, run through this checklist and mark each as complete.