Skip to content
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

Merged
merged 1 commit into from
Jul 7, 2021
Merged

Conversation

soneillf5
Copy link
Contributor

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.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto master
  • I will ensure my PR is targeting the master branch and pulling from my branch from my own fork

@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Jun 28, 2021
docs-web/configuration/security.md Outdated Show resolved Hide resolved
docs-web/configuration/security.md Outdated Show resolved Hide resolved
docs-web/configuration/security.md Outdated Show resolved Hide resolved
docs-web/configuration/security.md Outdated Show resolved Hide resolved
docs-web/configuration/security.md Outdated Show resolved Hide resolved
docs-web/configuration/security.md Outdated Show resolved Hide resolved
docs-web/configuration/security.md Outdated Show resolved Hide resolved
Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

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

docs-web/configuration/security.md Outdated Show resolved Hide resolved
docs-web/configuration/security.md Show resolved Hide resolved
docs-web/configuration/security.md Show resolved Hide resolved
docs-web/configuration/security.md Outdated Show resolved Hide resolved
docs-web/configuration/security.md Outdated Show resolved Hide resolved
@soneillf5
Copy link
Contributor Author

Copy link
Contributor

@Jcahilltorre Jcahilltorre left a 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.

docs-web/configuration/security.md Outdated Show resolved Hide resolved
docs-web/configuration/security.md Outdated Show resolved Hide resolved
docs-web/configuration/security.md Outdated Show resolved Hide resolved
docs-web/configuration/security.md Outdated Show resolved Hide resolved
docs-web/configuration/security.md Outdated Show resolved Hide resolved
@soneillf5 soneillf5 merged commit 81f744c into master Jul 7, 2021
@soneillf5 soneillf5 deleted the docs/security branch July 7, 2021 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants