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

Elastic Security Assistant initial docs (8.8.1) #3425

Merged
merged 8 commits into from
Jun 8, 2023

Conversation

joepeeples
Copy link
Contributor

@joepeeples joepeeples commented Jun 7, 2023

Resolves #3420.

Preview: Security Assistant

Notes

  • These docs are intended to be somewhat minimal, focusing on making sure readers know how to set up the Assistant and use some basic functionality. Further nuances of functionality, best practices, known issues, and so on will be expanded in future iterations (8.9 docs, etc.).

EDIT: removed Open Questions, which are now Answered Questions below.

@joepeeples joepeeples added v8.8.0 v8.8.1 Priority: Medium Issues that have relevance, but aren't urgent Team: GenAI Generative AI team labels Jun 7, 2023
@joepeeples joepeeples self-assigned this Jun 7, 2023
@github-actions
Copy link

github-actions bot commented Jun 7, 2023

Documentation previews:

@mergify

This comment was marked as resolved.

@jamesspi
Copy link
Collaborator

jamesspi commented Jun 7, 2023

Hey @joepeeples

This is looking great! Perhaps we could squeeze in a quick gif?

To answer your Q's:

Is there an official name? How should it be used?
If the name is Elastic Security Assistant, is it OK to sometimes shorten to just Security Assistant?

We're going for Elastic Security Assistant for 8.8.1. It's fine to shorter in to Security Assistant.

Does the name include the, as in the Security Assistant?

I don't think it matters too much. Did you have a place In mind where you wanted to reference it as such?

@joepeeples
Copy link
Contributor Author

@jamesspi:

Perhaps we could squeeze in a quick gif?

There are a couple of animated gifs in the page; I added them in the last commit so maybe you viewed the preview before CI had published that commit? But if you'd like another gif showing some other process, just let me know and we can figure it out.

I don't think it matters too much. Did you have a place In mind where you wanted to reference it as such ("the Security Assistant")?

I used "the Security Assistant" pretty consistently throughout the draft, so I was just confirming that's OK for now.

Copy link
Contributor

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

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

Thanks for creating this @joepeeples! It's a great first iteration and I think it'll be helpful for getting users off the ground so they can tinker with the Security Assistant.

I left some suggestions for your consideration. Otherwise, it LGTM!

docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
docs/assistant/security-assistant.asciidoc Show resolved Hide resolved
docs/assistant/security-assistant.asciidoc Show resolved Hide resolved
docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
@jamesspi
Copy link
Collaborator

jamesspi commented Jun 7, 2023

@jamesspi:

Perhaps we could squeeze in a quick gif?

There are a couple of animated gifs in the page; I added them in the last commit so maybe you viewed the preview before CI had published that commit? But if you'd like another gif showing some other process, just let me know and we can figure it out.

I don't think it matters too much. Did you have a place In mind where you wanted to reference it as such ("the Security Assistant")?

I used "the Security Assistant" pretty consistently throughout the draft, so I was just confirming that's OK for now.

@joepeeples Indeed, I see the gifs now, thanks!

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.

Two comments for part 1 of feedback.

docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
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.

This is an awesome first iteration!!! Thanks @joepeeples

docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
docs/assistant/security-assistant.asciidoc Outdated Show resolved Hide resolved
Co-authored-by: Janeen Mikell Roberts <[email protected]>
Co-authored-by: Nastasha Solomon <[email protected]>
Copy link
Member

@spong spong left a comment

Choose a reason for hiding this comment

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

Docs LGTM! 👍 Thanks so much @joepeeples! 😀

Copy link
Collaborator

@jamesspi jamesspi left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

@joepeeples joepeeples merged commit 8b55048 into main Jun 8, 2023
mergify bot pushed a commit that referenced this pull request Jun 8, 2023
* First draft, text only

* Add images, a few edits

* Apply suggestions from Nastasha's review

Co-authored-by: Nastasha Solomon <[email protected]>

* Apply suggestions from Janeen & Nastasha's review

Co-authored-by: Janeen Mikell Roberts <[email protected]>
Co-authored-by: Nastasha Solomon <[email protected]>

* Moar suggestions from code review

* One more edit

---------

Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: Janeen Mikell Roberts <[email protected]>
(cherry picked from commit 8b55048)
joepeeples added a commit that referenced this pull request Jun 8, 2023
* First draft, text only

* Add images, a few edits

* Apply suggestions from Nastasha's review

Co-authored-by: Nastasha Solomon <[email protected]>

* Apply suggestions from Janeen & Nastasha's review

Co-authored-by: Janeen Mikell Roberts <[email protected]>
Co-authored-by: Nastasha Solomon <[email protected]>

* Moar suggestions from code review

* One more edit

---------

Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: Janeen Mikell Roberts <[email protected]>
(cherry picked from commit 8b55048)

Co-authored-by: Joe Peeples <[email protected]>
@joepeeples joepeeples deleted the 3420-security-assistant branch June 8, 2023 03:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Medium Issues that have relevance, but aren't urgent Team: GenAI Generative AI team v8.8.0 v8.8.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Elastic Security Assistant overview (docs for 8.8.1)
5 participants