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

AI Assistant docs for 8.9 #3549

Merged
merged 17 commits into from
Jul 25, 2023
Merged

AI Assistant docs for 8.9 #3549

merged 17 commits into from
Jul 25, 2023

Conversation

joepeeples
Copy link
Contributor

@joepeeples joepeeples commented Jul 10, 2023

Resolves #3427.

Preview: AI Assistant

Note: OpenAI token usage dashboard to be documented separately.

Timeline tab still says "Security Assistant" in BC3
@joepeeples joepeeples added v8.9.0 Priority: High Issues that are time-sensitive and/or are of high customer importance Team: GenAI Generative AI team Effort: Large Issues that require significant planning, research, writing, and testing labels Jul 10, 2023
@github-actions
Copy link

Documentation previews:

@benironside benironside marked this pull request as ready for review July 17, 2023 21:30
Copy link
Contributor Author

@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.

Looks great so far! I added some nits and quibbles on sentence-level stuff, but overall this is coming along very nicely!

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
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
@benironside benironside requested review from spong, dhru42 and a team July 19, 2023 23:33
@banderror
Copy link
Contributor

Since @spong is on PTO until the release, @andrew-goldstein @stephmilovic would you please be able to review this PR?

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.

Lot's of great, helpful new content here! I left some suggestions that are totally optional. Great job, both!

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 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
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.

Looks good! Left a few small comments and responses to previous feedback. So cool to read about these new awesome features! 🎉

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 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
@benironside benironside merged commit d5f05c1 into main Jul 25, 2023
mergify bot pushed a commit that referenced this pull request Jul 25, 2023
* Rename the AI Assistant

Timeline tab still says "Security Assistant" in BC3

* Remove feature flag instructions

* Update overview GIF

* Add data statement, revise callout

* Draft of 8.9 updates

* fixes broken image ref

* Incorporates Joe's feedback

* Apply suggestions from Nastasha's review

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

* Incorporates Janeen's and Nastasha's feedback

---------

Co-authored-by: benironside <[email protected]>
Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit d5f05c1)
benironside pushed a commit that referenced this pull request Jul 25, 2023
* Rename the AI Assistant

Timeline tab still says "Security Assistant" in BC3

* Remove feature flag instructions

* Update overview GIF

* Add data statement, revise callout

* Draft of 8.9 updates

* fixes broken image ref

* Incorporates Joe's feedback

* Apply suggestions from Nastasha's review

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

* Incorporates Janeen's and Nastasha's feedback

---------

Co-authored-by: benironside <[email protected]>
Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit d5f05c1)

Co-authored-by: Joe Peeples <[email protected]>
joepeeples added a commit to elastic/kibana that referenced this pull request Jul 26, 2023
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jul 26, 2023
…or (elastic#162374)

## Summary

Contributes to elastic/security-docs#3549;
documents the new Generative AI Token Usage dashboard.

Preview: [Generative AI connector | Token usage
dashboard](https://kibana_162374.docs-preview.app.elstc.co/guide/en/kibana/master/gen-ai-action-type.html#gen-ai-connector-token-dashboard)

(cherry picked from commit 34e6997)
kibanamachine referenced this pull request in elastic/kibana Jul 26, 2023
…onnector (#162374) (#162585)

# Backport

This will backport the following commits from `main` to `8.9`:
- [[DOCS] Document Generative AI Token Usage dashboard in Gen AI
connector (#162374)](#162374)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Joe
Peeples","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-07-26T15:55:16Z","message":"[DOCS]
Document Generative AI Token Usage dashboard in Gen AI connector
(#162374)\n\n## Summary\r\n\r\nContributes to
https://github.com/elastic/security-docs/pull/3549;\r\ndocuments the new
Generative AI Token Usage dashboard.\r\n\r\nPreview: [Generative AI
connector | Token
usage\r\ndashboard](https://kibana_162374.docs-preview.app.elstc.co/guide/en/kibana/master/gen-ai-action-type.html#gen-ai-connector-token-dashboard)","sha":"34e6997432c389a3a7e0b41a1267b7a3bf4a29e8","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","v8.9.0","v8.10.0","Feature:GenAI"],"number":162374,"url":"https://github.com/elastic/kibana/pull/162374","mergeCommit":{"message":"[DOCS]
Document Generative AI Token Usage dashboard in Gen AI connector
(#162374)\n\n## Summary\r\n\r\nContributes to
https://github.com/elastic/security-docs/pull/3549;\r\ndocuments the new
Generative AI Token Usage dashboard.\r\n\r\nPreview: [Generative AI
connector | Token
usage\r\ndashboard](https://kibana_162374.docs-preview.app.elstc.co/guide/en/kibana/master/gen-ai-action-type.html#gen-ai-connector-token-dashboard)","sha":"34e6997432c389a3a7e0b41a1267b7a3bf4a29e8"}},"sourceBranch":"main","suggestedTargetBranches":["8.9"],"targetPullRequestStates":[{"branch":"8.9","label":"v8.9.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/162374","number":162374,"mergeCommit":{"message":"[DOCS]
Document Generative AI Token Usage dashboard in Gen AI connector
(#162374)\n\n## Summary\r\n\r\nContributes to
https://github.com/elastic/security-docs/pull/3549;\r\ndocuments the new
Generative AI Token Usage dashboard.\r\n\r\nPreview: [Generative AI
connector | Token
usage\r\ndashboard](https://kibana_162374.docs-preview.app.elstc.co/guide/en/kibana/master/gen-ai-action-type.html#gen-ai-connector-token-dashboard)","sha":"34e6997432c389a3a7e0b41a1267b7a3bf4a29e8"}}]}]
BACKPORT-->

Co-authored-by: Joe Peeples <[email protected]>
Copy link
Collaborator

@dhru42 dhru42 left a comment

Choose a reason for hiding this comment

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

reviewed

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.

I was out when this came up for review, but just got a chance to go over everything and it all looks great @joepeeples! And thank you @jmikell821 and @nastasha-solomon for the thorough review as well! 🙂

@joepeeples
Copy link
Contributor Author

I was out when this came up for review, but just got a chance to go over everything and it all looks great @joepeeples! And thank you @jmikell821 and @nastasha-solomon for the thorough review as well! 🙂

Thanks @spong! A lot of the updates for 8.9 docs came from @benironside, too. Big team effort! 🚀

@joepeeples joepeeples deleted the 3427-AI-Assistant-8.9 branch July 28, 2023 19:17
ThomThomson pushed a commit to ThomThomson/kibana that referenced this pull request Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Effort: Large Issues that require significant planning, research, writing, and testing Priority: High Issues that are time-sensitive and/or are of high customer importance Team: GenAI Generative AI team v8.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Expand and refine docs for AI Assistant [8.9.0]
7 participants