-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
Add developer documentation about the building blocks we offer plugin developers #92743
Add developer documentation about the building blocks we offer plugin developers #92743
Conversation
370c005
to
1e9b6ff
Compare
1e9b6ff
to
1c7530c
Compare
1c7530c
to
414b2a6
Compare
@clintandrewhall - Can you review the Dashboard Embeddable section? The goal of this document is to help plugin developers understand what tools are available to them when creating a plugin and when and why to use them. It's introductory material, so I'm not getting too detailed. The details, along with information on how to use these components, should be linked to when possible. More services should be added to this document over time, I'm just starting small. |
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
@elasticmachine merge upstream |
💚 Build SucceededMetrics [docs]Async chunks
Page load bundle
History
To update your PR or re-run it, just comment with: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a few details to Lens embeddable
Planning to merge tomorrow. If anyone doesn't get around to reviewing before then, please feel free to change the doc as you see fit in a follow-up PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, i think its a nice first version and we can hopefully gradually add more information
… developers (elastic#92743) * Create building_blocks.mdx * Update dev_docs/building_blocks.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/building_blocks.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/building_blocks.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * add description to Lens embeddable Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> Co-authored-by: Joe Reuter <johannes.reuter@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
💔 Backport failedThe backport operation could not be completed due to the following error: To backport manually, check out the target branch and run: |
…bana into task-manager/docs-monitoring * 'task-manager/docs-monitoring' of github.com:gmmorris/kibana: [ILM] Allow multiple searchable snapshot actions (elastic#92789) Improve consistency for display of management items (elastic#92694) skip flaky suite (elastic#93152) skip flaky suite (elastic#93152) [ILM] Refactor edit_policy client integration tests into separate feature files (elastic#92826) Add developer documentation about the building blocks we offer plugin developers (elastic#92743) [Security Solution] Case ui enhancement (elastic#91863) [Security Solution] [Detections] Updates warning message when no indices match provided index patterns (elastic#93094) Collect agent telemetry even when fleet server is disabled. (elastic#93198) [Lens] Fix runtime validation error message (elastic#93195) [Lens] Remove warning about ordinal x-domain (elastic#93049) [Security Solution] Fixes the Customize Event Renderers modal by removing the EuiOverlayMask (elastic#93150) Cleanup Security plugin imports (elastic#93056) [Security Solution] - Bug fixes (elastic#92294) Updated doc links (elastic#92968) [ML] Transforms: Fixes chart histograms for runtime fields. (elastic#93028) [chore] Enable core's eslint rule: `@ts-expect-error` (elastic#93086)
… developers (#92743) (#93226) * Create building_blocks.mdx * Update dev_docs/building_blocks.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/building_blocks.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/building_blocks.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * add description to Lens embeddable Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> Co-authored-by: Joe Reuter <johannes.reuter@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> Co-authored-by: Joe Reuter <johannes.reuter@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
* master: (199 commits) Convert Canvas docs to MDX for use in Elastic Docs (elastic#91969) [Bazel] More resilient Workspace Status (elastic#93244) [Discover] Change icon of saved search in open search panel and embeddable selection (elastic#93001) [Workplace Search] Role Mappings to Kibana (elastic#93123) [Fleet] Use type-only imports where possible (elastic#92979) [Lens] Set pie chart slices sorted clockwise (elastic#92617) Remove ms label from CPU load on status page (elastic#92836) [App Search] Migrate Create Meta Engine View (elastic#92127) [Time to Visualize] Disable Visualize URL Tracker When Linked to OriginatingApp (elastic#92917) [ILM] Allow multiple searchable snapshot actions (elastic#92789) Improve consistency for display of management items (elastic#92694) skip flaky suite (elastic#93152) skip flaky suite (elastic#93152) [ILM] Refactor edit_policy client integration tests into separate feature files (elastic#92826) Add developer documentation about the building blocks we offer plugin developers (elastic#92743) [Security Solution] Case ui enhancement (elastic#91863) [Security Solution] [Detections] Updates warning message when no indices match provided index patterns (elastic#93094) Collect agent telemetry even when fleet server is disabled. (elastic#93198) [Lens] Fix runtime validation error message (elastic#93195) [Lens] Remove warning about ordinal x-domain (elastic#93049) ...
The goal of this document is to help plugin developers understand what tools are available to them when creating a plugin and when and why to use them.
An initial pass at adding documentation for some of our platform building blocks. Many more that can be added, I've started with most of the App Services components, and Saved Objects from core.