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

[GS] Add metadata to application results #77114

Closed
ryankeairns opened this issue Sep 9, 2020 · 6 comments · Fixed by #77662
Closed

[GS] Add metadata to application results #77114

ryankeairns opened this issue Sep 9, 2020 · 6 comments · Fixed by #77662
Labels
REASSIGN from Team:Core UI Deprecated label for old Core UI team Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@ryankeairns
Copy link
Contributor

ryankeairns commented Sep 9, 2020

Relates to #72331
Relates to #76778

Describe the feature:
Display metadata on navigational search results for apps

Describe a specific use case for the feature:
Application titles in and of themselves are not sufficient in clearly identifying navigation search results.

For example, Administration is a generic term that, in our case, navigates you into the Security solution. Additionally, we have two (soon three) Overview apps differentiated only by their solution logo:

Screen Shot 2020-09-09 at 11 43 58 AM

Screen Shot 2020-09-09 at 11 43 42 AM

Essentially, we're suggesting a change to the original design by adding the 'subtitle' (i.e. optional metadata) to the application results. For example, the Overview result could have Security underneath like the Canvas workpad text below:

Screen Shot 2020-09-09 at 3 40 57 PM

For the Platform team

Here is what we currently have to work with, which aligns to the original design. For this additional metadata, I suppose app teams would have to provide it (via plugin registry?) and, in turn, the API pipes it through. Is that about right?

Screen Shot 2020-09-09 at 16 30 29

Also, could this be tackled along with the aliases issue #76778 ?

@ryankeairns ryankeairns added REASSIGN from Team:Core UI Deprecated label for old Core UI team Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc labels Sep 9, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core-ui (Team:Core UI)

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-platform (Team:Platform)

@pgayvallet
Copy link
Contributor

Essentially, we're suggesting a change to the original design by adding the 'subtitle' (i.e. optional metadata) to the application results. For example, the Overview result could have Security underneath like the Canvas workpad text below:

Adding metadata to the application results is perfectly doable. The only question is, how do we want these meta to be populated.

One option would be to automatically add the app's category id and label as meta.categoryId and meta.categoryLabel. Looking at your example, I think it would work, as the securitySolution's OVERVIEW app is in the security category.

Do you think this would answer the need, or do we already know we want something that the apps can define themselves?

@ryankeairns
Copy link
Contributor Author

@pgayvallet thanks, I do think that answers the need!

Digging around, I believe you are referring to the id and label here? https://github.com/elastic/kibana/blob/043ef5e1d7f1492609c975264e89fe4bb59fb02b/src/core/utils/default_app_categories.ts

I am +1 for taking this approach as it would be consistent and 'automatic'.

@alexfrancoeur , I presume you are ok with this as well?

@alexfrancoeur
Copy link

alexfrancoeur commented Sep 15, 2020

+1, this approach sounds good to me. Metadata would be a great addition. Is this something we can accommodate for 7.10?

@pgayvallet
Copy link
Contributor

Digging around, I believe you are referring to the id and label here?

Yea, that's it

Is this something we can accommodate for 7.10?

I will open a PR to add these metadata to the GS application results this week. Then @myasonik will have to use it in the search bar results UI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
REASSIGN from Team:Core UI Deprecated label for old Core UI team Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants