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

Add developer documentation about the building blocks we offer plugin developers #92743

Merged

Conversation

stacey-gammon
Copy link
Contributor

@stacey-gammon stacey-gammon commented Feb 25, 2021

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.

Screen Shot 2021-02-24 at 7 31 37 PM

Screen Shot 2021-02-24 at 10 06 47 PM

@stacey-gammon stacey-gammon force-pushed the 2021-02-10-arch-building-blocks branch 2 times, most recently from 370c005 to 1e9b6ff Compare February 25, 2021 03:10
@stacey-gammon stacey-gammon marked this pull request as ready for review February 25, 2021 03:11
@stacey-gammon stacey-gammon force-pushed the 2021-02-10-arch-building-blocks branch from 1e9b6ff to 1c7530c Compare February 25, 2021 03:12
@stacey-gammon stacey-gammon force-pushed the 2021-02-10-arch-building-blocks branch from 1c7530c to 414b2a6 Compare February 25, 2021 03:13
@stacey-gammon stacey-gammon added v7.13.0 v8.0.0 release_note:skip Skip the PR/issue when compiling release notes labels Feb 25, 2021
@stacey-gammon
Copy link
Contributor Author

@clintandrewhall - Can you review the Dashboard Embeddable section?
@flash1293 - Could you look at the Lens Embeddable section?
@lizozom - Can you check out the Search sections?
@streamich - Can you review the Embeddable and UI Actions sections?
@thomasneirynck - Can you review the Map 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.

dev_docs/building_blocks.mdx Outdated Show resolved Hide resolved
dev_docs/building_blocks.mdx Outdated Show resolved Hide resolved
dev_docs/building_blocks.mdx Outdated Show resolved Hide resolved
stacey-gammon and others added 3 commits February 26, 2021 07:47
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>
@stacey-gammon
Copy link
Contributor Author

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
triggersActionsUi 1.6MB 1.5MB -23.9KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
triggersActionsUi 104.0KB 104.1KB +82.0B
Unknown metric groups

async chunk count

id before after diff
triggersActionsUi 41 42 +1

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Copy link
Contributor

@flash1293 flash1293 left a 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

@stacey-gammon
Copy link
Contributor Author

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.

Copy link
Member

@ppisljar ppisljar left a 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

@stacey-gammon stacey-gammon merged commit 3d54379 into elastic:master Mar 2, 2021
@stacey-gammon stacey-gammon added the auto-backport Deprecated - use backport:version if exact versions are needed label Mar 2, 2021
stacey-gammon added a commit to stacey-gammon/kibana that referenced this pull request Mar 2, 2021
… 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>
@kibanamachine
Copy link
Contributor

💔 Backport failed

The backport operation could not be completed due to the following error:
There are no branches to backport to. Aborting.

To backport manually, check out the target branch and run:
node scripts/backport --pr 92743

gmmorris added a commit to gmmorris/kibana that referenced this pull request Mar 2, 2021
…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)
stacey-gammon added a commit that referenced this pull request Mar 2, 2021
… 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>
gmmorris added a commit to gmmorris/kibana that referenced this pull request Mar 2, 2021
* 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)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed release_note:skip Skip the PR/issue when compiling release notes v7.13.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants