[7.17] Adds documentation to clarify kibana-keystore behaviour (#157146) #157187
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
## Summary Addresses elastic#155474 We've discussed with the team, and decided that we'd retain current behaviour, and adjust the docs and notes around the behaviour. fix(keystore): add warning note to explain that input is being JSON parsed docs(keystore): add documentation to clarify behavior ### Checklist - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) (cherry picked from commit 58650c5)
2 tasks
💚 Build Succeeded
Metrics [docs]
To update your PR or re-run it, just comment with: cc @delanni |
delanni
added a commit
that referenced
this pull request
May 10, 2023
… (#157242) # Backport This will backport the following commits from `main` to `8.8`: - [Adds documentation to clarify kibana-keystore behaviour (#157146)](#157146) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!-- BACKPORT [{"author":{"name":"Alex Szabo","email":"alex.szabo@elastic.co"},"sourceCommit":{"committedDate":"2023-05-09T16:02:45Z","message":"Adds documentation to clarify kibana-keystore behaviour (#157146)\n\n## Summary\r\nAddresses #155474 \r\n\r\nWe've discussed with the team, and decided that we'd retain current\r\nbehaviour, and adjust the docs and notes around the behaviour.\r\n\r\nfix(keystore): add warning note to explain that input is being JSON\r\nparsed\r\ndocs(keystore): add documentation to clarify behavior\r\n\r\n### Checklist\r\n\r\n- [x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n\r\n### For maintainers\r\n\r\n- [x] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"58650c55456fbcf418f7a75edf98de32238f6bea","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Operations","release_note:skip","backport:all-open","v8.9.0","v7.17.11"],"number":157146,"url":"https://github.com/elastic/kibana/pull/157146","mergeCommit":{"message":"Adds documentation to clarify kibana-keystore behaviour (#157146)\n\n## Summary\r\nAddresses #155474 \r\n\r\nWe've discussed with the team, and decided that we'd retain current\r\nbehaviour, and adjust the docs and notes around the behaviour.\r\n\r\nfix(keystore): add warning note to explain that input is being JSON\r\nparsed\r\ndocs(keystore): add documentation to clarify behavior\r\n\r\n### Checklist\r\n\r\n- [x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n\r\n### For maintainers\r\n\r\n- [x] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"58650c55456fbcf418f7a75edf98de32238f6bea"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/157146","number":157146,"mergeCommit":{"message":"Adds documentation to clarify kibana-keystore behaviour (#157146)\n\n## Summary\r\nAddresses #155474 \r\n\r\nWe've discussed with the team, and decided that we'd retain current\r\nbehaviour, and adjust the docs and notes around the behaviour.\r\n\r\nfix(keystore): add warning note to explain that input is being JSON\r\nparsed\r\ndocs(keystore): add documentation to clarify behavior\r\n\r\n### Checklist\r\n\r\n- [x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n\r\n### For maintainers\r\n\r\n- [x] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"58650c55456fbcf418f7a75edf98de32238f6bea"}},{"branch":"7.17","label":"v7.17.11","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/157187","number":157187,"state":"MERGED","mergeCommit":{"sha":"13f1a94039ea0f3c89852eeb6e0c581f5e82f5c3","message":"[7.17] Adds documentation to clarify kibana-keystore behaviour (#157146) (#157187)\n\n# Backport\n\nThis will backport the following commits from `main` to `7.17`:\n- [Adds documentation to clarify kibana-keystore behaviour\n(#157146)](#157146 Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n<!--BACKPORT [{\"author\":{\"name\":\"Alex\nSzabo\",\"email\":\"alex.szabo@elastic.co\"},\"sourceCommit\":{\"committedDate\":\"2023-05-09T16:02:45Z\",\"message\":\"Adds\ndocumentation to clarify kibana-keystore behaviour (#157146)\\n\\n##\nSummary\\r\\nAddresses #155474 \\r\\n\\r\\nWe've discussed with the team, and\ndecided that we'd retain current\\r\\nbehaviour, and adjust the docs and\nnotes around the behaviour.\\r\\n\\r\\nfix(keystore): add warning note to\nexplain that input is being JSON\\r\\nparsed\\r\\ndocs(keystore): add\ndocumentation to clarify behavior\\r\\n\\r\\n### Checklist\\r\\n\\r\\n-\n[x]\\r\\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\\r\\nwas\nadded for features that require explanation or tutorials\\r\\n\\r\\n### For\nmaintainers\\r\\n\\r\\n- [x] This was checked for breaking API changes and\nwas\n[labeled\\r\\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\",\"sha\":\"58650c55456fbcf418f7a75edf98de32238f6bea\",\"branchLabelMapping\":{\"^v8.9.0$\":\"main\",\"^v(\\\\d+).(\\\\d+).\\\\d+$\":\"$1.$2\"}},\"sourcePullRequest\":{\"labels\":[\"Team:Operations\",\"release_note:skip\",\"backport:all-open\",\"v8.9.0\"],\"number\":157146,\"url\":\"https://github.com/elastic/kibana/pull/157146\",\"mergeCommit\":{\"message\":\"Adds\ndocumentation to clarify kibana-keystore behaviour (#157146)\\n\\n##\nSummary\\r\\nAddresses #155474 \\r\\n\\r\\nWe've discussed with the team, and\ndecided that we'd retain current\\r\\nbehaviour, and adjust the docs and\nnotes around the behaviour.\\r\\n\\r\\nfix(keystore): add warning note to\nexplain that input is being JSON\\r\\nparsed\\r\\ndocs(keystore): add\ndocumentation to clarify behavior\\r\\n\\r\\n### Checklist\\r\\n\\r\\n-\n[x]\\r\\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\\r\\nwas\nadded for features that require explanation or tutorials\\r\\n\\r\\n### For\nmaintainers\\r\\n\\r\\n- [x] This was checked for breaking API changes and\nwas\n[labeled\\r\\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\",\"sha\":\"58650c55456fbcf418f7a75edf98de32238f6bea\"}},\"sourceBranch\":\"main\",\"suggestedTargetBranches\":[],\"targetPullRequestStates\":[{\"branch\":\"main\",\"label\":\"v8.9.0\",\"labelRegex\":\"^v8.9.0$\",\"isSourceBranch\":true,\"state\":\"MERGED\",\"url\":\"https://github.com/elastic/kibana/pull/157146\",\"number\":157146,\"mergeCommit\":{\"message\":\"Adds\ndocumentation to clarify kibana-keystore behaviour (#157146)\\n\\n##\nSummary\\r\\nAddresses #155474 \\r\\n\\r\\nWe've discussed with the team, and\ndecided that we'd retain current\\r\\nbehaviour, and adjust the docs and\nnotes around the behaviour.\\r\\n\\r\\nfix(keystore): add warning note to\nexplain that input is being JSON\\r\\nparsed\\r\\ndocs(keystore): add\ndocumentation to clarify behavior\\r\\n\\r\\n### Checklist\\r\\n\\r\\n-\n[x]\\r\\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\\r\\nwas\nadded for features that require explanation or tutorials\\r\\n\\r\\n### For\nmaintainers\\r\\n\\r\\n- [x] This was checked for breaking API changes and\nwas\n[labeled\\r\\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\",\"sha\":\"58650c55456fbcf418f7a75edf98de32238f6bea\"}}]}]\nBACKPORT-->\n\nCo-authored-by: Alex Szabo <alex.szabo@elastic.co>"}}]}] BACKPORT-->
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.
Backport
This will backport the following commits from
mainto7.17:Questions ?
Please refer to the Backport tool documentation