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

Update docs on muting CSM issues #26614

Merged
merged 8 commits into from
Dec 10, 2024

Conversation

janine-c
Copy link
Contributor

@janine-c janine-c commented Dec 4, 2024

What does this PR do? What is the motivation?

In this PR:

  • I've updated the descriptions of where to find the mute button, which not only has moved, but now varies depending on whether the issue contains one or multiple resources
  • I've removed the section about the Resource evaluation over time timeline, which has been removed from the UI

Merge instructions

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

@janine-c janine-c requested a review from lucasdmaley December 4, 2024 23:17
@janine-c janine-c requested a review from a team as a code owner December 4, 2024 23:17
@github-actions github-actions bot added the Images Images are added/removed with this PR label Dec 4, 2024
Copy link
Contributor

github-actions bot commented Dec 4, 2024

Preview links (active after the build_preview check completes)

Modified Files

Copy link
Contributor

@neko-dd neko-dd left a comment

Choose a reason for hiding this comment

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

Small suggestions

janine-c and others added 3 commits December 5, 2024 14:56
Co-authored-by: Sandra (neko) <[email protected]>
Co-authored-by: Sandra (neko) <[email protected]>
Co-authored-by: Sandra (neko) <[email protected]>
@lucasdmaley
Copy link
Contributor

lucasdmaley commented Dec 6, 2024

Two things I noticed:

  • If you select more than one resource in the table (in the aggregated resources view), the update is made using the setState dropdown
image - Under **To view your organization's muted issues**, it's worth mentioning that the explorer is filtered by default to not show muted issues. To see muted issues in the explorer, the user should remove the @workflow.triage.status;(open OR in-progress) filter -> this can be done by hovering over it and clicking the X. - - I'd add this in before directing the user to click on "Muted" to sort the table, as that's the order they'd have to do it themselves

Overall, looks great - thanks again for catching and updating this!

@janine-c
Copy link
Contributor Author

janine-c commented Dec 9, 2024

Thanks for flagging those, @lucasdmaley ! I've made those updates, so if you take another look at the preview page, you should see them there. Let me know how it looks and don't hesitate to let me know if you need any further changes :)

@lucasdmaley
Copy link
Contributor

Thank you for making those changes @janine-c! Just noticed one thing -
Audit your muted issues doesn't describe the vulnerabilities explorer. Here, users can click on the "Muted" tab to see muted issues. Technically, the vulnerabilities explorer filters vulnerabilities by default with a slightly different filter - status:(Open OR "In progress") rather than @workflow.triage.status:(open OR in-progress), as in the misconfigs / identity risks explorers. Clicking on the "Muted" tab in the vuln explorer automatically removes this query though, so it might make sense to not make this slight discrepancy explicit in our docs :)
image

@janine-c
Copy link
Contributor Author

janine-c commented Dec 9, 2024

Thanks, @lucasdmaley , great catch! I added the Vulnerabilities explorer - let me know if you think I got the nuance for that right, or if you'd like to work on the phrasing a bit more :) I appreciate your attention to detail here while I'm still learning the nuances of how these explorers work differently!

@lucasdmaley
Copy link
Contributor

No worries at all! Phrasing looks right on what you added, I'd just make sure to add "Vulnerabilities" into this line:

By default, the Misconfigurations and Identity Risks issue explorers hide muted issues.

@janine-c
Copy link
Contributor Author

@lucasdmaley Updated that wording - it originally omitted the Vulnerabilities explorer because it was leading into the part about manually removing those queries, but hopefully this is clearer :)

@lucasdmaley
Copy link
Contributor

Ah, that makes sense - this is definitely clearer. Thank you for going back in to add all of these details, looks good to go!

@janine-c
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 10, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-10 19:38:19 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in master is 7m.

@dd-mergequeue dd-mergequeue bot merged commit 4f3a084 into master Dec 10, 2024
19 of 21 checks passed
@dd-mergequeue dd-mergequeue bot deleted the janine.chan/docs-9632-mute-findings-update branch December 10, 2024 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Images Images are added/removed with this PR mergequeue-status: done
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants