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

[8.15 & Serverless] Update the Security Timeline Documentation in accordance with new Unified Timeline changes #5505

Merged
merged 33 commits into from
Jul 23, 2024

Conversation

nastasha-solomon
Copy link
Contributor

@nastasha-solomon nastasha-solomon commented Jul 3, 2024

Fixes #5341

8.15 previews

Serverless previews

Made duplicate changes in the following places:

@nastasha-solomon nastasha-solomon added Team: Threat Hunting Formerly Data Visibility Feature: Timeline Priority: High Issues that are time-sensitive and/or are of high customer importance Effort: Medium Issues that take moderate but not substantial time to complete Docset: Serverless Issues for Serverless Security Docset: ESS Issues that apply to docs in the Stack release v8.15.0 labels Jul 3, 2024
@nastasha-solomon nastasha-solomon self-assigned this Jul 3, 2024
Copy link

github-actions bot commented Jul 3, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@elasticdocs
Copy link

elasticdocs commented Jul 4, 2024

🚀 Built elastic-dot-co-docs-preview-docs successfully!

Issues? Visit #next-docs in Slack

@nastasha-solomon nastasha-solomon marked this pull request as ready for review July 4, 2024 03:54
@nastasha-solomon nastasha-solomon requested a review from a team as a code owner July 4, 2024 03:54
Copy link
Contributor

@logeekal logeekal left a comment

Choose a reason for hiding this comment

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

Only 2 minor comments. Otherwise looks great. Thank you.

I would also recommend @michaelolo24 to take a look as well.

docs/serverless/investigate/timelines-ui.mdx Outdated Show resolved Hide resolved
docs/events/timeline-ui-overview.asciidoc Outdated Show resolved Hide resolved
@nastasha-solomon
Copy link
Contributor Author

Thanks both! @logeekal let's add the docs for the column features (copy column and edit data view field) to this PR. That'll create fewer PRs for everyone to review and keep the publishing process cleaner.

@logeekal
Copy link
Contributor

Thanks both! @logeekal let's add the docs for the column features (copy column and edit data view field) to this PR. That'll create fewer PRs for everyone to review and keep the publishing process cleaner.

Thanks @nastasha-solomon , makes sense. Below is description of both of those controls.

grafik

Copy Column : copies the values of the columns for all visible rows seperated by new line. If the values are repeated in the table, they will appear multiple times in the copied text.

edit data view field : gives the ability to customize field label, field description or the format of field.

  • Set custom label : Create a label to display in place of the field name in Discover, Maps, Lens, Visualize, and TSVB. Useful for shortening a long field name. Queries and filters use the original field name.
  • Set custom description : Add a description to the field. It's displayed next to the field on the Discover, Lens, and Data View Management pages.
  • Set format: Set your preferred format for displaying the value. Changing the format can affect the value and prevent highlighting in Discover.
  • grafik

@nastasha-solomon
Copy link
Contributor Author

Hey, @logeekal - thanks for providing descriptions for the two new controls that we're providing to users in Timeline. I have a few follow-up questions on the new functionality:

  • Can you share a bit more on the purpose of the Copy Column option? Is there a general use case for this functionality? Why would users want to copy all of the values in a column?

  • Do you know of any feature docs for the Edit data view field option? The descriptions are helpful, but I could use more information on the following:

    • How does this option differ from creating runtime fields and adding them to a data view?
    • Do users need to re-map fields after they rename them?
    • Are there any fields that users should not rename? If so, what are they?
    • How does the Preview panel work? Is it updated in real-time to show what the new field would appear as in event/alert docs?
    Screenshot 2024-07-17 at 11 13 41 PM

Also, @michaelolo24 I still need that updated screenshot of the Correlation tab when you have a chance. 🙏🏼

Thanks, both!

Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic 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 minor suggestions that would apply to both ESS and serverless if you chose to apply them.

docs/events/timeline-ui-overview.asciidoc Outdated Show resolved Hide resolved
docs/events/timeline-ui-overview.asciidoc Outdated Show resolved Hide resolved
docs/events/timeline-ui-overview.asciidoc Outdated Show resolved Hide resolved
Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
nastasha-solomon and others added 6 commits July 22, 2024 17:05
Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
@nastasha-solomon nastasha-solomon merged commit 1fe3f9e into main Jul 23, 2024
4 checks passed
@nastasha-solomon
Copy link
Contributor Author

Validated that changes are on prod server

mergify bot pushed a commit that referenced this pull request Jul 23, 2024
…ordance with new Unified Timeline changes (#5505)

* First draft

* Fix broken image ref

* Runtime fields

* Updated timeline schema

* fixed file ext

* Updates Serverless Timeline docs

* Second batch of Serverless updates

* Fixed typos

* Fixed syntax and image ref

* Made images larger

* One more update to size

* Update docs/serverless/investigate/timelines-ui.mdx

Co-authored-by: Jatin Kathuria <jtn.kathuria@gmail.com>

* Update docs/events/timeline-ui-overview.asciidoc

Co-authored-by: Jatin Kathuria <jtn.kathuria@gmail.com>

* Fixed serverless section

* Minor edits

* More input from dev review

* Updating list in serverless docs

* Updating images for corr tab and temps

* Update docs/events/timeline-ui-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/events/timeline-ui-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/events/timeline-ui-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Nat's edits

* Renamed image for timeline template

* Corrected file name one more time

---------

Co-authored-by: Jatin Kathuria <jtn.kathuria@gmail.com>
Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
(cherry picked from commit 1fe3f9e)

# Conflicts:
#	docs/serverless/explore/runtime-fields.mdx
#	docs/serverless/images/interactive-investigation-guides/-detections-ig-timeline.png
#	docs/serverless/images/timeline-object-schema/-reference-timeline-object-ui.png
#	docs/serverless/images/timelines-ui/-events-correlation-tab-eql-query.png
#	docs/serverless/images/timelines-ui/-events-timeline-ui-filter-options.png
#	docs/serverless/images/timelines-ui/-events-timeline-ui-renderer.png
#	docs/serverless/images/timelines-ui/-events-timeline-ui-updated.png
#	docs/serverless/investigate/timeline-templates-ui.mdx
#	docs/serverless/investigate/timelines-ui.mdx
nastasha-solomon added a commit that referenced this pull request Jul 23, 2024
… in accordance with new Unified Timeline changes (backport #5505) (#5596)

* [8.15 & Serverless] Update the Security Timeline Documentation in accordance with new Unified Timeline changes (#5505)

* First draft

* Fix broken image ref

* Runtime fields

* Updated timeline schema

* fixed file ext

* Updates Serverless Timeline docs

* Second batch of Serverless updates

* Fixed typos

* Fixed syntax and image ref

* Made images larger

* One more update to size

* Update docs/serverless/investigate/timelines-ui.mdx

Co-authored-by: Jatin Kathuria <jtn.kathuria@gmail.com>

* Update docs/events/timeline-ui-overview.asciidoc

Co-authored-by: Jatin Kathuria <jtn.kathuria@gmail.com>

* Fixed serverless section

* Minor edits

* More input from dev review

* Updating list in serverless docs

* Updating images for corr tab and temps

* Update docs/events/timeline-ui-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/events/timeline-ui-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/events/timeline-ui-overview.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Nat's edits

* Renamed image for timeline template

* Corrected file name one more time

---------

Co-authored-by: Jatin Kathuria <jtn.kathuria@gmail.com>
Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
(cherry picked from commit 1fe3f9e)

# Conflicts:
#	docs/serverless/explore/runtime-fields.mdx
#	docs/serverless/images/interactive-investigation-guides/-detections-ig-timeline.png
#	docs/serverless/images/timeline-object-schema/-reference-timeline-object-ui.png
#	docs/serverless/images/timelines-ui/-events-correlation-tab-eql-query.png
#	docs/serverless/images/timelines-ui/-events-timeline-ui-filter-options.png
#	docs/serverless/images/timelines-ui/-events-timeline-ui-renderer.png
#	docs/serverless/images/timelines-ui/-events-timeline-ui-updated.png
#	docs/serverless/investigate/timeline-templates-ui.mdx
#	docs/serverless/investigate/timelines-ui.mdx

* Delete docs/serverless directory and its contents

---------

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@nastasha-solomon nastasha-solomon deleted the issue-5341-unified-timeline-integration branch July 24, 2024 19:05
@nastasha-solomon nastasha-solomon mentioned this pull request Aug 6, 2024
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docset: ESS Issues that apply to docs in the Stack release Docset: Serverless Issues for Serverless Security Effort: Medium Issues that take moderate but not substantial time to complete Feature: Timeline Priority: High Issues that are time-sensitive and/or are of high customer importance Team: Threat Hunting Formerly Data Visibility v8.15.0
Projects
None yet
5 participants