From b2e656b2dd8f9d698a3410771c0cdda0a206890d Mon Sep 17 00:00:00 2001 From: Gerard Soldevila Date: Tue, 28 Nov 2023 20:58:46 +0100 Subject: [PATCH] Enhance plugin documentation (#146678) The PR tackles a couple of improvements for the new `'notifications'` plugin documentation: - Add a link to the plugin API description in the kibana-dev-docs nav bar. - Convert the README to `mdx`. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 98b2cfbbb0442898e84189291b7f5c5a725a6115) --- docs/developer/plugin-list.asciidoc | 2 +- docs/setup/settings.asciidoc | 3 +-- nav-kibana-dev.docnav.json | 3 +++ x-pack/plugins/notifications/{README.md => README.mdx} | 0 4 files changed, 5 insertions(+), 3 deletions(-) rename x-pack/plugins/notifications/{README.md => README.mdx} (100%) diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index 40c8fbf2b338b..5651ebfd6730f 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -668,7 +668,7 @@ Elastic. |This plugin allows for other plugins to add data to Kibana stack monitoring documents. -|{kib-repo}blob/{branch}/x-pack/plugins/notifications/README.md[notifications] +|{kib-repo}blob/{branch}/x-pack/plugins/notifications/README.mdx[notifications] |The Notifications plugin provides a set of services to help Solutions and plugins send notifications to users. diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index 9d38b5162f124..13e3fad93cfca 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -323,8 +323,7 @@ run {kib} in different modes. Valid options are `background_tasks` and `ui`, or `*` to select all roles. *Default: `*`* `notifications.connectors.default.email`:: -Specifies the name of the connector that is used to send email notifications. -In {ecloud}, the default value is `elastic-cloud-email`. + Choose the default email connector for user notifications. As of `8.6.0`, {kib} is shipping with a new notification mechanism that will send email notifications for various user actions, e.g. assigning a _Case_ to a user. To enable notifications, an email connector must be <> in the system via `kibana.yml`, and the notifications plugin must be configured to point to the ID of that connector. [[path-data]] `path.data`:: The path where {kib} stores persistent data diff --git a/nav-kibana-dev.docnav.json b/nav-kibana-dev.docnav.json index 0c70e54167122..0464ee2e4d496 100644 --- a/nav-kibana-dev.docnav.json +++ b/nav-kibana-dev.docnav.json @@ -411,6 +411,9 @@ { "id": "kibNewsfeedPluginApi" }, + { + "id": "kibNotificationsPluginApi" + }, { "id": "kibObservabilityPluginApi" }, diff --git a/x-pack/plugins/notifications/README.md b/x-pack/plugins/notifications/README.mdx similarity index 100% rename from x-pack/plugins/notifications/README.md rename to x-pack/plugins/notifications/README.mdx