Merge branch 'master' into issue-17039-support-p12-certificates

Author: jportner

docs/development/core/public/kibana-plugin-public.chromedoctitle.md

@@ -12,13 +12,6 @@ APIs for accessing and updating the document title.
 export interface ChromeDocTitle 
 ```
 
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [change(newTitle)](./kibana-plugin-public.chromedoctitle.change.md) | Changes the current document title. |
-|  [reset()](./kibana-plugin-public.chromedoctitle.reset.md) | Resets the document title to it's initial value. (meaning the one present in the title meta at application load.) |
-
 ## Example 1
 
 How to change the title of the document
@@ -37,3 +30,10 @@ chrome.docTitle.reset()
 
 ```
 
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [change(newTitle)](./kibana-plugin-public.chromedoctitle.change.md) | Changes the current document title. |
+|  [reset()](./kibana-plugin-public.chromedoctitle.reset.md) | Resets the document title to it's initial value. (meaning the one present in the title meta at application load.) |
+

docs/development/core/public/kibana-plugin-public.chromenavcontrols.md

@@ -12,13 +12,6 @@
 export interface ChromeNavControls 
 ```
 
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [registerLeft(navControl)](./kibana-plugin-public.chromenavcontrols.registerleft.md) | Register a nav control to be presented on the left side of the chrome header. |
-|  [registerRight(navControl)](./kibana-plugin-public.chromenavcontrols.registerright.md) | Register a nav control to be presented on the right side of the chrome header. |
-
 ## Example
 
 Register a left-side nav control rendered with React.
@@ -33,3 +26,10 @@ chrome.navControls.registerLeft({
 
 ```
 
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [registerLeft(navControl)](./kibana-plugin-public.chromenavcontrols.registerleft.md) | Register a nav control to be presented on the left side of the chrome header. |
+|  [registerRight(navControl)](./kibana-plugin-public.chromenavcontrols.registerright.md) | Register a nav control to be presented on the right side of the chrome header. |
+

docs/development/core/public/kibana-plugin-public.chromestart.md

@@ -12,6 +12,31 @@ ChromeStart allows plugins to customize the global chrome header UI and enrich t
 export interface ChromeStart 
 ```
 
+## Remarks
+
+While ChromeStart exposes many APIs, they should be used sparingly and the developer should understand how they affect other plugins and applications.
+
+## Example 1
+
+How to add a recently accessed item to the sidebar:
+
+```ts
+core.chrome.recentlyAccessed.add('/app/map/1234', 'Map 1234', '1234');
+
+```
+
+## Example 2
+
+How to set the help dropdown extension:
+
+```tsx
+core.chrome.setHelpExtension(elem => {
+  ReactDOM.render(<MyHelpComponent />, elem);
+  return () => ReactDOM.unmountComponentAtNode(elem);
+});
+
+```
+
 ## Properties
 
 |  Property | Type | Description |
@@ -43,28 +68,3 @@ export interface ChromeStart
 |  [setIsCollapsed(isCollapsed)](./kibana-plugin-public.chromestart.setiscollapsed.md) | Set the collapsed state of the chrome navigation. |
 |  [setIsVisible(isVisible)](./kibana-plugin-public.chromestart.setisvisible.md) | Set the temporary visibility for the chrome. This does nothing if the chrome is hidden by default and should be used to hide the chrome for things like full-screen modes with an exit button. |
 
-## Remarks
-
-While ChromeStart exposes many APIs, they should be used sparingly and the developer should understand how they affect other plugins and applications.
-
-## Example 1
-
-How to add a recently accessed item to the sidebar:
-
-```ts
-core.chrome.recentlyAccessed.add('/app/map/1234', 'Map 1234', '1234');
-
-```
-
-## Example 2
-
-How to set the help dropdown extension:
-
-```tsx
-core.chrome.setHelpExtension(elem => {
-  ReactDOM.render(<MyHelpComponent />, elem);
-  return () => ReactDOM.unmountComponentAtNode(elem);
-});
-
-```
-

docs/development/core/public/kibana-plugin-public.contextsetup.md

@@ -12,12 +12,6 @@ An object that handles registration of context providers and configuring handler
 export interface ContextSetup 
 ```
 
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [createContextContainer()](./kibana-plugin-public.contextsetup.createcontextcontainer.md) | Creates a new [IContextContainer](./kibana-plugin-public.icontextcontainer.md) for a service owner. |
-
 ## Remarks
 
 A [IContextContainer](./kibana-plugin-public.icontextcontainer.md) can be used by any Core service or plugin (known as the "service owner") which wishes to expose APIs in a handler function. The container object will manage registering context providers and configuring a handler with all of the contexts that should be exposed to the handler's plugin. This is dependent on the dependencies that the handler's plugin declares.
@@ -136,3 +130,9 @@ class VizRenderingPlugin {
 
 ```
 
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [createContextContainer()](./kibana-plugin-public.contextsetup.createcontextcontainer.md) | Creates a new [IContextContainer](./kibana-plugin-public.icontextcontainer.md) for a service owner. |
+

docs/development/core/public/kibana-plugin-public.icontextcontainer.md

@@ -12,13 +12,6 @@ An object that handles registration of context providers and configuring handler
 export interface IContextContainer<THandler extends HandlerFunction<any>> 
 ```
 
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [createHandler(pluginOpaqueId, handler)](./kibana-plugin-public.icontextcontainer.createhandler.md) | Create a new handler function pre-wired to context for the plugin. |
-|  [registerContext(pluginOpaqueId, contextName, provider)](./kibana-plugin-public.icontextcontainer.registercontext.md) | Register a new context provider. |
-
 ## Remarks
 
 A [IContextContainer](./kibana-plugin-public.icontextcontainer.md) can be used by any Core service or plugin (known as the "service owner") which wishes to expose APIs in a handler function. The container object will manage registering context providers and configuring a handler with all of the contexts that should be exposed to the handler's plugin. This is dependent on the dependencies that the handler's plugin declares.
@@ -78,3 +71,10 @@ class MyPlugin {
 
 ```
 
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [createHandler(pluginOpaqueId, handler)](./kibana-plugin-public.icontextcontainer.createhandler.md) | Create a new handler function pre-wired to context for the plugin. |
+|  [registerContext(pluginOpaqueId, contextName, provider)](./kibana-plugin-public.icontextcontainer.registercontext.md) | Register a new context provider. |
+

docs/development/core/public/kibana-plugin-public.legacycoresetup.md

@@ -16,13 +16,13 @@ Setup interface exposed to the legacy platform via the `ui/new_platform` module.
 export interface LegacyCoreSetup extends CoreSetup<any> 
 ```
 
+## Remarks
+
+Some methods are not supported in the legacy platform and while present to make this type compatibile with [CoreSetup](./kibana-plugin-public.coresetup.md)<!-- -->, unsupported methods will throw exceptions when called.
+
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [injectedMetadata](./kibana-plugin-public.legacycoresetup.injectedmetadata.md) | <code>InjectedMetadataSetup</code> |  |
 
-## Remarks
-
-Some methods are not supported in the legacy platform and while present to make this type compatibile with [CoreSetup](./kibana-plugin-public.coresetup.md)<!-- -->, unsupported methods will throw exceptions when called.
-

docs/development/core/public/kibana-plugin-public.legacycorestart.md

@@ -16,13 +16,13 @@ Start interface exposed to the legacy platform via the `ui/new_platform` module.
 export interface LegacyCoreStart extends CoreStart 
 ```
 
+## Remarks
+
+Some methods are not supported in the legacy platform and while present to make this type compatibile with [CoreStart](./kibana-plugin-public.corestart.md)<!-- -->, unsupported methods will throw exceptions when called.
+
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [injectedMetadata](./kibana-plugin-public.legacycorestart.injectedmetadata.md) | <code>InjectedMetadataStart</code> |  |
 
-## Remarks
-
-Some methods are not supported in the legacy platform and while present to make this type compatibile with [CoreStart](./kibana-plugin-public.corestart.md)<!-- -->, unsupported methods will throw exceptions when called.
-

docs/development/core/public/kibana-plugin-public.savedobjectsclient.md

@@ -12,6 +12,10 @@ Saved Objects is Kibana's data persisentence mechanism allowing plugins to use E
 export declare class SavedObjectsClient 
 ```
 
+## Remarks
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SavedObjectsClient` class.
+
 ## Properties
 
 |  Property | Modifiers | Type | Description |
@@ -30,7 +34,3 @@ export declare class SavedObjectsClient
 |  [bulkUpdate(objects)](./kibana-plugin-public.savedobjectsclient.bulkupdate.md) |  | Update multiple documents at once |
 |  [update(type, id, attributes, { version, migrationVersion, references })](./kibana-plugin-public.savedobjectsclient.update.md) |  | Updates an object |
 
-## Remarks
-
-The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SavedObjectsClient` class.
-

docs/development/core/server/kibana-plugin-server.basepath.md

@@ -12,6 +12,10 @@ Access or manipulate the Kibana base path
 export declare class BasePath 
 ```
 
+## Remarks
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BasePath` class.
+
 ## Properties
 
 |  Property | Modifiers | Type | Description |
@@ -22,7 +26,3 @@ export declare class BasePath
 |  [serverBasePath](./kibana-plugin-server.basepath.serverbasepath.md) |  | <code>string</code> | returns the server's basePath<!-- -->See [BasePath.get](./kibana-plugin-server.basepath.get.md) for getting the basePath value for a specific request |
 |  [set](./kibana-plugin-server.basepath.set.md) |  | <code>(request: KibanaRequest&lt;unknown, unknown, unknown, any&gt; &#124; LegacyRequest, requestSpecificBasePath: string) =&gt; void</code> | sets <code>basePath</code> value, specific for an incoming request. |
 
-## Remarks
-
-The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BasePath` class.
-

docs/development/core/server/kibana-plugin-server.configdeprecationfactory.md

@@ -14,15 +14,6 @@ See methods documentation for more detailed examples.
 export interface ConfigDeprecationFactory 
 ```
 
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [rename(oldKey, newKey)](./kibana-plugin-server.configdeprecationfactory.rename.md) | Rename a configuration property from inside a plugin's configuration path. Will log a deprecation warning if the oldKey was found and deprecation applied. |
-|  [renameFromRoot(oldKey, newKey)](./kibana-plugin-server.configdeprecationfactory.renamefromroot.md) | Rename a configuration property from the root configuration. Will log a deprecation warning if the oldKey was found and deprecation applied.<!-- -->This should be only used when renaming properties from different configuration's path. To rename properties from inside a plugin's configuration, use 'rename' instead. |
-|  [unused(unusedKey)](./kibana-plugin-server.configdeprecationfactory.unused.md) | Remove a configuration property from inside a plugin's configuration path. Will log a deprecation warning if the unused key was found and deprecation applied. |
-|  [unusedFromRoot(unusedKey)](./kibana-plugin-server.configdeprecationfactory.unusedfromroot.md) | Remove a configuration property from the root configuration. Will log a deprecation warning if the unused key was found and deprecation applied.<!-- -->This should be only used when removing properties from outside of a plugin's configuration. To remove properties from inside a plugin's configuration, use 'unused' instead. |
-
 ## Example
 
 
@@ -34,3 +25,12 @@ const provider: ConfigDeprecationProvider = ({ rename, unused }) => [
 
 ```
 
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [rename(oldKey, newKey)](./kibana-plugin-server.configdeprecationfactory.rename.md) | Rename a configuration property from inside a plugin's configuration path. Will log a deprecation warning if the oldKey was found and deprecation applied. |
+|  [renameFromRoot(oldKey, newKey)](./kibana-plugin-server.configdeprecationfactory.renamefromroot.md) | Rename a configuration property from the root configuration. Will log a deprecation warning if the oldKey was found and deprecation applied.<!-- -->This should be only used when renaming properties from different configuration's path. To rename properties from inside a plugin's configuration, use 'rename' instead. |
+|  [unused(unusedKey)](./kibana-plugin-server.configdeprecationfactory.unused.md) | Remove a configuration property from inside a plugin's configuration path. Will log a deprecation warning if the unused key was found and deprecation applied. |
+|  [unusedFromRoot(unusedKey)](./kibana-plugin-server.configdeprecationfactory.unusedfromroot.md) | Remove a configuration property from the root configuration. Will log a deprecation warning if the unused key was found and deprecation applied.<!-- -->This should be only used when removing properties from outside of a plugin's configuration. To remove properties from inside a plugin's configuration, use 'unused' instead. |
+