[Docs] Update Sharing docs#190318
Conversation
|
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
|
Hi @florent-leborgne stumbled on your PR, I have one too that updates the doc for automatically generating a report here(#191067), I suppose it would be more appropriate that both PRs are either co-ordinated to deploy together to avoid confusion. what do you think? |
|
Hey @eokoneyo, thanks for the heads up! Were you planning to do more updates in your PR? I still have to review a few things and don't want to block you |
|
Pinging @elastic/kibana-docs (Team:Docs) |
💚 Build Succeeded
To update your PR or re-run it, just comment with: |
| Anonymous users can also access the link if you have configured <<anonymous-authentication,Anonymous authentication>> and your anonymous service account has privileges to access what you want to share. | ||
|
|
||
| * *Get links* — Share direct links to saved searches, dashboards, and visualizations. | ||
| image::https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blt49f2b5a80ec89a34/66b9e919af508f4ac182c194/share-dashboard.gif[getting a shareable link for a dashboard] |
There was a problem hiding this comment.
Is this a temporary image URL?
There was a problem hiding this comment.
No, it's a link to a gif hosted on our asset service (contentstack). We put gifs there to avoid adding too heavy assets to the repo.
tsullivan
left a comment
There was a problem hiding this comment.
@florent-leborgne
Overall this looks great and is a huge improvement. Thank you!
I left a couple of comments
|
@tsullivan I reviewed your comments. Let me know if you're good with the PR now |
## Summary This PR updates the docs regarding the **Share** menu in Kibana. Note1: Please advise on the public URL/anonymous access feature. I'm not sure whether it is still present nor under which form for the Link and Embed sharing options. Note2: @eokoneyo also has related updates in elastic#191067  Note: The step ordering for the last section in the screenshot has been fixed in the source. Closes: elastic/platform-docs-team#355 (cherry picked from commit 9e2ad98)
## Summary This PR updates the docs regarding the **Share** menu in Kibana. Note1: Please advise on the public URL/anonymous access feature. I'm not sure whether it is still present nor under which form for the Link and Embed sharing options. Note2: @eokoneyo also has related updates in elastic#191067  Note: The step ordering for the last section in the screenshot has been fixed in the source. Closes: elastic/platform-docs-team#355 (cherry picked from commit 9e2ad98)
💔 Some backports could not be created
Note: Successful backport PRs will be merged automatically after passing CI. Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
# Backport This will backport the following commits from `main` to `8.15`: - [[Docs] Update Sharing docs (#190318)](#190318) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"florent-leborgne","email":"florent.leborgne@elastic.co"},"sourceCommit":{"committedDate":"2024-09-23T09:31:03Z","message":"[Docs] Update Sharing docs (#190318)\n\n## Summary\r\n\r\nThis PR updates the docs regarding the **Share** menu in Kibana.\r\n\r\nNote1: Please advise on the public URL/anonymous access feature. I'm not\r\nsure whether it is still present nor under which form for the Link and\r\nEmbed sharing options.\r\n\r\nNote2: @eokoneyo also has related updates in\r\nhttps://github.com//pull/191067\r\n\r\n\r\n\r\nNote: The step ordering for the last section in the screenshot has been\r\nfixed in the source.\r\n\r\nCloses: https://github.com/elastic/platform-docs-team/issues/355","sha":"9e2ad98d0681f346085e3277a246ddee0f77018a","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","v8.14.0","v8.15.0","v8.16.0","backport:version"],"title":"[Docs] Update Sharing docs","number":190318,"url":"https://github.com/elastic/kibana/pull/190318","mergeCommit":{"message":"[Docs] Update Sharing docs (#190318)\n\n## Summary\r\n\r\nThis PR updates the docs regarding the **Share** menu in Kibana.\r\n\r\nNote1: Please advise on the public URL/anonymous access feature. I'm not\r\nsure whether it is still present nor under which form for the Link and\r\nEmbed sharing options.\r\n\r\nNote2: @eokoneyo also has related updates in\r\nhttps://github.com//pull/191067\r\n\r\n\r\n\r\nNote: The step ordering for the last section in the screenshot has been\r\nfixed in the source.\r\n\r\nCloses: https://github.com/elastic/platform-docs-team/issues/355","sha":"9e2ad98d0681f346085e3277a246ddee0f77018a"}},"sourceBranch":"main","suggestedTargetBranches":["8.14","8.15","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/190318","number":190318,"mergeCommit":{"message":"[Docs] Update Sharing docs (#190318)\n\n## Summary\r\n\r\nThis PR updates the docs regarding the **Share** menu in Kibana.\r\n\r\nNote1: Please advise on the public URL/anonymous access feature. I'm not\r\nsure whether it is still present nor under which form for the Link and\r\nEmbed sharing options.\r\n\r\nNote2: @eokoneyo also has related updates in\r\nhttps://github.com//pull/191067\r\n\r\n\r\n\r\nNote: The step ordering for the last section in the screenshot has been\r\nfixed in the source.\r\n\r\nCloses: https://github.com/elastic/platform-docs-team/issues/355","sha":"9e2ad98d0681f346085e3277a246ddee0f77018a"}},{"branch":"8.14","label":"v8.14.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.15","label":"v8.15.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
# Backport This will backport the following commits from `main` to `8.x`: - [[Docs] Update Sharing docs (#190318)](#190318) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"florent-leborgne","email":"florent.leborgne@elastic.co"},"sourceCommit":{"committedDate":"2024-09-23T09:31:03Z","message":"[Docs] Update Sharing docs (#190318)\n\n## Summary\r\n\r\nThis PR updates the docs regarding the **Share** menu in Kibana.\r\n\r\nNote1: Please advise on the public URL/anonymous access feature. I'm not\r\nsure whether it is still present nor under which form for the Link and\r\nEmbed sharing options.\r\n\r\nNote2: @eokoneyo also has related updates in\r\nhttps://github.com//pull/191067\r\n\r\n\r\n\r\nNote: The step ordering for the last section in the screenshot has been\r\nfixed in the source.\r\n\r\nCloses: https://github.com/elastic/platform-docs-team/issues/355","sha":"9e2ad98d0681f346085e3277a246ddee0f77018a","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","v8.14.0","v8.15.0","v8.16.0","backport:version"],"title":"[Docs] Update Sharing docs","number":190318,"url":"https://github.com/elastic/kibana/pull/190318","mergeCommit":{"message":"[Docs] Update Sharing docs (#190318)\n\n## Summary\r\n\r\nThis PR updates the docs regarding the **Share** menu in Kibana.\r\n\r\nNote1: Please advise on the public URL/anonymous access feature. I'm not\r\nsure whether it is still present nor under which form for the Link and\r\nEmbed sharing options.\r\n\r\nNote2: @eokoneyo also has related updates in\r\nhttps://github.com//pull/191067\r\n\r\n\r\n\r\nNote: The step ordering for the last section in the screenshot has been\r\nfixed in the source.\r\n\r\nCloses: https://github.com/elastic/platform-docs-team/issues/355","sha":"9e2ad98d0681f346085e3277a246ddee0f77018a"}},"sourceBranch":"main","suggestedTargetBranches":["8.14","8.15","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/190318","number":190318,"mergeCommit":{"message":"[Docs] Update Sharing docs (#190318)\n\n## Summary\r\n\r\nThis PR updates the docs regarding the **Share** menu in Kibana.\r\n\r\nNote1: Please advise on the public URL/anonymous access feature. I'm not\r\nsure whether it is still present nor under which form for the Link and\r\nEmbed sharing options.\r\n\r\nNote2: @eokoneyo also has related updates in\r\nhttps://github.com//pull/191067\r\n\r\n\r\n\r\nNote: The step ordering for the last section in the screenshot has been\r\nfixed in the source.\r\n\r\nCloses: https://github.com/elastic/platform-docs-team/issues/355","sha":"9e2ad98d0681f346085e3277a246ddee0f77018a"}},{"branch":"8.14","label":"v8.14.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.15","label":"v8.15.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
* main: (176 commits) [ML][Rules] Fixes deletion in Check interval input for anomaly detection rule (elastic#193420) Bump maximum supported package spec version to 3.2 (elastic#193574) [ES|QL] new pattern for `SORT` autocomplete (elastic#193595) [Inventory][ECO] Entities page search bar (elastic#193546) [Synthetics] Remove extra overview route (elastic#192449) [Obs Alerts table] Fix error on clicking alert reason message (elastic#193693) [Migrations] Remove tests that are not applicable in 9.x (elastic#193699) [EDR Workflows] Set Agent Tamper Protection to false on policy unassignment (elastic#193017) [Inventory][ECO] Enable elastic entity model from inventory (elastic#193557) [EDR Workflows] The host isolation exception tab is hidden on the basic license if no artifacts (elastic#192562) [Entity Analytics] Ensuring definition transforms are managed (elastic#193408) [Automatic Import] Do not remove message field for unstructured logs (elastic#193678) [Fleet] Add missing permissions for connector package (elastic#193573) [Fleet] using @kbn/config-schema part 2 (outputs and other apis) (elastic#193326) [Migrations] Provide testing archives + tooling for migrations integration tests (elastic#193328) [ES|QL] Renames the textbased editor to esql editor (elastic#193521) [ES|QL] Update function metadata (elastic#193662) [Security Solution][Entity Analytics] Scoping the entity store to spaces (elastic#193303) [Docs] Update Sharing docs (elastic#190318) [ML] AIOps: Move Log Rate Analysis results callout to help popover. (elastic#192243) ... # Conflicts: # x-pack/plugins/search_inference_endpoints/public/components/all_inference_endpoints/render_table_columns/render_endpoint/endpoint_info.test.tsx # x-pack/plugins/search_inference_endpoints/public/components/all_inference_endpoints/render_table_columns/render_endpoint/endpoint_info.tsx
Summary
This PR updates the docs regarding the Share menu in Kibana.
Note1: Please advise on the public URL/anonymous access feature. I'm not sure whether it is still present nor under which form for the Link and Embed sharing options.
Note2: @eokoneyo also has related updates in #191067
Note: The step ordering for the last section in the screenshot has been fixed in the source.
Closes: https://github.com/elastic/platform-docs-team/issues/355