elastic / kibana

Your window into the Elastic Stack
https://www.elastic.co/products/kibana
Other
19.48k stars 8.05k forks source link

[Discover] Add contextual awareness framework developer documentation #184698

Open davismcphee opened 1 month ago

davismcphee commented 1 month ago

📓 Summary

This issue covers adding developer documentation for the Discover contextual awareness framework introduced in #183797. We can use the PR summary as the basis for the documentation, and add additional examples and code samples to guide developers in using the framework.

✔️ Acceptance criteria

elasticmachine commented 1 month ago

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

kertal commented 1 month ago

About examples, do you mean some examples in a readme or something in /examples like https://github.com/elastic/kibana/tree/73e72b0f5e8b433c2ddd6b513e84895eacd495cd/examples/discover_customization_examples

davismcphee commented 1 month ago

@kertal For this issue, I mean some code examples for how to set up new providers, etc. in the readme. But the functional test work I'm doing will also add some example profiles that can be enabled for functional and dev testing, and we can reference those in the docs too.

kertal commented 1 month ago

thx, this makes much of sense 👍