Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Update Sharing docs #190318

Merged
merged 16 commits into from
Sep 23, 2024
Merged

[Docs] Update Sharing docs #190318

merged 16 commits into from
Sep 23, 2024

Conversation

florent-leborgne
Copy link
Contributor

@florent-leborgne florent-leborgne commented Aug 12, 2024 •
edited by kibanamachine
Loading

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

Reporting Getting Started

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

@florent-leborgne florent-leborgne added Team:Docs release_note:skip Skip the PR/issue when compiling release notes docs labels Aug 12, 2024
@florent-leborgne florent-leborgne self-assigned this Aug 12, 2024
@github-actions GitHub Actions
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

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.

@eokoneyo
Copy link
Contributor

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?

@florent-leborgne
Copy link
Contributor Author

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

@florent-leborgne florent-leborgne marked this pull request as ready for review August 23, 2024 14:32
@florent-leborgne florent-leborgne requested a review from a team as a code owner August 23, 2024 14:32
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @florent-leborgne

tsullivan
tsullivan reviewed Sep 18, 2024
View reviewed changes
docs/user/reporting/index.asciidoc

* *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]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a temporary image URL?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
tsullivan reviewed Sep 18, 2024
View reviewed changes
Copy link
Member

@tsullivan tsullivan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@florent-leborgne
Overall this looks great and is a huge improvement. Thank you!

I left a couple of comments

@florent-leborgne florent-leborgne added the backport:version Backport to applied version labels label Sep 19, 2024
@florent-leborgne
Copy link
Contributor Author

@tsullivan I reviewed your comments. Let me know if you're good with the PR now

@florent-leborgne florent-leborgne merged commit 9e2ad98 into elastic:main Sep 23, 2024
8 checks passed
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Sep 23, 2024
@florent-leborgne
[Docs] Update Sharing docs (elastic#190318)
8d01709 
## 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

![Reporting Getting
Started](https://github.com/user-attachments/assets/d2c123a2-b7db-4d5e-928f-79785409ff07)

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)
@kibanamachine kibanamachine mentioned this pull request Sep 23, 2024
Merged
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Sep 23, 2024
@florent-leborgne
[Docs] Update Sharing docs (elastic#190318)
4586958 
## 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

![Reporting Getting
Started](https://github.com/user-attachments/assets/d2c123a2-b7db-4d5e-928f-79785409ff07)

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)
@kibanamachine kibanamachine mentioned this pull request Sep 23, 2024
Merged
@kibanamachine
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
❌ 8.14 Backport failed because of merge conflicts
✅ 8.15
✅ 8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 190318

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Sep 23, 2024
@kibanamachine @florent-leborgne
[8.15] [Docs] Update Sharing docs (#190318) (#193686)
88888e0 
# 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":"[email protected]"},"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![Reporting
Getting\r\nStarted](https://github.com/user-attachments/assets/d2c123a2-b7db-4d5e-928f-79785409ff07)\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![Reporting
Getting\r\nStarted](https://github.com/user-attachments/assets/d2c123a2-b7db-4d5e-928f-79785409ff07)\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![Reporting
Getting\r\nStarted](https://github.com/user-attachments/assets/d2c123a2-b7db-4d5e-928f-79785409ff07)\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 <[email protected]>
kibanamachine added a commit that referenced this pull request Sep 23, 2024
@kibanamachine @florent-leborgne
[8.x] [Docs] Update Sharing docs (#190318) (#193687)
5844ba0 
# 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":"[email protected]"},"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![Reporting
Getting\r\nStarted](https://github.com/user-attachments/assets/d2c123a2-b7db-4d5e-928f-79785409ff07)\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![Reporting
Getting\r\nStarted](https://github.com/user-attachments/assets/d2c123a2-b7db-4d5e-928f-79785409ff07)\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![Reporting
Getting\r\nStarted](https://github.com/user-attachments/assets/d2c123a2-b7db-4d5e-928f-79785409ff07)\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 <[email protected]>
weizijun added a commit to weizijun/kibana that referenced this pull request Sep 23, 2024
@weizijun
Merge branch 'main' into add-alibaba-inference
2100828 
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kevinsweet kevinsweet kevinsweet approved these changes

@tsullivan tsullivan tsullivan approved these changes

@eokoneyo eokoneyo Awaiting requested review from eokoneyo

@teresaalvarezsoler teresaalvarezsoler Awaiting requested review from teresaalvarezsoler

@rshen91 rshen91 Awaiting requested review from rshen91

@petrklapka petrklapka Awaiting requested review from petrklapka

Assignees

@florent-leborgne florent-leborgne

Labels
backport:version Backport to applied version labels docs release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.15.0 v8.15.2 v8.16.0 v9.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@florent-leborgne @eokoneyo @elasticmachine @kibana-ci @kibanamachine @tsullivan @kevinsweet