Skip to content

Commit

Permalink
[8.11] Enhance plugin documentation (#146678) (#172104)
Browse files Browse the repository at this point in the history
# Backport

This will backport the following commits from `main` to `8.11`:
- [Enhance plugin documentation
(#146678)](#146678)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Gerard
Soldevila","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-11-28T19:58:46Z","message":"Enhance
plugin documentation (#146678)\n\nThe PR tackles a couple of
improvements for the new `'notifications'`\nplugin documentation:\n\n-
Add a link to the plugin API description in the kibana-dev-docs
nav\nbar.\n- Convert the README to
`mdx`.\n\n---------\n\nCo-authored-by: kibanamachine
<[email protected]>","sha":"98b2cfbbb0442898e84189291b7f5c5a725a6115","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","Team:AppServicesSv","release_note:skip","docs","DevDocs","documentation","APIDocs","backport:prev-minor","v8.12.0"],"number":146678,"url":"https://github.com/elastic/kibana/pull/146678","mergeCommit":{"message":"Enhance
plugin documentation (#146678)\n\nThe PR tackles a couple of
improvements for the new `'notifications'`\nplugin documentation:\n\n-
Add a link to the plugin API description in the kibana-dev-docs
nav\nbar.\n- Convert the README to
`mdx`.\n\n---------\n\nCo-authored-by: kibanamachine
<[email protected]>","sha":"98b2cfbbb0442898e84189291b7f5c5a725a6115"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/146678","number":146678,"mergeCommit":{"message":"Enhance
plugin documentation (#146678)\n\nThe PR tackles a couple of
improvements for the new `'notifications'`\nplugin documentation:\n\n-
Add a link to the plugin API description in the kibana-dev-docs
nav\nbar.\n- Convert the README to
`mdx`.\n\n---------\n\nCo-authored-by: kibanamachine
<[email protected]>","sha":"98b2cfbbb0442898e84189291b7f5c5a725a6115"}}]}]
BACKPORT-->

Co-authored-by: Gerard Soldevila <[email protected]>
  • Loading branch information
kibanamachine and gsoldevila authored Nov 28, 2023
1 parent 35393bc commit 5748e27
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/developer/plugin-list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions docs/setup/settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<pre-configured-connectors,preconfigured>> 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
Expand Down
3 changes: 3 additions & 0 deletions nav-kibana-dev.docnav.json
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,9 @@
{
"id": "kibNewsfeedPluginApi"
},
{
"id": "kibNotificationsPluginApi"
},
{
"id": "kibObservabilityPluginApi"
},
Expand Down
File renamed without changes.

0 comments on commit 5748e27

Please sign in to comment.