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

docs: updating the --ignore-policy flag and policy docs #4455

Closed
wants to merge 4 commits into from

Conversation

AnaisUrlichs
Copy link
Contributor

Description

I have done the following

  • updated the documentation on misconfiguration scanning to detail the "different types of policies" that we have and that users can pass into the misconfiguration scan. This is based on my conversation today with Itay. Eventually, we might want to rename the --policy that is passed into the misconfiguration scan into --check and similar across the documentation and the CLI (discussed in more detail in this discussion: Ignoring stuff #3620 )
  • I have provided further details to the --ignore-policy flag so people better understand where this information is coming from and how to apply it. As this issue describes, the docs was incomplete --ignore-policy unavailable in config target #3490 -- In this issue, there are still some updates mentioned that have to be made in the CLI for --ignore-policy (namely: exceptions are not displayed correctly and --ignore-policy does not work for trivy config command directly at the moment)

Related issues

@AnaisUrlichs AnaisUrlichs changed the title updating the --ignore-policy flag and policy docs docs: updating the --ignore-policy flag and policy docs May 23, 2023
@AnaisUrlichs
Copy link
Contributor Author

I also ran docs:generate so some changes have been made to the reference docs -- wasn't sure if I should leave that or make a separate PR for those

docs/docs/configuration/filtering.md Outdated Show resolved Hide resolved
docs/docs/configuration/filtering.md Outdated Show resolved Hide resolved
docs/docs/configuration/filtering.md Outdated Show resolved Hide resolved
docs/docs/configuration/filtering.md Outdated Show resolved Hide resolved
docs/docs/configuration/filtering.md Outdated Show resolved Hide resolved
docs/docs/configuration/filtering.md Outdated Show resolved Hide resolved
docs/docs/configuration/filtering.md Outdated Show resolved Hide resolved
docs/docs/configuration/filtering.md Outdated Show resolved Hide resolved
docs/docs/configuration/filtering.md Outdated Show resolved Hide resolved
docs/docs/configuration/filtering.md Outdated Show resolved Hide resolved
@itaysk
Copy link
Contributor

itaysk commented Jun 7, 2023

I think rendering is still broken, can you please fix before I re-review?
image

@AnaisUrlichs
Copy link
Contributor Author

Will check, it displayed it correctly for me yesterday

@AnaisUrlichs
Copy link
Contributor Author

It does not work when you preview the markdown but it renders correctly when running the docs locally:

Locally
Screenshot 2023-06-26 at 11 42 22

Localhost
Screenshot 2023-06-26 at 11 41 24

@AnaisUrlichs
Copy link
Contributor Author

@itaysk thoughts on turning this into a tutorial instead?

@itaysk
Copy link
Contributor

itaysk commented Sep 12, 2023

This PR includes two things:

  1. fix an error in the docs incorrectly documenting the input to the rego rule
  2. better explaining why and how to use ignoring with rego rule

I think it's a good idea to take the explanatory content you added here into a tutorial, but we still need to fix the documentation error:

The structure of each vulnerability input is the same as for the Trivy JSON output.

@itaysk
Copy link
Contributor

itaysk commented Sep 12, 2023

This is the issue that prompted this PR, can you please add it to the PR description? #3486.

@itaysk itaysk mentioned this pull request Oct 18, 2023
6 tasks
Copy link

This PR is stale because it has been labeled with inactivity.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and will be auto-closed. label Nov 12, 2023
@github-actions github-actions bot closed this Dec 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and will be auto-closed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants