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.

Sign up for GitHub

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

Jump to bottom

[ai][assistant] Create AI Assistant Icon, Avatar, Beacon #203879

Merged
merged 3 commits into from
Dec 13, 2024
Merged

[ai][assistant] Create AI Assistant Icon, Avatar, Beacon #203879

merged 3 commits into from
Dec 13, 2024

Conversation

clintandrewhall
Copy link
Contributor

@clintandrewhall clintandrewhall commented Dec 11, 2024 •
edited
Loading

Summary

The AI Assistant icon exists in several places at the moment, used in more or less the same way, but with different terms and sizes. This PR consolidates those usages into a package that not only enforces consistency throughout Kibana, but also with sizes and terminology used in EUI.

  • AssistantIcon - static logo, equivalent to EuiIcon.
    • used in headers, buttons, etc.
  • AssistantAvatar - personified presence, equivalent to EuiAvatar.
    • used in messages, notifications, etc.
  • AssistantBeacon - animated "hero" logo, adapted equivalent to EuiBeacon.
    • used in welcome screens, banners, upsells, etc.

Dec-11-2024 13-23-57

This PR also creates the ai-assistant directory for additional packages. I anticipate many packages to be created in the coming weeks for logic and components, so having a top-level directory makes sense. It also adds a Storybook.

NOTE: I don't currently have plans to move @kbn/ai-assistant to this directory, or to any other location.

Additional changes

  • This PR deletes Storybook stories that were copied from o11y and were non-functional.
  • This PR moves @kbn/ai-assistant-common to packages/ai-assistant.

Next up

  • Removing deprecated instances, replace call sites.
  • Refactor some icon usages to use beacon.

@clintandrewhall clintandrewhall added review release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting v8.18.0 labels Dec 11, 2024
@clintandrewhall clintandrewhall requested review from a team as code owners December 11, 2024 18:25
@botelastic botelastic bot added ci:project-deploy-observability Create an Observability project Team:Obs AI Assistant Observability AI Assistant labels Dec 11, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ai-assistant (Team:Obs AI Assistant)

@github-actions GitHub Actions
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@clintandrewhall clintandrewhall force-pushed the ai/assistant-logo branch 5 times, most recently from 2f05128 to 937fed4 Compare December 12, 2024 16:59
angorayc
angorayc approved these changes Dec 13, 2024
View reviewed changes
.../security/packages/upselling/sections/attack_discovery/assistant_avatar/assistant_avatar.tsx
@@ -24,7 +24,7 @@ export const sizeMap = {
/**
* Default Elastic AI Assistant logo
*
* TODO: This may be removed when the logo is added to EUI
* @deprecated This component will soon be replaced by `AssistantIcon` from `@kbn/ai-assistant-icon`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Would we want to replace the usage of this deprecated component in

kibana/x-pack/solutions/security/packages/upselling/sections/attack_discovery/index.tsx

Line 33 in 937fed4

<AssistantAvatar size="m" />

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's coming in a separate PR, to make review easier.

Draft: clintandrewhall#37

@clintandrewhall clintandrewhall enabled auto-merge (squash) December 13, 2024 20:53
@elasticmachine
Copy link
Contributor

elasticmachine commented Dec 13, 2024 •
edited
Loading

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
@kbn/ai-assistant-icon - 3 +3
Unknown metric groups

API count

id before after diff
@kbn/ai-assistant-icon - 11 +11

ESLint disabled line counts

id before after diff
@kbn/ai-assistant-icon - 1 +1

References to deprecated APIs

id before after diff
@kbn/ai-assistant 0 4 +4
@kbn/ecs-data-quality-dashboard 0 2 +2
integrationAssistant 0 4 +4
observabilityAIAssistantApp 0 7 +7
searchAssistant 0 2 +2
securitySolution 464 489 +25
total +44

Total ESLint disabled count

id before after diff
@kbn/ai-assistant-icon - 1 +1

History

@clintandrewhall clintandrewhall merged commit 666a0cf into elastic:main Dec 13, 2024
9 checks passed
This was referenced Dec 13, 2024
Open
Merged
Merged
This was referenced Dec 13, 2024
Merged
Merged
Merged
Merged
Merged
Merged
@semd
Copy link
Contributor

semd commented Dec 18, 2024

@clintandrewhall Don't we plan to backport this to 8.x? I have already started using it in a new feature for 8.18.0/9.0.0, and I have issues with the 8.x backport because the package does not exist.

@clintandrewhall
Copy link
Contributor Author

@semd you're absolutely right, an oversight on my part. Thanks for the catch! I'll backport it momentarily

@clintandrewhall clintandrewhall removed the backport:skip This commit does not require backporting label Dec 18, 2024
@clintandrewhall clintandrewhall mentioned this pull request Dec 18, 2024
Merged
@clintandrewhall
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
✅ 8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

clintandrewhall added a commit that referenced this pull request Dec 18, 2024
@clintandrewhall @kibanamachine
[ai][assistant] Refactor search to use new Assistant logo and beacon (#…
e078673 
…204287)

> A follow-up to #203879 

## Summary

This PR integrates the new Assistant Icon, Beacon, and Avatar into
solutions and packages owned by Search. In most cases this was a 1:1
replacement, but in a few, Icon was replaced with Beacon or Beacon was
added for consistency, (e.g. welcome screens, upsells, etc), .

Note: the scaling of the icon/avatar _before_ was one different from
EUI. The new components match EUI directly and represent a 2x scale
change (e.g. 's' becomes 'l', 'm' becomes 'xl', etc).

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
clintandrewhall added a commit that referenced this pull request Dec 18, 2024
@clintandrewhall
[8.x] [ai][assistant] Create AI Assistant Icon, Avatar, Beacon (#203879…
8e17323 
…) (#204745)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[ai][assistant] Create AI Assistant Icon, Avatar, Beacon
(#203879)](#203879)

<!--- Backport version: 8.9.8 -->

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

<!--BACKPORT [{"author":{"name":"Clint Andrew
Hall","email":"clint.hall@elastic.co"},"sourceCommit":{"committedDate":"2024-12-13T21:18:35Z","message":"[ai][assistant]
Create AI Assistant Icon, Avatar, Beacon
(#203879)","sha":"666a0cf9719a0af7c868a36f49b9d478b59a39a2","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["review","release_note:skip","v9.0.0","Team:Obs
AI
Assistant","ci:project-deploy-observability","v8.18.0"],"number":203879,"url":"https://github.com/elastic/kibana/pull/203879","mergeCommit":{"message":"[ai][assistant]
Create AI Assistant Icon, Avatar, Beacon
(#203879)","sha":"666a0cf9719a0af7c868a36f49b9d478b59a39a2"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/203879","number":203879,"mergeCommit":{"message":"[ai][assistant]
Create AI Assistant Icon, Avatar, Beacon
(#203879)","sha":"666a0cf9719a0af7c868a36f49b9d478b59a39a2"}},{"branch":"8.x","label":"v8.18.0","labelRegex":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
clintandrewhall added a commit to clintandrewhall/kibana that referenced this pull request Dec 18, 2024
@clintandrewhall
[ai][assistant] Refactor search to use new Assistant logo and beacon (e…
3508eeb 
…lastic#204287)

> A follow-up to elastic#203879

## Summary

This PR integrates the new Assistant Icon, Beacon, and Avatar into
solutions and packages owned by Search. In most cases this was a 1:1
replacement, but in a few, Icon was replaced with Beacon or Beacon was
added for consistency, (e.g. welcome screens, upsells, etc), .

Note: the scaling of the icon/avatar _before_ was one different from
EUI. The new components match EUI directly and represent a 2x scale
change (e.g. 's' becomes 'l', 'm' becomes 'xl', etc).

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit e078673)
clintandrewhall added a commit that referenced this pull request Dec 18, 2024
@clintandrewhall
[8.x] [ai][assistant] Refactor search to use new Assistant logo and b…
8c436c2 
…eacon (#204287) (#204772)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[ai][assistant] Refactor search to use new Assistant logo and beacon
(#204287)](#204287)

<!--- Backport version: 8.9.8 -->

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

<!--BACKPORT [{"author":{"name":"Clint Andrew
Hall","email":"clint.hall@elastic.co"},"sourceCommit":{"committedDate":"2024-12-18T14:51:45Z","message":"[ai][assistant]
Refactor search to use new Assistant logo and beacon (#204287)\n\n> A
follow-up to #203879 \r\n\r\n## Summary\r\n\r\nThis PR integrates the
new Assistant Icon, Beacon, and Avatar into\r\nsolutions and packages
owned by Search. In most cases this was a 1:1\r\nreplacement, but in a
few, Icon was replaced with Beacon or Beacon was\r\nadded for
consistency, (e.g. welcome screens, upsells, etc), .\r\n\r\nNote: the
scaling of the icon/avatar _before_ was one different from\r\nEUI. The
new components match EUI directly and represent a 2x scale\r\nchange
(e.g. 's' becomes 'l', 'm' becomes 'xl',
etc).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"e0786738c950870c49b4899937cc3904a1b8ef97","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["review","release_note:skip","v9.0.0","backport:version","v8.18.0"],"number":204287,"url":"https://github.com/elastic/kibana/pull/204287","mergeCommit":{"message":"[ai][assistant]
Refactor search to use new Assistant logo and beacon (#204287)\n\n> A
follow-up to #203879 \r\n\r\n## Summary\r\n\r\nThis PR integrates the
new Assistant Icon, Beacon, and Avatar into\r\nsolutions and packages
owned by Search. In most cases this was a 1:1\r\nreplacement, but in a
few, Icon was replaced with Beacon or Beacon was\r\nadded for
consistency, (e.g. welcome screens, upsells, etc), .\r\n\r\nNote: the
scaling of the icon/avatar _before_ was one different from\r\nEUI. The
new components match EUI directly and represent a 2x scale\r\nchange
(e.g. 's' becomes 'l', 'm' becomes 'xl',
etc).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"e0786738c950870c49b4899937cc3904a1b8ef97"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/204287","number":204287,"mergeCommit":{"message":"[ai][assistant]
Refactor search to use new Assistant logo and beacon (#204287)\n\n> A
follow-up to #203879 \r\n\r\n## Summary\r\n\r\nThis PR integrates the
new Assistant Icon, Beacon, and Avatar into\r\nsolutions and packages
owned by Search. In most cases this was a 1:1\r\nreplacement, but in a
few, Icon was replaced with Beacon or Beacon was\r\nadded for
consistency, (e.g. welcome screens, upsells, etc), .\r\n\r\nNote: the
scaling of the icon/avatar _before_ was one different from\r\nEUI. The
new components match EUI directly and represent a 2x scale\r\nchange
(e.g. 's' becomes 'l', 'm' becomes 'xl',
etc).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"e0786738c950870c49b4899937cc3904a1b8ef97"}},{"branch":"8.x","label":"v8.18.0","labelRegex":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
JoseLuisGJ pushed a commit to JoseLuisGJ/kibana that referenced this pull request Dec 19, 2024
@clintandrewhall @kibanamachine @JoseLuisGJ
[ai][assistant] Refactor search to use new Assistant logo and beacon (e…
bed8ecc 
…lastic#204287)

> A follow-up to elastic#203879 

## Summary

This PR integrates the new Assistant Icon, Beacon, and Avatar into
solutions and packages owned by Search. In most cases this was a 1:1
replacement, but in a few, Icon was replaced with Beacon or Beacon was
added for consistency, (e.g. welcome screens, upsells, etc), .

Note: the scaling of the icon/avatar _before_ was one different from
EUI. The new components match EUI directly and represent a 2x scale
change (e.g. 's' becomes 'l', 'm' becomes 'xl', etc).

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sphilipse sphilipse sphilipse approved these changes

@Ikuni17 Ikuni17 Ikuni17 approved these changes

@angorayc angorayc angorayc approved these changes

@andrew-goldstein andrew-goldstein andrew-goldstein approved these changes

@neptunian neptunian neptunian approved these changes

Assignees
No one assigned
Labels
ci:project-deploy-observability Create an Observability project release_note:skip Skip the PR/issue when compiling release notes review Team:Obs AI Assistant Observability AI Assistant v8.18.0 v9.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@clintandrewhall @elasticmachine @semd @neptunian @andrew-goldstein @angorayc @Ikuni17 @sphilipse @kibanamachine