Skip to content

Commit

Permalink
Fix doc error (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
viswajithiii authored Oct 27, 2020
1 parent dcb7791 commit 522267b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ are configured, and add them to the config file. The built-in checks are specifi
To ignore violations for specific objects, users can add an annotation with the key
`ignore-check.kube-linter.io/<check-name>`. We strongly encourage adding an explanation as the value for the annotation.
For example, to ignore a check named "privileged" for a specific deployment, you can add an annotation like:
`kube-linter.io/ignore/privileged: "This deployment needs to run as privileged because it needs kernel access"`.
`ignore-check.kube-linter.io/privileged: "This deployment needs to run as privileged because it needs kernel access"`.

To ignore _all_ checks for a specific object, you can use the special annotation key `kube-linter.io/ignore-all`.

0 comments on commit 522267b

Please sign in to comment.