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

[Saved Objects] Help text should reference saved search instead of visualizations #34709

Closed
alexfrancoeur opened this issue Apr 8, 2019 · 7 comments · Fixed by #34896
Closed
Assignees
Labels
bug Fixes for quality problems that affect the customer experience Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@alexfrancoeur
Copy link

In this example, we're showing the appropriate warning

Screen Shot 2019-04-08 at 8 39 35 AM

Flight logs is a saved search, I wouldn't expect the text to reference visualizations.

Screen Shot 2019-04-08 at 8 39 38 AM

I could see this being fixed in one of two ways. Making the first warning more generic to include generically say saved objects. We'll be continuing to add more that can be embedded into a dashboard, Maps maps being one example. The other is to make each help text reference the particular saved object. This could get repetitive quick.

cc: @mikecote

@alexfrancoeur alexfrancoeur added bug Fixes for quality problems that affect the customer experience Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc labels Apr 8, 2019
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-platform

@mikecote
Copy link
Contributor

mikecote commented Apr 8, 2019

I will be working on it this week, feel free to ping me if you want to strategize on changes. I am thinking the generic path and maybe allow customizability as an option (if we want to keep the warnings that exist already).

@alexfrancoeur
Copy link
Author

alexfrancoeur commented Apr 8, 2019 via email

@mikecote mikecote self-assigned this Apr 9, 2019
@mikecote
Copy link
Contributor

mikecote commented Apr 9, 2019

I'm thinking we can do something like below where we have 1 table with the objects the current one depends on and another table where it's objects depending on the current one.

One confusion is the export has an "Include dependencies" or "Include related objects" option that is recursive but this one isn't. By recursive I mean a dashboard would include visualization and visualization's index patterns.

Screen Shot 2019-04-09 at 9 12 09 AM

@alexfrancoeur
Copy link
Author

alexfrancoeur commented Apr 9, 2019

Thanks Mike! My first thought goes back to a single table, similar to the saved object management table itself. Where we can filter by types if needed but in general, all saved objects are kind of mushed together. The multiple tables confused me a bit at first when I opened up the slider. If we take a step back and look at the dependencies, this is what I see. Let me know if I'm missing anything.

  • Dashboard ▶️ Saved Search ▶️ Index Pattern
  • Dashboard ▶️ Visualization ▶️ Index Pattern(s)
  • Saved Search ▶️ Index Pattern
  • Visualization ▶️ Index Pattern(s)
  • Maps ▶️ Index Pattern(s)
  • No dependencies
    • Canvas Workpad
    • Index Patterns
  • Future
    • Dashboard ▶️ Maps ▶️ Index Pattern(s)
    • Alert configuration ▶️ Action ▶️ Secret
    • Report configuration ▶️ Dashboard ▶️ (dependencies listed above)
    • Action ▶️ Secret
    • Secrets - no dependencies?

Nothing really goes too deep. To me, I think it's perfectly acceptable to place all dependencies in the same table. I think we can change the wording on the warning itself to be more generic. Users are already in a saved object management UI, so generally, we can assume they know what a saved object is. What do you think of this error?

Object Type

Here are some saved objects used in this [object type]. You can safely delete this [object type] and its related saved objects will still work properly.

I went with related because I believe this is the relationship view. As far as text goes though, we can probably leverage @gchaps to make it perfect 😄

@gchaps
Copy link
Contributor

gchaps commented Apr 10, 2019

@alexfrancoeur How about this:

Here are the saved objects that this [object type] uses. You can safely delete this [object type] without affecting its saved objects.

Is it ok to day "the saved objects" instead of "some of the same objects"?

@mikecote
Copy link
Contributor

@alexfrancoeur I spoke with the design team and they suggested a single table containing relationships in both directions with the ability to filter on type. Right now the screenshot below doesn't indicate what direction the relationship is in but the design team said we can add a column to indicate that. Thoughts?

The screenshot below is what I have working at this moment. It's showing relationships for a saved search where the saved search depends on an index pattern and is used by a dashboard.

Screen Shot 2019-04-11 at 11 14 11 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience 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