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-2401: (BAST-1546) Adding information about Delete and Dismiss scan results #1774

Merged

Conversation

lucastigera
Copy link
Contributor

@lucastigera lucastigera commented Nov 19, 2024

Product Version(s):
Calico Cloud 20.3.0

Issue:
BAST-1546

Link to docs preview:
All Scanned Images tab

SME review:

  • An SME has approved this change.

DOCS review:

  • A member of the docs team has approved this change.

Additional information:

Merge checklist:

  • Deploy preview inspected wherever changes were made
  • Build completed successfully
  • Test have passed

@lucastigera lucastigera requested a review from a team as a code owner November 19, 2024 00:40
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

netlify bot commented Nov 19, 2024

Deploy Preview for calico-docs-preview-next ready!

Name Link
🔨 Latest commit 129bc48
🔍 Latest deploy log https://app.netlify.com/sites/calico-docs-preview-next/deploys/6744bc1daa6c5a000838661b
😎 Deploy Preview https://deploy-preview-1774--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Nov 19, 2024

Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit 129bc48
🔍 Latest deploy log https://app.netlify.com/sites/tigera/deploys/6744bc1dbc218d0008f4bbec
😎 Deploy Preview https://deploy-preview-1774--tigera.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 27 (no change from production)
Accessibility: 90 (no change from production)
Best Practices: 83 (no change from production)
SEO: 92 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@ctauchen ctauchen left a 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.

Comment on lines 35 to 39
:::note

**Dismissed Results**: While a scan result is dismissed, it will have no impact on the Admission Controller policies.

:::
Copy link
Collaborator

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.

Copy link
Contributor Author

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.

Comment on lines 23 to 27
:::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.

:::
Copy link
Collaborator

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.

Copy link
Contributor Author

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.

Copy link
Collaborator

@ctauchen ctauchen left a 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.
Copy link
Collaborator

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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **Delete:** Permanently remove scan results that are no longer relevant to your remediation efforts.
* **Delete:** Permanently remove specific results from the scan results list.

@ctauchen ctauchen merged commit 07732e3 into tigera:main Nov 26, 2024
9 of 10 checks passed
@lucastigera lucastigera deleted the bast-1546-delete-dismiss-scan-results branch November 26, 2024 22:04
@ctauchen ctauchen changed the title BAST-1546: Adding information about Delete and Dismiss scan results DOCS-2401: (BAST-1546) Adding information about Delete and Dismiss scan results Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants