-
Notifications
You must be signed in to change notification settings - Fork 114
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-2401: (BAST-1546) Adding information about Delete and Dismiss scan results #1774
DOCS-2401: (BAST-1546) Adding information about Delete and Dismiss scan results #1774
Conversation
|
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should condense this as much as possible. Perhaps something like:
## All Scanned Images tab
This tab lists scanned images if you have enabled or used one of the [Image Assurance scanners](./scanners/overview).
To manage your scan results, you can filter, dismiss, or delete them:
* **Filter:** No more than 1-2 sentences.
* **Dismiss:** No more than 1-2 sentences.
* **Delete:** No more than 1-2 sentences.
:::note | ||
|
||
**Dismissed Results**: While a scan result is dismissed, it will have no impact on the Admission Controller policies. | ||
|
||
::: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ambiguous. What do you mean?
- Even if you dismiss a scan result, that result will continue to affect the Admission Controller policies.
- If you dismiss a scan result, the Admission Controller policies will no longer be affected by that scan result.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"If you dismiss a scan result, the Admission Controller policies will no longer be affected by that scan result."
But this can be omitted as users likely expect this behavior.
:::note | ||
|
||
**Deleted Results**: Deleting a scan result removes it from the **All Scanned Images** tab. However, if the image is currently running, its record will still appear in the **Running Images** tab, with the number of instances tracked. | ||
|
||
::: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we really need this? I'm not sure we'd expect deleting a result to mean ALL results are removed for that image.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree. This can be omitted as users likely expect this behavior.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great, I think this reads very nicely. A few suggestions for you, otherwise LGTM.
Currently this is located where it will go out in CC 20.3.0. If we know when this goes into CE, we can put it in the right spot there. If not, then we'll leave it for later.
To manage your scan results, you can filter the list results or delete particular scan result items. | ||
To manage your scan results, you can filter, dismiss, or delete them: | ||
* **Filter:** Apply different combinations of filters to refine your results, making it easier to focus on relevant vulnerabilities for remediation. | ||
* **Dismiss:** Temporarily hide scan results that are not immediately important. Dismissed scan results will be marked as 'Unknown', and you can review or restore them by enabling the Dismissed filter and turning it on. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion:
Dismiss: Hide specific results from the scan results list. You can view a list of dismissed scan results by using the **Dismissed** filter.
To manage your scan results, you can filter, dismiss, or delete them: | ||
* **Filter:** Apply different combinations of filters to refine your results, making it easier to focus on relevant vulnerabilities for remediation. | ||
* **Dismiss:** Temporarily hide scan results that are not immediately important. Dismissed scan results will be marked as 'Unknown', and you can review or restore them by enabling the Dismissed filter and turning it on. | ||
* **Delete:** Permanently remove scan results that are no longer relevant to your remediation efforts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* **Delete:** Permanently remove scan results that are no longer relevant to your remediation efforts. | |
* **Delete:** Permanently remove specific results from the scan results list. |
…castigera/docs into bast-1546-delete-dismiss-scan-results
Product Version(s):
Calico Cloud 20.3.0
Issue:
BAST-1546
Link to docs preview:
All Scanned Images tab
SME review:
DOCS review:
Additional information:
Merge checklist: