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

[Docs] Document SampleDataRegistry to add sample saved objects from plugins #3244

Open
VijayanB opened this issue Jan 11, 2023 · 4 comments
Open
Labels

Comments

@VijayanB
Copy link
Member

Is your feature request related to a problem? Please describe.

Plugins can extend or add new saved objects that are part of sample data.

Describe the solution you'd like

Maps ( dashboards-maps) would like to add additional saved objects of type maps, whenever sample data is added to dashboards. This will help Maps users to experiment Maps with sample data set .

Describe alternatives you've considered

N/A

Additional context

It will be great if plugins could also contribute new sample data and saved objects.

@VijayanB VijayanB added the enhancement New feature or request label Jan 11, 2023
@VijayanB VijayanB changed the title Accept saved objects from plugins Accept or Include sample saved objects from plugins Jan 11, 2023
@ashwin-pc
Copy link
Member

ashwin-pc commented Jan 11, 2023

@VijayanB I think you can already do this using the SampleDataRegistry service exposed by the home plugin. I personally haven't used it, but its api exposes exactly what you need. e.g. addSavedObjectsToSampleDataset or if you want to add a new same dataset all together, you can simply use the registerSampleDataset api

@joshuarrrr
Copy link
Member

For some additional context, you may also be interested in reviewing #1747 and #1869. But we'd love to have an example of sample data integration for other plugin authors to reference, so please link any issue you have to track this work on the mapping side.

@joshuarrrr
Copy link
Member

I also added the needs-documentation label as a reminder that having a service or API is a great start, but it's not that useful if it lacks usage docs.

@ashwin-pc ashwin-pc changed the title Accept or Include sample saved objects from plugins [Docs] Document SampleDataRegistry to add sample saved objects from plugins Mar 3, 2023
@ashwin-pc
Copy link
Member

Renaming the issue title since the feature already exists

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants