[7.x] [DOCS] Adds kibana-pull attribute for release docs (#69554) (#69574)

This commit is contained in:
Lisa Cawley 2020-06-23 09:22:30 -07:00 committed by GitHub
parent b2eec07853
commit c219e405ad
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 3707 additions and 3715 deletions

File diff suppressed because it is too large Load diff

View file

@ -22,7 +22,7 @@ init(server) {
-----------
===== Feature details
Registering a feature consists of the following fields. For more information, consult the {repo}blob/{branch}/x-pack/plugins/features/server/feature_registry.ts[feature registry interface].
Registering a feature consists of the following fields. For more information, consult the {kib-repo}blob/{branch}/x-pack/plugins/features/server/feature_registry.ts[feature registry interface].
[cols="1a, 1a, 1a, 1a"]
@ -45,12 +45,12 @@ Registering a feature consists of the following fields. For more information, co
|An array of applications this feature enables. Typically, all of your plugin's apps (from `uiExports`) will be included here.
|`privileges` (required)
|{repo}blob/{branch}/x-pack/plugins/features/common/feature.ts[`FeatureConfig`].
|{kib-repo}blob/{branch}/x-pack/plugins/features/common/feature.ts[`FeatureConfig`].
|See <<example-1-canvas,Example 1>> and <<example-2-dev-tools,Example 2>>
|The set of privileges this feature requires to function.
|`subFeatures` (optional)
|{repo}blob/{branch}/x-pack/plugins/features/common/feature.ts[`FeatureConfig`].
|{kib-repo}blob/{branch}/x-pack/plugins/features/common/feature.ts[`FeatureConfig`].
|See <<example-3-discover,Example 3>>
|The set of subfeatures that enables finer access control than the `all` and `read` feature privileges. These options are only available in the Gold subscription level and higher.
@ -68,7 +68,7 @@ Registering a feature consists of the following fields. For more information, co
===== Privilege definition
The `privileges` section of feature registration allows plugins to implement read/write and read-only modes for their applications.
For a full explanation of fields and options, consult the {repo}blob/{branch}/x-pack/plugins/features/server/feature_registry.ts[feature registry interface].
For a full explanation of fields and options, consult the {kib-repo}blob/{branch}/x-pack/plugins/features/server/feature_registry.ts[feature registry interface].
==== Using UI Capabilities

View file

@ -85,5 +85,5 @@ node ../../kibana/scripts/functional_test_runner
[float]
==== Using esArchiver
We're working on documentation for this, but for now the best place to look is the original {pull}10359[pull request].
We're working on documentation for this, but for now the best place to look is the original {kibana-pull}10359[pull request].

View file

@ -109,7 +109,7 @@ export const HELLO_WORLD = i18n.translate('hello.wonderful.world', {
});
-----------
Full details are {repo}tree/master/packages/kbn-i18n#vanilla-js[here].
Full details are {kib-repo}tree/master/packages/kbn-i18n#vanilla-js[here].
[float]
===== i18n for React
@ -133,7 +133,7 @@ export const Component = () => {
};
-----------
Full details are {repo}tree/master/packages/kbn-i18n#react[here].
Full details are {kib-repo}tree/master/packages/kbn-i18n#react[here].
@ -153,7 +153,7 @@ The translation directive has the following syntax:
></ANY>
-----------
Full details are {repo}tree/master/packages/kbn-i18n#angularjs[here].
Full details are {kib-repo}tree/master/packages/kbn-i18n#angularjs[here].
[float]

View file

@ -5,12 +5,12 @@ Here are some resources that are helpful for getting started with plugin develop
[float]
==== Some light reading
Our {repo}blob/master/CONTRIBUTING.md[contributing guide] can help you get a development environment going.
Our {kib-repo}blob/master/CONTRIBUTING.md[contributing guide] can help you get a development environment going.
[float]
==== Plugin Generator
We recommend that you kick-start your plugin by generating it with the {repo}tree/{branch}/packages/kbn-plugin-generator[Kibana Plugin Generator]. Run the following in the Kibana repo, and you will be asked a couple questions, see some progress bars, and have a freshly generated plugin ready for you to play with in Kibana's `plugins` folder.
We recommend that you kick-start your plugin by generating it with the {kib-repo}tree/{branch}/packages/kbn-plugin-generator[Kibana Plugin Generator]. Run the following in the Kibana repo, and you will be asked a couple questions, see some progress bars, and have a freshly generated plugin ready for you to play with in Kibana's `plugins` folder.
["source","shell"]
-----------
@ -34,7 +34,7 @@ The Kibana directory must be named `kibana`, and your plugin directory should be
[float]
==== References in the code
- {repo}blob/{branch}/src/legacy/server/plugins/lib/plugin.js[Plugin class]: What options does the `kibana.Plugin` class accept?
- {kib-repo}blob/{branch}/src/legacy/server/plugins/lib/plugin.js[Plugin class]: What options does the `kibana.Plugin` class accept?
- <<development-uiexports>>: What type of exports are available?
[float]
@ -65,9 +65,9 @@ To enable TypeScript support, create a `tsconfig.json` file at the root of your
TypeScript code is automatically converted into JavaScript during development,
but not in the distributable version of Kibana. If you use the
{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 Kibana.
{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 Kibana.
==== {kib} platform migration guide
{repo}blob/{branch}/src/core/MIGRATION.md#migrating-legacy-plugins-to-the-new-platform[This guide]
{kib-repo}blob/{branch}/src/core/MIGRATION.md#migrating-legacy-plugins-to-the-new-platform[This guide]
provides an action plan for moving a legacy plugin to the new platform.

View file

@ -22,5 +22,5 @@ here are a few resources:
* The <<breaking-changes,breaking changes>> documentation, where we try to capture any changes to the APIs as they occur across minors.
* link:https://github.com/elastic/kibana/issues/44121[Meta issue] which is tracking the move of the plugin to the new Kibana platform
* Our link:https://www.elastic.co/blog/join-our-elastic-stack-workspace-on-slack[Elastic Stack workspace on Slack].
* The {repo}blob/{branch}/src/plugins/visualizations[source code], which will continue to be
* The {kib-repo}blob/{branch}/src/plugins/visualizations[source code], which will continue to be
the most accurate source of information.

View file

@ -11,14 +11,10 @@ release-state can be: released | prerelease | unreleased
:docker-image: docker.elastic.co/kibana/kibana:{version}
:es-ref: https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/
:kibana-ref: https://www.elastic.co/guide/en/kibana/{branch}
:xpack-ref: https://www.elastic.co/guide/en/x-pack/current/
:repo: https://github.com/elastic/kibana/
:issue: {repo}issues/
:pull: {repo}pull/
:commit: {repo}commit/
:security: https://www.elastic.co/community/security/
include::{docs-root}/shared/attributes.asciidoc[]
include::introduction.asciidoc[]
include::setup/install.asciidoc[]

View file

@ -11,11 +11,7 @@ include::{docs-root}/shared/versions/stack/{source_branch}.asciidoc[]
:docker-repo: docker.elastic.co/kibana/kibana
:docker-image: docker.elastic.co/kibana/kibana:{version}
:repo: https://github.com/elastic/kibana/
:issue: {repo}issues/
:pull: {repo}pull/
:commit: {repo}commit/
:blob: {repo}blob/{branch}/
:blob: {kib-repo}blob/{branch}/
:security-ref: https://www.elastic.co/community/security/
:kibana-ref-all: https://www.elastic.co/guide/en/kibana

View file

@ -27,14 +27,14 @@ There are no user-facing breaking changes in 7.6.
[float]
==== {kib} no longer crashes when a plugin version does not match the server
{pull}54404[#54404]
{kib-pull}54404[#54404]
{kib} no longer crashes when a plugin is used against an incompatible {kib} version.
A warning is now displayed in the console instead of throwing and crashing.
[float]
==== Generate legacy vars when rendering all applications
{pull}54768[#54768]
{kib-pull}54768[#54768]
Rendering any type of application, even ones for the new platform,
should still generate legacy vars injected into the page metadata.
@ -42,7 +42,7 @@ This ensures these vars are injected for HTTP route rendering as well.
[float]
==== `uiSettings` image upload field config
{pull}54522[#54522]
{kib-pull}54522[#54522]
In `uiSettings`, the image upload field required specifying `maxSize`
via the `options` field. This was in conflict with the stated use and
@ -51,7 +51,7 @@ type of `options`, which is a `string[]` used to populate select fields.
[float]
==== Replaced `map.manifestServiceUrl` setting in kibana.yml with `map.emsTileApiUrl` and `map.emsFileApiUrl`
{pull}54399[#54399]
{kib-pull}54399[#54399]
The undocumented `map.manifestServiceUrl` setting in kibana.yml has been replaced
by `map.emsTileApiUrl` and `map.emsFileApiUrl`. These settings configure the
@ -60,7 +60,7 @@ Elastic Maps and the region map and coordinate map.visualizations.
[float]
==== Don't expose {es} client as Observable
{pull}53824[#53824]
{kib-pull}53824[#53824]
{es} clients aren't exposed via the Observable interface anymore.
{es} client provides a static API that handles all {es} config updates under the hood,
@ -76,7 +76,7 @@ const data = await client.callAsInternalUser('endpoint');
[float]
==== Reduce license plugin API
{pull}53489[#53489]
{kib-pull}53489[#53489]
License method `isOneOf` was superseded by `hasAtLeast`, which checks
the current license is not less than passes minimal required license.
@ -95,7 +95,7 @@ license.hasAtLeast('platinum')
[float]
==== State containers
{pull}52384[#52384]
{kib-pull}52384[#52384]
State containers have now been rewritten and to create state container you
use `createStateContainer` instead of previous `createStore`.
@ -126,7 +126,7 @@ console.log(container.get()); // 10
[float]
==== Add pre-response HTTP interceptor
{pull}52366[#52366]
{kib-pull}52366[#52366]
HttpService provides `onPreResponse` interceptor. Interceptor supports extending a response with custom headers.
@ -156,7 +156,7 @@ HttpService provides `onPreResponse` interceptor. Interceptor supports extending
[float]
==== Add server rendering service to enable standalone route rendering
{pull}52161[#52161]
{kib-pull}52161[#52161]
Render a bootstrapped HTML page from a route handler using the `RenderingService` from your server plugin:
@ -188,7 +188,7 @@ router.get(
[float]
==== Disabled actions
{pull}51975[#51975]
{kib-pull}51975[#51975]
Embeddable input now has `disabledActions` property. Actions with ID listed
in `disabledActions` will not be rendered by embeddable panel in drop down context menu and badge list.
@ -215,7 +215,7 @@ const embeddable = await embeddableFactory.createFromState(
[float]
==== Allow chromeless applications to render via non-/app routes
{pull}51527[#51527]
{kib-pull}51527[#51527]
Allow applications to routable from paths that do not start with `/app`.
This is first enabled via the `appRoute` flag during UI application registration.
@ -252,7 +252,7 @@ export class MyPlugin implements Plugin {
[float]
==== Add compatibility wrapper for Boom errors thrown from route handler
{pull}51157[#51157]
{kib-pull}51157[#51157]
Added a new `handleLegacyErrors` method to core `HttpService` router. The method wraps a `RequestHandler` to intercept any thrown `Boom` errors and converts them into proper NP error response.
@ -298,7 +298,7 @@ class Plugin {
[float]
==== Move SavedQuery to New Platform
{pull}51024[#51024]
{kib-pull}51024[#51024]
**Saved Query Service**
@ -342,7 +342,7 @@ image::images/breaking_changes_save_query.png[Save Query Form]
[float]
==== Kibana app migration: Remove old APIs
{pull}50881[#50881]
{kib-pull}50881[#50881]
The following undocumented APIs for scroll search and index document count have been removed:
@ -355,7 +355,7 @@ The following undocumented APIs for scroll search and index document count have
[float]
==== ChromeHelpExtension
{pull}50736[#50736]
{kib-pull}50736[#50736]
The `chrome.helpExtension` has been updated to where it no longer just accepts a function to spit out any content. Now, the extension looks like:
@ -377,7 +377,7 @@ export interface ChromeHelpExtension {
[float]
==== Allows plugins to define validation schema for "enabled" flag
{pull}50286[#50286]
{kib-pull}50286[#50286]
If you want your plugin to be disabled by default you can specify it via config:
@ -393,7 +393,7 @@ export const config = {
[float]
==== Add getStartServices API
{pull}50231[#50231]
{kib-pull}50231[#50231]
Context is being deprecated on the front-end and replaced by the `core.getStartServices()` API.
@ -431,7 +431,7 @@ class Plugin {
[float]
==== Relocated `@kbn/es-query` package to `data` plugin
{pull}50182[#50182]
{kib-pull}50182[#50182]
The `@kbn/es-query` package has been moved to `src/plugins/data` and is available under the `esQuery` namespace on both the client and the server.
@ -466,7 +466,7 @@ esQuery.buildEsQuery(...);
[float]
==== Migrate share registry
{pull}50137[#50137]
{kib-pull}50137[#50137]
The `ui/share` registry is removed in favor of the `share` plugin which exposes a `register` method in the setup contract. The interface of share menu providers does not change except for the removal of angular dependency injection. The function to render the menu also moves into a function exposed by the `share` plugin in the start phase instead of a function which has to be called with the menu item providers. The following items have also been renamed:
@ -478,13 +478,13 @@ The `ui/share` registry is removed in favor of the `share` plugin which exposes
[float]
==== Ensure chromeless applications hide left navbar link
{pull}50060[#50060]
{kib-pull}50060[#50060]
Chromeless applications no longer display a navigation link in the left application menu.
[float]
==== Allow registered applications to hide Kibana chrome
{pull}49795[#49795]
{kib-pull}49795[#49795]
When registering an application, you can now use the `chromeless` option to hide the Kibana chrome UI when the application is mounted.
@ -508,7 +508,7 @@ application.register({
[float]
==== Remove react references from core `Notifications` APIs
{pull}49573[#49573]
{kib-pull}49573[#49573]
The core `NotificationService` and `ToastsApi` methods are now framework agnostic
and no longer accept react components as input. Please use `kibana_react`'s`toMountPoint`
@ -516,7 +516,7 @@ utility to convert a react node to a mountPoint.
[float]
==== Shim dev tools
{pull}49349[#49349]
{kib-pull}49349[#49349]
The `ui/registry/dev_tools` is removed in favor of the `DevTools` plugin,
which exposes a `register` method in the setup contract.
@ -525,7 +525,7 @@ Routing will be handled by the id of the dev tool - your dev tool will be mounte
[float]
==== Kibana app migration: Shim dashboard
{pull}48913[#48913]
{kib-pull}48913[#48913]
The route flag `requireDefaultIndex` making sure there are index patterns
and the `defaultIndex` advanced setting is set was removed.
@ -535,7 +535,7 @@ helper function `ensureDefaultIndexPattern` from `ui/legacy_compat` within the `
[float]
==== Remove react references from core `OverlayService` apis
{pull}48431[#48431]
{kib-pull}48431[#48431]
The core `OverlayService` methods are now framework agnostic and no longer accept react components as input.
Please use `kibana_react`'s`toMountPoint` utility to convert a react component to a mountPoint.
@ -558,14 +558,14 @@ core.overlays.openModal(toMountPoint(<MyComponent/>))
[float]
==== Supply deprecated req and res properties on IHttpFetchError for legacy compatibility
{pull}48430[#48430]
{kib-pull}48430[#48430]
Expose deprecated `req: Request` and `res: Response` properties on `IHttpFetchError`s
to help plugins migrated faster by removing an additional migration burden.
[float]
==== Timelion server API
{pull}47813[#47813]
{kib-pull}47813[#47813]
The server side AOU of Timelion `/api/timelion/run` used to
accept datemath strings (like `now`) for the `time.from` and `time.to` properties.
@ -573,7 +573,7 @@ This PR removes support for datemath, from now on only ISO8601 encoded strings a
[float]
==== Pass along request object to all HTTP interceptors
{pull}47258[#47258]
{kib-pull}47258[#47258]
Make the `Request` instance available to all HTTP interceptors, which is now in a read-only state.
You may now also under-specify the object returned from HTTP response interceptors
@ -581,7 +581,7 @@ to only overwrite specific properties.
[float]
==== Expose whitelisted config values to client-side plugin
{pull}50641[#50641]
{kib-pull}50641[#50641]
New Platform plugins with both a server and client parts can now expose configuration properties to the client-side plugin.
@ -643,7 +643,7 @@ export class Plugin implements Plugin<PluginSetup, PluginStart> {
[float]
==== Allow registering per-app navigation items
{pull}53136[#53136]
{kib-pull}53136[#53136]
Allow registering per-app TopNavMenuItems&mdash;have a plugin register menu items into another application.
@ -703,7 +703,7 @@ npSetup.plugins.navigation.registerMenuItem(customDiscoverExtension);
[float]
==== Management API for Kibana Platform
{pull}52579[#52579]
{kib-pull}52579[#52579]
Management API for Kibana Platform implemented.
Demonstration code available at `test/plugin_functional/plugins/management_test_plugin/public/plugin.tsx`
@ -711,7 +711,7 @@ Demonstration code available at `test/plugin_functional/plugins/management_test_
[float]
==== New platform applications can now prompt user with a message
{pull}54221[#54221]
{kib-pull}54221[#54221]
New platform applications can now prompt a message when users are trying to
leave the app, allowing to notify them if some changes are unsaved.
@ -760,7 +760,7 @@ leave the app, allowing to notify them if some changes are unsaved.
[float]
==== [NP] Add lifecycle timeout
{pull}54129[#54129]
{kib-pull}54129[#54129]
{kib} platform deprecates async lifecycles by `v8` release.
{kib} supports async lifecycles for BWC, but limits their time duration to 30 sec.
@ -768,7 +768,7 @@ leave the app, allowing to notify them if some changes are unsaved.
[float]
==== Migrate config deprecations and `ShieldUser` functionality to the New Platform
{pull}53768[#53768]
{kib-pull}53768[#53768]
In the Security Plugin, the
Legacy `ShieldUser` angular service has been removed and replaced with
@ -822,7 +822,7 @@ public setup(core: CoreSetup, { security }: PluginSetupDependencies) {
[float]
==== NP Migration: Move doc views registry and existing doc views into discover plugin
{pull}53465[#53465]
{kib-pull}53465[#53465]
The `ui/registry/doc_views` registry is removed in favor of the same
functionality exposed through the setup contract of the `discover` plugin in `core_plugins/kibana`.
@ -866,7 +866,7 @@ setup.addDocView({
[float]
==== bfetch
{pull}52888[#52888]
{kib-pull}52888[#52888]
`ajax_stream` has been ported to the New Platform. Use `fetchStreaming()` method of `bfetch` plugin instead.
@ -880,7 +880,7 @@ const { stream, promise } = npStart.plugins.bfetch.fetchStreaming({ url: 'http:/
[float]
==== Move CSP options to New Platform
{pull}52698[#52698]
{kib-pull}52698[#52698]
The default options used for managing Kibana's Content Security Policy have been moved into core for the new platform. Relevant items exposed from `src/core/server` include:
@ -893,7 +893,7 @@ The default options used for managing Kibana's Content Security Policy have been
[float]
==== Implements config deprecation in New Platform
{pull}52251[#52251]
{kib-pull}52251[#52251]
New platform plugin's configuration now supports deprecation. Use the `deprecations` key of a plugin's config descriptor to register them.
@ -939,13 +939,13 @@ New platform plugin's configuration now supports deprecation. Use the `deprecati
[float]
==== [Telemetry] Migrate ui_metric plugin to NP under usageCollection
{pull}51972[#51972]
{kib-pull}51972[#51972]
Migrates `ui_metrics` to NP under `usageCollection`.
[float]
==== NP licensing plugin improvements
{pull}51818[#51818]
{kib-pull}51818[#51818]
Licensing plugin retrieves license data from {es} and
@ -976,7 +976,7 @@ license from **Kibana**, it will emit `an empty license` object.
[float]
==== [Cloud] move cloud plugin to New Platform
{pull}51789[#51789]
{kib-pull}51789[#51789]
Fully migrates `cloud` plugin over to NP. To use the NP contract exposed by
the cloud plugin (ex `cloudId` or `isCloudEnabled`) follow this quick guide below.
@ -1041,7 +1041,7 @@ const isCloudEnabled = get<boolean>(cloud, 'isCloudEnabled', false);
[float]
==== [Telemetry] Migrate Usage Collector Set to the new Kibana Platform
{pull}51618[#51618]
{kib-pull}51618[#51618]
Fully migrate (`server.usage.collectorSet`) to New Platform under (`UsageCollection`) plugin.
To use the `UsageCollector` plugin to collect server side stats with the NP follow the quick guide below (Note that all the plugins are already migrated to use this new plugin in this very same PR):
@ -1138,7 +1138,7 @@ export function registerMyPluginUsageCollector(usageCollection?: UsageCollection
[float]
==== Move SearchBar to NP
{pull}51028[#51028]
{kib-pull}51028[#51028]
The SearchBar component is now available by importing from the data plugin.
@ -1180,7 +1180,7 @@ export class MyPublicPlugin {
[float]
==== Move QueryBarInput to New Platform
{pull}51023[#51023]
{kib-pull}51023[#51023]
* `QueryBarInput` was renamed to `QueryStringInput` and moved to `src/plugins/data/public`
@ -1195,7 +1195,7 @@ export class MyPublicPlugin {
[float]
==== Move ApplyFiltersPopover to New Platform
{pull}51022[#51022]
{kib-pull}51022[#51022]
The `ApplyFiltersPopover` component is no longer exported.
@ -1216,7 +1216,7 @@ use the Actions API from within an `embeddable`:
[float]
==== Deprecated the `filter-bar` directive
{pull}51020[#51020]
{kib-pull}51020[#51020]
If you need to render a filter bar from `angular`,
use the `kbn-top-nav` directive with the following configuration:
@ -1277,7 +1277,7 @@ import { FilterBar } from '../../../plugins/data/public';
[float]
==== NP Kibana plugin home feature catalogue
{pull}50838[#50838]
{kib-pull}50838[#50838]
The `ui/registries/feature_catalogue` module has been deprecated for removal in 8.0.
@ -1316,7 +1316,7 @@ Note that the old module supported providing a Angular DI function to receive An
[float]
==== [NP Kibana Migrations ] Kibana plugin home
{pull}50444[#50444]
{kib-pull}50444[#50444]
The API to register new tutorials was moved to the new platform. You are now able to add new tutorials by creating a plugin in the new platform, adding a dependency to `home` in its `kibana.json` and using the `tutorials.registerTutorial` method in the setup lifecycle:
@ -1344,7 +1344,7 @@ server.newPlatform.setup.plugins.home.tutorials.registerTutorial(() => ({ /* tut
[float]
==== Expressions fully migrated to the New Platform
{pull}50294[#50294]
{kib-pull}50294[#50294]
The Expressions service has been moved to the New Platform. Moving forward, any expressions-related code should be consumed via the new plugin's contracts (`src/plugins/expressions`).
@ -1390,7 +1390,7 @@ npStart.plugins.expressions.execute(myExpression);
[float]
==== Move generateFilters to NP
{pull}50118[#50118]
{kib-pull}50118[#50118]
Filter generator is now available as a utility function in the `data` plugin.
@ -1406,7 +1406,7 @@ const filters = generateFilters(filterManager, field, values, negate, indexStrin
[float]
==== Move Query type to NP
{pull}49636[#49636]
{kib-pull}49636[#49636]
Moved the data `Query` type, used to represent a query string in a specific querying language to `src/plugins/data`.
@ -1424,7 +1424,7 @@ import { Query } from `src/plugins/data/public`;
[float]
==== Move Timefilter service to NP
{pull}49491[#49491]
{kib-pull}49491[#49491]
Moved the `timefilter` service to New Platform.
@ -1470,7 +1470,7 @@ class MyPlugin {
[float]
==== Move Storage to New Platform
{pull}49448[#49448]
{kib-pull}49448[#49448]
Move `Storage` to `kibana_utils`.
@ -1482,7 +1482,7 @@ Move `Storage` to `kibana_utils`.
[float]
==== Licensing plugin
{pull}49345[#49345]
{kib-pull}49345[#49345]
Add x-pack plugin for new platform public licensing information. This will eventually replace the licensing information consumed via `xpack_main`. Upon setup, this plugin exposes an observable API for inspecting and making checks against the license information.
@ -1510,7 +1510,7 @@ license$.subscribe(license => {
[float]
==== Migrate ui/registry/feature_catalogue to New Platform plugin
{pull}48818[#48818]
{kib-pull}48818[#48818]
The `ui/registries/feature_catalogue` module has been deprecated for removal in 8.0.
@ -1548,7 +1548,7 @@ Note that the old module supported providing a Angular DI function to receive An
[float]
==== Migrate necessary ui/autoload functionality to NP
{pull}48689[#48689]
{kib-pull}48689[#48689]
The `ui/autoload/styles` and `ui/autoload/settings` modules have been removed and are no longer necessary to import in your plugin code. Remove these imports starting in 7.6.
@ -1562,7 +1562,7 @@ import 'font-awesome/less/font-awesome';
[float]
==== Provide uiSettings service in NP
{pull}48413[#48413]
{kib-pull}48413[#48413]
New platform plugins can register custom uiSettings via the `uiSettings.register` method.
@ -1622,7 +1622,7 @@ public start({ uiSettings }) {
[float]
==== Move FilterManager to New Platform
{pull}48391[#48391]
{kib-pull}48391[#48391]
Moved Filter Manager to New Platform.
@ -1662,7 +1662,7 @@ class MyPlugin {
[float]
==== Migrate ui/doc_title to New platform
{pull}48121[#48121]
{kib-pull}48121[#48121]
Migrate `chrome.docTitle` to new platform. Plugins can now change the page title using this API.
@ -1674,7 +1674,7 @@ coreStart.docTitle.change('My Title');
[float]
==== Use NP registry instead of ui/registry/field_formats
{pull}48108[#48108]
{kib-pull}48108[#48108]
The `FieldFormats` service has been moved to the `data` plugin in the New Platform.
If your plugin has any imports from `ui/registry/field_formats`, you'll need to update your imports as follows:
@ -1721,7 +1721,7 @@ npStart.plugins.data.fieldFormats.getType(myFieldFormatId);
[float]
==== ui/management to New Platform
{pull}45747[#45747]
{kib-pull}45747[#45747]
The following interfaces were previously available under `ui/management`
and are now available via `import { setup as managementSetup }``
@ -1735,7 +1735,7 @@ from `'${correct path to top dir}src/legacy/core_plugins/management/public/legac
[float]
==== `ui/public` cleanup
{pull}43511[#43511]
{kib-pull}43511[#43511]
**Removed / moved modules**
@ -1751,10 +1751,10 @@ or copy the relevant code into your plugin.
[float]
**`ui/state_management`**
{pull}51835[#51835]
{pull}52172[#52172]
{pull}52280[#52280]
{pull}53582[#53582]
{kib-pull}51835[#51835]
{kib-pull}52172[#52172]
{kib-pull}52280[#52280]
{kib-pull}53582[#53582]
The `hashUrl` and `unhashUrl` functions no longer rely on states being provided as an argument, therefore `getUnhashableStates`/`getUnhashableStatesProvider` have been removed.
@ -1808,45 +1808,45 @@ This should become a replacement for `AppState` and `GlobalState` in NP.
**`ui/public/utils` cleanup**
- `base_object` and `find_by_param` utilities have been removed {pull}52500[#52500]
- `base_object` and `find_by_param` utilities have been removed {kib-pull}52500[#52500]
- `decode_geo_hash` and `zoom_to_precision` utilities have been moved to `ui/vis/map`{pull}52615[#52615]
- `decode_geo_hash` and `zoom_to_precision` utilities have been moved to `ui/vis/map`{kib-pull}52615[#52615]
- `range` utility has beed moved to `ui/vis/editors/default` {pull}52615[#52615]
- `range` utility has beed moved to `ui/vis/editors/default` {kib-pull}52615[#52615]
- `cidr_mask`, `date_range`, `geo_utils`, `ip_range`, `ordinal_suffix` utilities have been moved to `ui/agg_types` {pull}52744[#52744]
- `cidr_mask`, `date_range`, `geo_utils`, `ip_range`, `ordinal_suffix` utilities have been moved to `ui/agg_types` {kib-pull}52744[#52744]
- `case_conversion` {pull}53819[#53819]
- `case_conversion` {kib-pull}53819[#53819]
- `keysToSnakeCaseShallow` moved to `src/legacy/server/status/lib`
- `keysToCamelCaseShallow` moved to `src/legacy/core_plugins/kibana/public/management`
- `collection` {pull}53819[#53819]
- `collection` {kib-pull}53819[#53819]
- `organizeBy moved to `src/legacy/ui/public/indexed_array`
- `pushAll` was removed
- `diff_object moved to `ui/state_management` {pull}53819[#53819]
- `diff_object moved to `ui/state_management` {kib-pull}53819[#53819]
- `function` was removed {pull}53819[#53819]
- `function` was removed {kib-pull}53819[#53819]
- `key_map` moved to `ui/directives` {pull}53819[#53819]
- `key_map` moved to `ui/directives` {kib-pull}53819[#53819]
- `math` moved to `ui/vis` {pull}53819[#53819]
- `math` moved to `ui/vis` {kib-pull}53819[#53819]
- `numeric` moved to `src/legacy/core_plugins/kibana/public/management` {pull}53819[#53819]
- `numeric` moved to `src/legacy/core_plugins/kibana/public/management` {kib-pull}53819[#53819]
- `parse_interval` moved to`src/legacy/core_plugins/data/common` {pull}53819[#53819]
- `parse_interval` moved to`src/legacy/core_plugins/data/common` {kib-pull}53819[#53819]
- `sort_prefix_first` moved to `x-pack/legacy/plugins/kuery_autocomplete` {pull}53819[#53819]
- `sort_prefix_first` moved to `x-pack/legacy/plugins/kuery_autocomplete` {kib-pull}53819[#53819]
- `supports` moved to `src/legacy/core_plugins/tile_map/public` {pull}53819[#53819]
- `supports` moved to `src/legacy/core_plugins/tile_map/public` {kib-pull}53819[#53819]
[float]
==== Index Patterns moved to New Platform
{pull}43438[#43438]
{kib-pull}43438[#43438]
The `indexPatterns` service is now available from the data plugin.

View file

@ -25,7 +25,7 @@ There are no user-facing breaking changes in 7.7.
This Info toast will be used for the async search notifications.
*via {pull}60574[#60574]*
*via {kib-pull}60574[#60574]*
[discrete]
==== Goodbye, legacy data plugin
@ -66,14 +66,14 @@ please refer to the table of
https://github.com/elastic/kibana/blob/master/src/core/MIGRATION.md#plugins-for-shared-application-services[plugins for shared application services]
in `src/core/MIGRATION.md`.
*via {pull}60449[#60449]*
*via {kib-pull}60449[#60449]*
[discrete]
==== Delete FilterStateManager and QueryFilter
Delete unused legacy exports `FilterStateManager`, `QueryFilter`, and `SavedQuery`.
*via {pull}59872[#59872]*
*via {kib-pull}59872[#59872]*
[discrete]
==== Add UiSettings validation & Kibana default route redirection
@ -91,7 +91,7 @@ uiSettings.register({
})
```
*via {pull}59694[#59694]*
*via {kib-pull}59694[#59694]*
[discrete]
==== Allow disabling xsrf protection per an endpoint
@ -101,7 +101,7 @@ Route configuration allows to disable xsrf protection for destructive HTTP metho
```js
routet.get({ path: ..., validate: ..., options: { xsrfRequired: false } })
```
*via {pull}58717[#58717]*
*via {kib-pull}58717[#58717]*
[discrete]
==== Add core metrics service
@ -115,7 +115,7 @@ core.metrics.getOpsMetrics$().subscribe(metrics => {
})
```
*via {pull}58623[#58623]*
*via {kib-pull}58623[#58623]*
[discrete]
==== Add an optional authentication mode for HTTP resources
@ -125,7 +125,7 @@ A route config accepts `authRequired: 'optional'`. A user can access a resource
router.get( { path: '/', options: { authRequired: 'optional' } }, handler);
```
*via {pull}58589[#58589]*
*via {kib-pull}58589[#58589]*
[discrete]
==== Migrate doc view part of discover
@ -152,7 +152,7 @@ export class MyPlugin implements Plugin<void, void> {
```
*via {pull}58094[#58094]*
*via {kib-pull}58094[#58094]*
[discrete]
==== [Telemetry] Server backpressure mechanism
@ -188,7 +188,7 @@ Send `OPTIONS` request before attempting to send telemetry from server. `OPTIONS
* If `OPTIONS` request fails; dont send usage and follow the retry logic above.
*via {pull}57556[#57556]*
*via {kib-pull}57556[#57556]*
[discrete]
==== Expressions server-side
@ -200,7 +200,7 @@ plugins.expressions.registerFunction(/* ... */);
const result = await plugins.expressions.run('var_set name="foo" value="bar" | var name="foo"', null);
```
*via {pull}57537[#57537]*
*via {kib-pull}57537[#57537]*
[discrete]
==== Local actions
@ -220,7 +220,7 @@ const trigger = {
};
```
*via {pull}57451[#57451]*
*via {kib-pull}57451[#57451]*
[discrete]
==== Use log4j pattern syntax
@ -228,7 +228,7 @@ const trigger = {
Logging output of the New platform plugins can use adjusted
via https://github.com/elastic/kibana/blob/master/src/core/server/logging/README.md[new config].
*via {pull}57433[#57433]*
*via {kib-pull}57433[#57433]*
[discrete]
==== Allow savedObjects types registration from NP
@ -274,7 +274,7 @@ export class Plugin() {
Please check the migration guide for more complete examples and migration procedure.
*via {pull}57430[#57430]*
*via {kib-pull}57430[#57430]*
[discrete]
==== Expose Vis on the contract as it requires visTypes
@ -292,7 +292,7 @@ new visualizationsStart.Vis(....);
import { Vis } from '../../../../../core_plugins/visualizations/public';
```
*via {pull}56968[#56968]*
*via {kib-pull}56968[#56968]*
[discrete]
==== Add ScopedHistory to AppMountParams
@ -332,7 +332,7 @@ core.application.register({
});
```
*via {pull}56705[#56705]*
*via {kib-pull}56705[#56705]*
[discrete]
==== Move new_vis_modal to visualizations plugin
@ -348,7 +348,7 @@ NewVisModal component and showNewVisModal function were statically exported and
```tsx
npStart.plugins.visualizations.showNewVisModal();
```
*via {pull}56654[#56654]*
*via {kib-pull}56654[#56654]*
[discrete]
==== UiComponent
@ -378,7 +378,7 @@ const uiToReactComponent: (comp: UiComponent) => React.ComponentType;
const reactToUiComponent: (comp: React.ComponentType) => UiComponent;
```
*via {pull}56555[#56555]*
*via {kib-pull}56555[#56555]*
[discrete]
==== Start consuming np logging config
@ -386,7 +386,7 @@ const reactToUiComponent: (comp: React.ComponentType) => UiComponent;
Provides experimental support of new logging format for **new platform plugins**.
More about https://github.com/elastic/kibana/blob/master/src/core/server/logging/README.md[the logging format].
*via {pull}56480[#56480]*
*via {kib-pull}56480[#56480]*
[discrete]
==== [State Management] State syncing utils docs
@ -394,7 +394,7 @@ More about https://github.com/elastic/kibana/blob/master/src/core/server/logging
Refer to https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_sync[these docs]
on state syncing utils.
*via {pull}56479[#56479]*
*via {kib-pull}56479[#56479]*
[discrete]
@ -414,7 +414,7 @@ showSaveModal(saveModal, npStart.core.i18n.Context);
```
*via {pull}56383[#56383]*
*via {kib-pull}56383[#56383]*
[discrete]
==== [State Management] State syncing helpers for query service
@ -440,7 +440,7 @@ interface QueryStateChange {
state$: Observable<{ changes: QueryStateChange; state: QueryState }>;
```
*via {pull}56128[#56128]*
*via {kib-pull}56128[#56128]*
[discrete]
==== Migrate saved_object_save_as_checkbox directive to Timelion
@ -460,7 +460,7 @@ import { SavedObjectSaveModal } from 'ui/saved_objects/components/saved_object_s
/>
```
*via {pull}56114[#56114]*
*via {kib-pull}56114[#56114]*
[discrete]
==== `ui/public` cleanup
@ -525,7 +525,7 @@ In the meantime, if you currently rely on `TimeBuckets`, please copy the relevan
The `ui/filter_manager` module has been removed and now services and UI components
are available on the `data` plugin's query infrastructure.
*via {pull}55926[#55926]*
*via {kib-pull}55926[#55926]*
[discrete]
==== Add savedObjects mappings API to core
@ -558,7 +558,7 @@ export const mappings: SavedObjectsTypeMappingDefinitions = {
}
```
*via {pull}55825[#55825]*
*via {kib-pull}55825[#55825]*
[discrete]
==== Remove the VisEditorTypesRegistryProvider
@ -579,7 +579,7 @@ a class with your own controller as a value in a vis type definition:
}
```
*via {pull}55370[#55370]*
*via {kib-pull}55370[#55370]*
[discrete]
==== Explicitly test custom appRoutes
@ -587,7 +587,7 @@ a class with your own controller as a value in a vis type definition:
Tests for custom `appRoute`s are now more clear and explicitly separate
from those that test other rendering service interactions.
*via {pull}55405[#55405]*
*via {kib-pull}55405[#55405]*
[discrete]
==== [NP] Platform exposes API to get authenticated user data
@ -601,7 +601,7 @@ HttpService exposes:
* `auth.isAuthenticated()` - returns true, if `auth` interceptor successfully authenticated a user.
*via {pull}55327[#55327]*
*via {kib-pull}55327[#55327]*
[discrete]
==== Implements `getStartServices` on server-side
@ -624,7 +624,7 @@ class MyPlugin implements Plugin {
}
```
*via {pull}55156[#55156]*
*via {kib-pull}55156[#55156]*
[discrete]
==== Expressions refactor
@ -632,7 +632,7 @@ class MyPlugin implements Plugin {
* `context.types` > `inputTypes`
* Objects should be registered instead of function wrappers around those objects.
*via {pull}54342[#54342]*
*via {kib-pull}54342[#54342]*
[discrete]
==== Refactor saved object management registry usage
@ -667,7 +667,7 @@ const savedVisualizations = createSavedVisLoader(servicesForVisualizations);
const savedDashboards = createSavedDashboardLoader(services);
```
*via {pull}54155[#54155]*
*via {kib-pull}54155[#54155]*
[discrete]
==== Enforce camelCase format for a plugin id
@ -685,7 +685,7 @@ It might not match `pluginPath`, which is recommended to be in snake_case format
"id": "fooBar"
```
*via {pull}53759[#53759]*
*via {kib-pull}53759[#53759]*
[discrete]
==== bfetch (2)
@ -736,7 +736,7 @@ double({ num: 2 }).then(console.log, console.error); // { num: 4 }
double({ num: 3 }).then(console.log, console.error); // { num: 6 }
```
*via {pull}53711[#53711]*
*via {kib-pull}53711[#53711]*
[discrete]
==== Grouped Kibana nav
@ -746,7 +746,7 @@ Plugins should now define a category if they have a navigation item:
* If you want to fit into our default categories, you can use our `DEFAULT_APP_CATEGORIES` defined in `src/core/utils/default_app_categories.ts`.
* If you want to create their own category, you can also provide any object matching the `AppCategory` interface defined in `src/core/types/app_category.ts`.
*via {pull}53545[#53545]*
*via {kib-pull}53545[#53545]*
[discrete]
==== Expose Elasticsearch from start and deprecate from setup
@ -756,7 +756,7 @@ contract, and move them to the start contract instead. Deprecate
the `CoreSetup.elasticsearch` API and expose `CoreStart.elasticsearch` instead.
*via {pull}59886[#59886]*
*via {kib-pull}59886[#59886]*
[discrete]
==== Embeddable triggers
@ -774,7 +774,7 @@ class MyEmbeddable extends Embeddable {
The returned list of triggers will be used in the drilldowns feature on Dashboard,
where users will be able to add drilldowns to embeddable triggers.
*via {pull}58440[#58440]*
*via {kib-pull}58440[#58440]*
[discrete]
==== Force savedObject API consumers to define SO type explicitly
@ -783,14 +783,14 @@ The new interface enforces API consumers to specify SO type explicitly.
Plugins can use `SavedObjectAttributes` to ensure their type are serializable,
but it shouldn't be used as their domain-specific type.
*via {pull}58022[#58022]*
*via {kib-pull}58022[#58022]*
[discrete]
==== Trigger context
Improved types for trigger contexts, which are consumed by actions.
*via {pull}57870[#57870]*
*via {kib-pull}57870[#57870]*
[discrete]
==== Expressions debug mode
@ -799,7 +799,7 @@ Add ability to execute expression in "debug" mode, which would collect execution
information about each function. This is used in the Expression Explorer
(developed by Canvas) and in Canvas when the expression editor is open.
*via {pull}57841[#57841]*
*via {kib-pull}57841[#57841]*
[discrete]
==== Move ui/agg_types in to shim data plugin
@ -810,7 +810,7 @@ information about each function. This is used in the Expression Explorer
** Right now these are just re-exporting the class as a type;
eventually we should put more detailed typings in place.
*via {pull}56353[#56353]*
*via {kib-pull}56353[#56353]*
[discrete]
==== Stateful search bar default behaviors
@ -819,7 +819,7 @@ The goal of the stateful version of SearchBar / TopNavMenu is to be an easy way
to consume the services offered by `plugins.data.query` where developers
should be able to provide minimal configuration and get a fully working SearchBar.
*via {pull}56160[#56160]*
*via {kib-pull}56160[#56160]*
[discrete]
==== Guide for creating alert / action types in the UI
@ -827,7 +827,7 @@ should be able to provide minimal configuration and get a fully working SearchBa
Documentation to help developers integrate their alert / action type within
our Management UIs
*via {pull}55963[#55963]*
*via {kib-pull}55963[#55963]*
[discrete]
==== Move search service code to NP
@ -835,7 +835,7 @@ our Management UIs
Move all of the search service code to Kibana new platform. Also deletes `courier` folder
and moves `getFlattenedObject` to `src/core/utils`.
*via {pull}55430[#55430]*
*via {kib-pull}55430[#55430]*
[discrete]
==== Expose NP FieldFormats service to server side
@ -844,7 +844,7 @@ The fieldFormats service is used on the server side as well.
At the moment, it resides in `src/legacy/ui/field_formats/mixin/field_formats_service.ts`
and only the FE plugin exposes it.
*via {pull}55419[#55419]*
*via {kib-pull}55419[#55419]*
[discrete]
==== Update plugin generator to generate NP plugins
@ -857,7 +857,7 @@ Add more options for Kibana new platform plugin generator.
* Generate an optional .eslintrc.js file (for 3rd party plugins mostly)
* Init git repo (for 3rd party plugins)
*via {pull}55281[#55281]*
*via {kib-pull}55281[#55281]*
[discrete]
==== Run SO migration after plugins setup phase
@ -873,7 +873,7 @@ SO repository provider when registering the client factory.
* Adapts the existing plugin calls to the removed APIs from `setup` to be now
using `getStartServices` to access them on the core `start` contract.
*via {pull}55012[#55012]*
*via {kib-pull}55012[#55012]*
[discrete]
==== Build immutable bundles for new platform plugins
@ -884,7 +884,7 @@ this new system either pass `--plugin-path` to `node scripts/build_new_platform_
or use the `@kbn/optimizer` package in the Kibana repo to build your plugin as
described in the readme for that package.
*via {pull}53976[#53976]*
*via {kib-pull}53976[#53976]*
[discrete]
@ -893,7 +893,7 @@ described in the readme for that package.
Adds an async {es} search strategy, which utilizes the async search strategy to
call the `_async_search` APIs in Elasticsearch, returning an observable over the responses.
*via {pull}53538[#53538]*
*via {kib-pull}53538[#53538]*
[discrete]
==== [Vis: Default editor] EUIficate and Reactify the sidebar
@ -920,7 +920,7 @@ These tabs should be React components:
}
```
*via {pull}49864[#49864]*
*via {kib-pull}49864[#49864]*
[discrete]
==== [test] Consolidate top-level yarn scripts
@ -936,4 +936,4 @@ frameworks out and avoid workflow interruptions (`grunt/gulp -> node scripts/*`)
type (`yarn test:server -> yarn test:mocha`)
*via {pull}44679[#44679]*
*via {kib-pull}44679[#44679]*

View file

@ -70,4 +70,4 @@ Use it to create, edit and embed visualizations, and also to search inside an em
* https://github.com/datasweet-fr/kibana-datasweet-formula[Datasweet Formula] (datasweet) - enables calculated metric on any standard Kibana visualization.
* https://github.com/pjhampton/kibana-prometheus-exporter[Prometheus Exporter] - exports the Kibana metrics in the prometheus format
NOTE: If you want your plugin to be added to this page, open a {repo}tree/{branch}/docs/plugins/known-plugins.asciidoc[pull request].
NOTE: If you want your plugin to be added to this page, open a {kib-repo}tree/{branch}/docs/plugins/known-plugins.asciidoc[pull request].

View file

@ -73,7 +73,7 @@ export class AsciidocFormat extends Format {
for (const pr of prsInArea) {
const fixes = pr.fixes.length ? `[Fixes ${pr.fixes.join(', ')}] ` : '';
const strippedTitle = pr.title.replace(/^\s*\[[^\]]+\]\s*/, '');
yield `* ${fixes}${strippedTitle} {pull}${pr.number}[#${pr.number}]\n`;
yield `* ${fixes}${strippedTitle} {kibana-pull}${pr.number}[#${pr.number}]\n`;
if (pr.note) {
yield ` - ${pr.note}\n`;
}

View file

@ -111,7 +111,7 @@ ASCIIDOC
}
my $number = $issue->{number};
# print encode_utf8("* $title {pull}${number}[#${number}]");
# print encode_utf8("* $title {kibana-pull}${number}[#${number}]");
print encode_utf8("* $title");
print "\n";
print encode_utf8("// https://github.com/${User_Repo}pull/${number}[#${number}]");
@ -120,7 +120,7 @@ ASCIIDOC
print keys %uniq > 1
? " (issues: "
: " (issue: ";
# print join ", ", map {"{issue}${_}[#${_}]"}
# print join ", ", map {"{kib-issue}${_}[#${_}]"}
# print join ", ", map {"#${_}"}
print join ", ", map {"https://github.com/${User_Repo}issues/${_}[#${_}]"}
sort keys %uniq;