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(misconf): Improve documentation for filtering #5394

Open
simar7 opened this issue Oct 17, 2023 · 0 comments
Open

docs(misconf): Improve documentation for filtering #5394

simar7 opened this issue Oct 17, 2023 · 0 comments
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation. scan/misconfiguration Issues relating to misconfiguration scanning

Comments

@simar7
Copy link
Member

simar7 commented Oct 17, 2023

Improving documentation around filtering

  1. If the documentation were updated to discuss this issue in an easily-discovered form - right now you're fighting years of stale information on Google / Stack Exchange / etc. and there isn't a top-level ignore topic in the documentation search. One thing which might be useful would be expanding the paragraph at the top of https://aquasecurity.github.io/trivy/v0.46/docs/configuration/filtering/ to have some of the common search keywords like “ignore”, “suppress”, or “false-positive”.

Suggestion: Maybe we can add some keywords in the pages to help us better SEO

  1. There is a low-context search hit on .trivyignore.yaml which is almost what you want except that it doesn't have much context or intro (this would help when looking at the documentation search results) and it needs to lead with the warning that this isn't enabled by default and has to be explicitly enabled on the command-line. I think it'd make sense to enable it by default on the grounds that in the unlikely event someone has created a conflicting file for another purpose, they'd want to know about it sooner rather than later.

  2. The inline comment support is documented but it doesn't show up in the documentation search so it's easy to miss at the bottom of the page.

Originally posted by @acdha in #2961 (comment)

@simar7 simar7 added kind/documentation Categorizes issue or PR as related to documentation. scan/misconfiguration Issues relating to misconfiguration scanning labels Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. scan/misconfiguration Issues relating to misconfiguration scanning
Projects
None yet
Development

No branches or pull requests

2 participants