Skip to content

Commit

Permalink
[8.1] [DOCS] Removes legacy plugins (elastic#149545) (elastic#149761)
Browse files Browse the repository at this point in the history
# Backport

This will backport the following commits from `main` to `8.1`:
- [[DOCS] Removes legacy plugins
(elastic#149545)](elastic#149545)
  • Loading branch information
KOTungseth authored Jan 27, 2023
1 parent f2d27d8 commit 3fa7b5c
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 627 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,6 @@ of Kibana.
|store session data in the LocalStorage when the user navigates away from {kib}, etc.
|===

There is no equivalent behavior to `start` or `stop` in legacy plugins.
Conversely, there is no equivalent to `uiExports` in Kibana Platform plugins.
As a general rule of thumb, features that were registered via `uiExports` are
now registered during the `setup` phase. Most of everything else should move
Expand Down Expand Up @@ -339,9 +338,3 @@ interface where the property name is the plugin's ID.
the second argument to the plugin.
<3> Notice that the type for the setup and start lifecycles are different. Plugin lifecycle
functions can only access the APIs that are exposed _during_ that lifecycle.

=== Migrating legacy plugins

In Kibana 7.10, support for legacy plugins was removed. See
<<migrating-legacy-plugins>> for detailed information on how to convert existing
legacy plugins to this new API.
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,6 @@ TypeScript code is automatically converted into JavaScript during development,
but not in the distributable version of {kib}. If you use the
{kib-repo}blob/{branch}/packages/kbn-plugin-helpers[@kbn/plugin-helpers] to build your plugin, then your `.ts` and `.tsx` files will be permanently transpiled before your plugin is archived. If you have your own build process, make sure to run the TypeScript compiler on your source files and ship the compilation output so that your plugin will work with the distributable version of {kib}.

[discrete]
=== {kib} platform migration guide

<<migrating-legacy-plugins, This guide>>
provides an action plan for moving a legacy plugin to the new platform.
<<migrating-legacy-plugins-examples, Provides>> migration examples for the legacy core services.

[discrete]
=== Externally developed plugins

Expand Down
6 changes: 1 addition & 5 deletions docs/developer/plugin/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,11 @@ Most developers who contribute code directly to the {kib} repo are writing code
start. However, there are a few differences when developing plugins outside the {kib} repo. These differences are covered here.

* <<plugin-tooling>>
* <<migrating-legacy-plugins>>
* <<migrating-legacy-plugins-examples>>
* <<external-plugin-functional-tests>>
* <<external-plugin-localization>>
* <<testing-kibana-plugin>>

include::plugin-tooling.asciidoc[leveloffset=+1]
include::migrating-legacy-plugins.asciidoc[leveloffset=+1]
include::migrating-legacy-plugins-examples.asciidoc[leveloffset=+1]
include::external-plugin-functional-tests.asciidoc[leveloffset=+1]
include::external-plugin-localization.asciidoc[leveloffset=+1]
include::testing-kibana-plugin.asciidoc[leveloffset=+1]
include::testing-kibana-plugin.asciidoc[leveloffset=+1]
Loading

0 comments on commit 3fa7b5c

Please sign in to comment.