Skip to content

Commit

Permalink
docs: fix typo in enable-builin-rules mentions (#3118)
Browse files Browse the repository at this point in the history
  • Loading branch information
acdha committed Nov 14, 2022
1 parent 6b3be15 commit 01df475
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/docs/secret/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ allow-rules:

## Enable Rules
Trivy provides plenty of out-of-box rules and allow rules, but you may not need all of them.
In that case, `enable-builin-rules` will be helpful.
In that case, `enable-builtin-rules` will be helpful.
If you just need AWS secret detection, you can enable only relevant rules as shown below.
It specifies AWS-related rule IDs in `enable-builin-rules`.
It specifies AWS-related rule IDs in `enable-builtin-rules`.
All other rules are disabled, so the scanning will be much faster.
We would strongly recommend using this option if you don't need all rules.

Expand All @@ -118,9 +118,9 @@ Trivy offers built-in rules and allow rules, but you may want to disable some of
For example, you don't use Slack, so Slack doesn't have to be scanned.
You can specify the Slack rule IDs, `slack-access-token` and `slack-web-hook` in `disable-rules` so that those rules will be disabled for less false positives.

You should specify either `enable-builin-rules` or `disable-rules`.
You should specify either `enable-builtin-rules` or `disable-rules`.
If they both are specified, `disable-rules` takes precedence.
In case `github-pat` is specified in `enable-builin-rules` and `disable-rules`, it will be disabled.
In case `github-pat` is specified in `enable-builtin-rules` and `disable-rules`, it will be disabled.

In addition, there are some allow rules.
Markdown files are ignored by default, but you may want to scan markdown files as well.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/secret/scanning.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ The usage examples are [here][examples].

In addition, all the built-in rules are enabled by default, so it takes some time to scan all of them.
If you don't need all those rules, you can use `enable-builtin-rules` or `disable-rules` in the configuration file.
You should use `enable-builin-rules` if you need only AWS secret detection, for example.
You should use `enable-builtin-rules` if you need only AWS secret detection, for example.
All rules are disabled except for the ones you specify, so it runs very fast.
On the other hand, you should use `disable-rules` if you just want to disable some built-in rules.
See the [enable-rules][enable-rules] and [disable-rules][disable-rules] sections for the detail.
Expand Down

0 comments on commit 01df475

Please sign in to comment.