Enhance plugin documentation #146678
Merged
Enhance plugin documentation #146678
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gsoldevila
added
Team:Core
|
Pinging @elastic/kibana-core (Team:Core) |
|
Pinging @elastic/kibana-app-services (Team:AppServicesSv) |
|
Documentation preview: |
There was a problem hiding this comment.
We're almost there!
I think we're missing some frontmatter for the internal dev docs about the notifications plugin but I'm checking with the docs team to see if that's still needed.
@elastic/kibana-docs are the instructions for internal plugin documentation still relevant?
|
We also need to let end-users know about the |
gsoldevila
force-pushed
the
kbn-140743-notifications-api-update-doc
branch
from
6923993 to
9d73483
Compare
|
With recent changes, frontmatter isn't needed anymore. After rebasing and updating to work with our docs setup now, we should be good to get this in. |
TinaHeiligers
approved these changes
Nov 28, 2023
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: cc @gsoldevila |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Nov 28, 2023
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 <[email protected]> (cherry picked from commit 98b2cfb)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Nov 28, 2023
# 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]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The PR tackles a couple of improvements for the new
'notifications'plugin documentation:mdx.