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] CTI enhancements to the Overview page and Alert details pane #808

Merged
merged 28 commits into from
Jul 29, 2021

Conversation

nastasha-solomon
Copy link
Contributor

@nastasha-solomon nastasha-solomon commented Jul 13, 2021

Addresses #773 and #797.

  • A preview of updates to the Elastic Security UI topic is here. (Scroll to the "Threat Intelligence card" section.)
  • A preview of updates to the Manage detection alerts topic is here.

@nastasha-solomon nastasha-solomon added the Team: Security Platform Includes Cyber Threat Intelligence (CTI) team label Jul 19, 2021
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

Just a few small edits/suggestions.

Copy link

@ecezalp ecezalp left a comment

Choose a reason for hiding this comment

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

Attached some general suggestions. I think it's close, please let me know what you think

** `source (threat.indicator.provider)`
** `first_seen`
** `last_seen`
* *Summary*: Shows an aggregated view of alert details, plus two types of threat intelligence data: indicator rule enrichments and investigation time enrichments.
Copy link

Choose a reason for hiding this comment

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

I remember @shimonmodi mentioning that we shouldn't use these phrases (indicator match enrichments and investigation time enrichments), but I am not entirely sure exactly what we agreed on instead - we might want to check with @shimonmodi and @devonakerr.

Copy link
Contributor

Choose a reason for hiding this comment

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

For context, here is the latest copy for those pages: elastic/kibana#105701

** `source (threat.indicator.provider)`
** `first_seen`
** `last_seen`
* *Summary*: Shows an aggregated view of alert details, plus two types of threat intelligence data: indicator rule enrichments and investigation time enrichments.
Copy link
Contributor

Choose a reason for hiding this comment

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

For context, here is the latest copy for those pages: elastic/kibana#105701

@MikePaquette
Copy link
Contributor

Hi Team, I'm having a bit of trouble following the latest state of things. Can we find 30-min Wednesday to huddle to nail this all down in a call?

@joepeeples check out our Writing Style Guide, which covers the treatment of open source and so much more :-).

All, the rule type we're referencing is the "Indicator Match" rule type. I'm noticing that we're using "Indicator rule" throughout, which is inconsistent and confusing. (See below)
image

On Friday, Shimon and I discussed some preferred terminology for the two representations on the alert details flyout as follows:

  • Threat match detected. (An indicator match rule you created found this threat intelligence observable.)
  • Enriched with Threat Intelligence. (This field value has additional information available from threat intelligence sources.)

Could someone attempt to reconcile these terms with the docs above? Thanks!!

@nastasha-solomon
Copy link
Contributor Author

nastasha-solomon commented Jul 21, 2021

Thanks for joining in, @MikePaquette!

In my initial draft, I was working from the assumption that the customer-facing terms that'd be used to describe CTI data would eventually be formalized and so I was using "indicator match enrichments" and "investigation time enrichments" as placeholders. Just from hearing discussions about this topic, and viewing yesterday's CTI Roadmap Sync meeting, it sounds as though this topic will continue to be an ongoing discussion--and might even continue past 7.14. To accommodate for this, I've removed all references to "indicator match enrichments" and "investigation time enrichments" in the new draft. I've also revised a good portion of it to mainly focus on describing what CTI details are, where users can find them, and how they're produced.

All this said, I'd be happy to incorporate any agreed-upon terminology if it helps to further explain this feature or is required for the feature docs. I really just need some guidance on how to effectively frame this feature in-lieu of formal terms.

Copy link
Contributor

@jmikell821 jmikell821 left a comment

Choose a reason for hiding this comment

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

@nastasha-solomon to avoid confusion and our eyes crossing, let's divide this into chunks. Merge this feedback in, then I'll review starting from the Table tab section.

Copy link
Contributor

@rylnd rylnd left a comment

Choose a reason for hiding this comment

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

Added suggestions for terminology; thanks for the effort here!

Copy link
Contributor

@rylnd rylnd left a comment

Choose a reason for hiding this comment

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

Changes LGTM! Thank you!

Copy link
Contributor

@jmikell821 jmikell821 left a comment

Choose a reason for hiding this comment

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

Small comment, then slight adjustment to the "Change an alert's status" section:

To view alerts with other statuses, click In progress or Closed.

Change to:

To filter alerts that are In progress or Closed, select the appropriate status in the upper-right corner of the Alerts table.

To change alert statuses, do one of the following:

Change to:

To change an alert's status, do one of the following:

Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

A few comments on the "Manage detection alerts" page.

@nastasha-solomon nastasha-solomon merged commit f82c514 into master Jul 29, 2021
nastasha-solomon added a commit to nastasha-solomon/security-docs that referenced this pull request Jul 29, 2021
…lastic#808)

* First draft.

* Revised content for new card on overview page and updated screenshots.

* Removed cross reference to beats topic.

* Revisions to the security-ui topic.

* Draft for alert details pane.

* Minor rewording and styling changes.

* Incorported notes from chat with Ece.

* Minor rewording.

* Nav updates.

* Incorporated review feedback.

* Fixed header issue.

* Fixed formatting issues.

* Minor changes.

* Incorporating editorial and technical comments.

* Fixed typo.

* Fixed typo.

* Adding new image.

* Added Janeen's comments.

* Additional edits.

* Update docs/getting-started/security-ui.asciidoc

Co-authored-by: Ryland Herrick <[email protected]>

* Update docs/getting-started/security-ui.asciidoc

Co-authored-by: Ryland Herrick <[email protected]>

* Update docs/getting-started/security-ui.asciidoc

Co-authored-by: Ryland Herrick <[email protected]>

* Incorporating final comments from Joe.

Co-authored-by: Ryland Herrick <[email protected]>
nastasha-solomon added a commit to nastasha-solomon/security-docs that referenced this pull request Jul 29, 2021
…lastic#808)

* First draft.

* Revised content for new card on overview page and updated screenshots.

* Removed cross reference to beats topic.

* Revisions to the security-ui topic.

* Draft for alert details pane.

* Minor rewording and styling changes.

* Incorported notes from chat with Ece.

* Minor rewording.

* Nav updates.

* Incorporated review feedback.

* Fixed header issue.

* Fixed formatting issues.

* Minor changes.

* Incorporating editorial and technical comments.

* Fixed typo.

* Fixed typo.

* Adding new image.

* Added Janeen's comments.

* Additional edits.

* Update docs/getting-started/security-ui.asciidoc

Co-authored-by: Ryland Herrick <[email protected]>

* Update docs/getting-started/security-ui.asciidoc

Co-authored-by: Ryland Herrick <[email protected]>

* Update docs/getting-started/security-ui.asciidoc

Co-authored-by: Ryland Herrick <[email protected]>

* Incorporating final comments from Joe.

Co-authored-by: Ryland Herrick <[email protected]>
nastasha-solomon added a commit that referenced this pull request Jul 29, 2021
…808) (#850)

* First draft.

* Revised content for new card on overview page and updated screenshots.

* Removed cross reference to beats topic.

* Revisions to the security-ui topic.

* Draft for alert details pane.

* Minor rewording and styling changes.

* Incorported notes from chat with Ece.

* Minor rewording.

* Nav updates.

* Incorporated review feedback.

* Fixed header issue.

* Fixed formatting issues.

* Minor changes.

* Incorporating editorial and technical comments.

* Fixed typo.

* Fixed typo.

* Adding new image.

* Added Janeen's comments.

* Additional edits.

* Update docs/getting-started/security-ui.asciidoc

Co-authored-by: Ryland Herrick <[email protected]>

* Update docs/getting-started/security-ui.asciidoc

Co-authored-by: Ryland Herrick <[email protected]>

* Update docs/getting-started/security-ui.asciidoc

Co-authored-by: Ryland Herrick <[email protected]>

* Incorporating final comments from Joe.

Co-authored-by: Ryland Herrick <[email protected]>

Co-authored-by: Ryland Herrick <[email protected]>
nastasha-solomon added a commit that referenced this pull request Jul 29, 2021
…808) (#849)

* First draft.

* Revised content for new card on overview page and updated screenshots.

* Removed cross reference to beats topic.

* Revisions to the security-ui topic.

* Draft for alert details pane.

* Minor rewording and styling changes.

* Incorported notes from chat with Ece.

* Minor rewording.

* Nav updates.

* Incorporated review feedback.

* Fixed header issue.

* Fixed formatting issues.

* Minor changes.

* Incorporating editorial and technical comments.

* Fixed typo.

* Fixed typo.

* Adding new image.

* Added Janeen's comments.

* Additional edits.

* Update docs/getting-started/security-ui.asciidoc

Co-authored-by: Ryland Herrick <[email protected]>

* Update docs/getting-started/security-ui.asciidoc

Co-authored-by: Ryland Herrick <[email protected]>

* Update docs/getting-started/security-ui.asciidoc

Co-authored-by: Ryland Herrick <[email protected]>

* Incorporating final comments from Joe.

Co-authored-by: Ryland Herrick <[email protected]>

Co-authored-by: Ryland Herrick <[email protected]>
@nastasha-solomon nastasha-solomon deleted the issue-797-773-CTI-enhancements branch July 29, 2021 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team: Docs Team: Security Platform Includes Cyber Threat Intelligence (CTI) team v7.14.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants