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.

Sign up for GitHub

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

Fix Core docs links #66977

Merged
merged 1 commit into from
May 20, 2020
Merged

Fix Core docs links #66977

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/core/CONVENTIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ my_plugin/
   ├── index.ts
   └── plugin.ts
```
- [Manifest file](/docs/development/core/server/kibana-plugin-server.pluginmanifest.md) should be defined on top level.
- [Manifest file](/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.md) should be defined on top level.
- Both `server` and `public` should have an `index.ts` and a `plugin.ts` file:
- `index.ts` should only contain:
- The `plugin` export
Expand Down
16 changes: 11 additions & 5 deletions src/core/MIGRATION_EXAMPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ APIs to their New Platform equivalents.
- [Migration Examples](#migration-examples)
- [Configuration](#configuration)
- [Declaring config schema](#declaring-config-schema)
- [Using New Platform config in a new plugin](#using-new-platform-config-in-a-new-plugin)
- [Using New Platform config from a Legacy plugin](#using-new-platform-config-from-a-legacy-plugin)
- [Create a New Platform plugin](#create-a-new-platform-plugin)
- [HTTP Routes](#http-routes)
Expand All @@ -15,11 +16,16 @@ APIs to their New Platform equivalents.
- [4. New Platform plugin](#4-new-platform-plugin)
- [Accessing Services](#accessing-services)
- [Migrating Hapi "pre" handlers](#migrating-hapi-pre-handlers)
- [Simple example](#simple-example)
- [Full Example](#full-example)
- [Chrome](#chrome)
- [Updating an application navlink](#updating-application-navlink)
- [Updating an application navlink](#updating-an-application-navlink)
- [Chromeless Applications](#chromeless-applications)
- [Render HTML Content](#render-html-content)
- [Saved Objects types](#saved-objects-types)
- [Concrete example](#concrete-example)
- [Changes in structure compared to legacy](#changes-in-structure-compared-to-legacy)
- [Remarks](#remarks)
- [UiSettings](#uisettings)

## Configuration
Expand Down Expand Up @@ -65,7 +71,7 @@ export type MyPluginConfig = TypeOf<typeof config.schema>;
### Using New Platform config in a new plugin

After setting the config schema for your plugin, you might want to reach the configuration in the plugin.
It is provided as part of the [PluginInitializerContext](../../docs/development/core/server/kibana-plugin-server.plugininitializercontext.md)
It is provided as part of the [PluginInitializerContext](../../docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.md)
in the *constructor* of the plugin:

```ts
Expand Down Expand Up @@ -210,9 +216,9 @@ new kibana.Plugin({
In the legacy platform, plugins have direct access to the Hapi `server` object
which gives full access to all of Hapi's API. In the New Platform, plugins have
access to the
[HttpServiceSetup](/docs/development/core/server/kibana-plugin-server.httpservicesetup.md)
[HttpServiceSetup](/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.md)
interface, which is exposed via the
[CoreSetup](/docs/development/core/server/kibana-plugin-server.coresetup.md)
[CoreSetup](/docs/development/core/server/kibana-plugin-core-server.coresetup.md)
object injected into the `setup` method of server-side plugins.

This interface has a different API with slightly different behaviors.
Expand Down Expand Up @@ -415,7 +421,7 @@ Services in the Legacy Platform were typically available via methods on either
`server.plugins.*`, `server.*`, or `req.*`. In the New Platform, all services
are available via the `context` argument to the route handler. The type of this
argument is the
[RequestHandlerContext](/docs/development/core/server/kibana-plugin-server.requesthandlercontext.md).
[RequestHandlerContext](/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md).
The APIs available here will include all Core services and any services
registered by plugins this plugin depends on.

Expand Down