[Docs] Discover docs updates #198423
Merged
[Docs] Discover docs updates #198423
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
florent-leborgne
added
Team:Docs
release_note:skip
|
Pinging @elastic/kibana-docs (Team:Docs) |
|
Pinging @elastic/kibana-data-discovery (Team:DataDiscovery) |
|
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. |
|
@elasticmachine merge upstream |
|
Here's a direkt link to the Discover doc in the master version: https://kibana_bk_198423.docs-preview.app.elstc.co/guide/en/kibana/master/discover.html |
kertal
reviewed
Nov 5, 2024
jughosta
reviewed
Nov 5, 2024
Co-authored-by: Matthias Wilhelm <[email protected]>
Co-authored-by: Julia Rechkunova <[email protected]>
davismcphee
reviewed
Nov 6, 2024
There was a problem hiding this comment.
Great work on this, and thank you for updating our long neglected docs! 🙏 It's looking good overall. I left a bunch of comments, some with important clarifications, and many with just nits and minor suggestions. I think anything that's not related to clarifying concepts can be treated as optional.
I have some other thoughts on potential improvements for the Discover docs in general, but I'll save those for now to avoid dragging this PR out 🙂
|
|
||
| * To change the chart height, drag the resize handle | ||
| image:images/resize-icon.png[two-line icon for increasing or decreasing the height of the chart, width=24px] | ||
| * Adjust the width and height of each area by dragging their border |
There was a problem hiding this comment.
I see we're using "area" here so maybe we stick with that.
|
Thank you so much for the detailed review @davismcphee, @kertal and @jughosta. The nuances you suggested make all the difference indeed, and also clarify a few things for me. @davismcphee I'm also happy to discuss more separately from this PR to know your other thoughts about improving these docs |
florent-leborgne
commented
Nov 6, 2024
jughosta
reviewed
Nov 6, 2024
There was a problem hiding this comment.
Thanks, @florent-leborgne, for updating the docs! Much appreciated 🙌
florent-leborgne
commented
Nov 6, 2024
florent-leborgne
commented
Nov 6, 2024
davismcphee
approved these changes
Nov 8, 2024
|
Starting backport for target branches: 8.16, 8.x |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Nov 8, 2024
This PR updates the first few pages of the Discover docs: - Splits most of the content of the parent page into a child page to match with the structure of the Dashboards docs - Refocuses some of the content so that it looks generally applicable to users and their data rather than a sample data-based tutorial - Adds missing content flagged in elastic#192149 - Adds some content updates specific to 8.16 flagged in elastic/platform-docs-team#500 (I still need to figure out what's the best way to document ES|QL stuff) Rel: elastic/platform-docs-team#500 Closes: elastic#192149 Closes: elastic#162265 Closes: elastic#187417 Note: While there may be more missing features that we want to document, let's first get these updates in. Note2: If you're wondering where to preview the changes, find the preview link in the Github actions comment and navigate to the "master" version of the Kibana guide. --------- Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Matthias Wilhelm <[email protected]> Co-authored-by: Julia Rechkunova <[email protected]> Co-authored-by: Davis McPhee <[email protected]> (cherry picked from commit 3d76349)
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Nov 8, 2024
This PR updates the first few pages of the Discover docs: - Splits most of the content of the parent page into a child page to match with the structure of the Dashboards docs - Refocuses some of the content so that it looks generally applicable to users and their data rather than a sample data-based tutorial - Adds missing content flagged in elastic#192149 - Adds some content updates specific to 8.16 flagged in elastic/platform-docs-team#500 (I still need to figure out what's the best way to document ES|QL stuff) Rel: elastic/platform-docs-team#500 Closes: elastic#192149 Closes: elastic#162265 Closes: elastic#187417 Note: While there may be more missing features that we want to document, let's first get these updates in. Note2: If you're wondering where to preview the changes, find the preview link in the Github actions comment and navigate to the "master" version of the Kibana guide. --------- Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Matthias Wilhelm <[email protected]> Co-authored-by: Julia Rechkunova <[email protected]> Co-authored-by: Davis McPhee <[email protected]> (cherry picked from commit 3d76349)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
|
thank yor so much @florent-leborgne 🥳 |
kibanamachine
added a commit
that referenced
this pull request
Nov 8, 2024
# Backport This will backport the following commits from `main` to `8.16`: - [[Docs] Discover docs updates (#198423)](#198423) <!--- 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-11-08T11:12:05Z","message":"[Docs] Discover docs updates (#198423)\n\nThis PR updates the first few pages of the Discover docs:\r\n- Splits most of the content of the parent page into a child page to\r\nmatch with the structure of the Dashboards docs\r\n- Refocuses some of the content so that it looks generally applicable to\r\nusers and their data rather than a sample data-based tutorial\r\n- Adds missing content flagged in\r\nhttps://github.com//issues/192149\r\n- Adds some content updates specific to 8.16 flagged in\r\nhttps://github.com/elastic/platform-docs-team/issues/500 (I still need\r\nto figure out what's the best way to document ES|QL stuff)\r\n\r\nRel: https://github.com/elastic/platform-docs-team/issues/500\r\nCloses: #192149 \r\nCloses: https://github.com/elastic/kibana/issues/162265\r\nCloses: https://github.com/elastic/kibana/issues/187417\r\n\r\nNote: While there may be more missing features that we want to document,\r\nlet's first get these updates in.\r\n\r\nNote2: If you're wondering where to preview the changes, find the\r\npreview link in the Github actions comment and navigate to the \"master\"\r\nversion of the Kibana guide.\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: Matthias Wilhelm <[email protected]>\r\nCo-authored-by: Julia Rechkunova <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"3d763498b86b4bbd2d3b684c2153f9ac1c0eaeba","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","Team:DataDiscovery","v8.16.0","backport:version","v8.17.0"],"title":"[Docs] Discover docs updates","number":198423,"url":"https://github.com/elastic/kibana/pull/198423","mergeCommit":{"message":"[Docs] Discover docs updates (#198423)\n\nThis PR updates the first few pages of the Discover docs:\r\n- Splits most of the content of the parent page into a child page to\r\nmatch with the structure of the Dashboards docs\r\n- Refocuses some of the content so that it looks generally applicable to\r\nusers and their data rather than a sample data-based tutorial\r\n- Adds missing content flagged in\r\nhttps://github.com//issues/192149\r\n- Adds some content updates specific to 8.16 flagged in\r\nhttps://github.com/elastic/platform-docs-team/issues/500 (I still need\r\nto figure out what's the best way to document ES|QL stuff)\r\n\r\nRel: https://github.com/elastic/platform-docs-team/issues/500\r\nCloses: #192149 \r\nCloses: https://github.com/elastic/kibana/issues/162265\r\nCloses: https://github.com/elastic/kibana/issues/187417\r\n\r\nNote: While there may be more missing features that we want to document,\r\nlet's first get these updates in.\r\n\r\nNote2: If you're wondering where to preview the changes, find the\r\npreview link in the Github actions comment and navigate to the \"master\"\r\nversion of the Kibana guide.\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: Matthias Wilhelm <[email protected]>\r\nCo-authored-by: Julia Rechkunova <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"3d763498b86b4bbd2d3b684c2153f9ac1c0eaeba"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/198423","number":198423,"mergeCommit":{"message":"[Docs] Discover docs updates (#198423)\n\nThis PR updates the first few pages of the Discover docs:\r\n- Splits most of the content of the parent page into a child page to\r\nmatch with the structure of the Dashboards docs\r\n- Refocuses some of the content so that it looks generally applicable to\r\nusers and their data rather than a sample data-based tutorial\r\n- Adds missing content flagged in\r\nhttps://github.com//issues/192149\r\n- Adds some content updates specific to 8.16 flagged in\r\nhttps://github.com/elastic/platform-docs-team/issues/500 (I still need\r\nto figure out what's the best way to document ES|QL stuff)\r\n\r\nRel: https://github.com/elastic/platform-docs-team/issues/500\r\nCloses: #192149 \r\nCloses: https://github.com/elastic/kibana/issues/162265\r\nCloses: https://github.com/elastic/kibana/issues/187417\r\n\r\nNote: While there may be more missing features that we want to document,\r\nlet's first get these updates in.\r\n\r\nNote2: If you're wondering where to preview the changes, find the\r\npreview link in the Github actions comment and navigate to the \"master\"\r\nversion of the Kibana guide.\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: Matthias Wilhelm <[email protected]>\r\nCo-authored-by: Julia Rechkunova <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"3d763498b86b4bbd2d3b684c2153f9ac1c0eaeba"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: florent-leborgne <[email protected]>
kibanamachine
added a commit
that referenced
this pull request
Nov 8, 2024
# Backport This will backport the following commits from `main` to `8.x`: - [[Docs] Discover docs updates (#198423)](#198423) <!--- 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-11-08T11:12:05Z","message":"[Docs] Discover docs updates (#198423)\n\nThis PR updates the first few pages of the Discover docs:\r\n- Splits most of the content of the parent page into a child page to\r\nmatch with the structure of the Dashboards docs\r\n- Refocuses some of the content so that it looks generally applicable to\r\nusers and their data rather than a sample data-based tutorial\r\n- Adds missing content flagged in\r\nhttps://github.com//issues/192149\r\n- Adds some content updates specific to 8.16 flagged in\r\nhttps://github.com/elastic/platform-docs-team/issues/500 (I still need\r\nto figure out what's the best way to document ES|QL stuff)\r\n\r\nRel: https://github.com/elastic/platform-docs-team/issues/500\r\nCloses: #192149 \r\nCloses: https://github.com/elastic/kibana/issues/162265\r\nCloses: https://github.com/elastic/kibana/issues/187417\r\n\r\nNote: While there may be more missing features that we want to document,\r\nlet's first get these updates in.\r\n\r\nNote2: If you're wondering where to preview the changes, find the\r\npreview link in the Github actions comment and navigate to the \"master\"\r\nversion of the Kibana guide.\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: Matthias Wilhelm <[email protected]>\r\nCo-authored-by: Julia Rechkunova <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"3d763498b86b4bbd2d3b684c2153f9ac1c0eaeba","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","Team:DataDiscovery","v8.16.0","backport:version","v8.17.0"],"title":"[Docs] Discover docs updates","number":198423,"url":"https://github.com/elastic/kibana/pull/198423","mergeCommit":{"message":"[Docs] Discover docs updates (#198423)\n\nThis PR updates the first few pages of the Discover docs:\r\n- Splits most of the content of the parent page into a child page to\r\nmatch with the structure of the Dashboards docs\r\n- Refocuses some of the content so that it looks generally applicable to\r\nusers and their data rather than a sample data-based tutorial\r\n- Adds missing content flagged in\r\nhttps://github.com//issues/192149\r\n- Adds some content updates specific to 8.16 flagged in\r\nhttps://github.com/elastic/platform-docs-team/issues/500 (I still need\r\nto figure out what's the best way to document ES|QL stuff)\r\n\r\nRel: https://github.com/elastic/platform-docs-team/issues/500\r\nCloses: #192149 \r\nCloses: https://github.com/elastic/kibana/issues/162265\r\nCloses: https://github.com/elastic/kibana/issues/187417\r\n\r\nNote: While there may be more missing features that we want to document,\r\nlet's first get these updates in.\r\n\r\nNote2: If you're wondering where to preview the changes, find the\r\npreview link in the Github actions comment and navigate to the \"master\"\r\nversion of the Kibana guide.\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: Matthias Wilhelm <[email protected]>\r\nCo-authored-by: Julia Rechkunova <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"3d763498b86b4bbd2d3b684c2153f9ac1c0eaeba"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/198423","number":198423,"mergeCommit":{"message":"[Docs] Discover docs updates (#198423)\n\nThis PR updates the first few pages of the Discover docs:\r\n- Splits most of the content of the parent page into a child page to\r\nmatch with the structure of the Dashboards docs\r\n- Refocuses some of the content so that it looks generally applicable to\r\nusers and their data rather than a sample data-based tutorial\r\n- Adds missing content flagged in\r\nhttps://github.com//issues/192149\r\n- Adds some content updates specific to 8.16 flagged in\r\nhttps://github.com/elastic/platform-docs-team/issues/500 (I still need\r\nto figure out what's the best way to document ES|QL stuff)\r\n\r\nRel: https://github.com/elastic/platform-docs-team/issues/500\r\nCloses: #192149 \r\nCloses: https://github.com/elastic/kibana/issues/162265\r\nCloses: https://github.com/elastic/kibana/issues/187417\r\n\r\nNote: While there may be more missing features that we want to document,\r\nlet's first get these updates in.\r\n\r\nNote2: If you're wondering where to preview the changes, find the\r\npreview link in the Github actions comment and navigate to the \"master\"\r\nversion of the Kibana guide.\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: Matthias Wilhelm <[email protected]>\r\nCo-authored-by: Julia Rechkunova <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"3d763498b86b4bbd2d3b684c2153f9ac1c0eaeba"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: florent-leborgne <[email protected]>
CAWilson94
pushed a commit
to CAWilson94/kibana
that referenced
this pull request
Nov 8, 2024
This PR updates the first few pages of the Discover docs: - Splits most of the content of the parent page into a child page to match with the structure of the Dashboards docs - Refocuses some of the content so that it looks generally applicable to users and their data rather than a sample data-based tutorial - Adds missing content flagged in elastic#192149 - Adds some content updates specific to 8.16 flagged in elastic/platform-docs-team#500 (I still need to figure out what's the best way to document ES|QL stuff) Rel: elastic/platform-docs-team#500 Closes: elastic#192149 Closes: elastic#162265 Closes: elastic#187417 Note: While there may be more missing features that we want to document, let's first get these updates in. Note2: If you're wondering where to preview the changes, find the preview link in the Github actions comment and navigate to the "master" version of the Kibana guide. --------- Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Matthias Wilhelm <[email protected]> Co-authored-by: Julia Rechkunova <[email protected]> Co-authored-by: Davis McPhee <[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.
This PR updates the first few pages of the Discover docs:
Rel: https://github.com/elastic/platform-docs-team/issues/500
Closes: #192149
Closes: #162265
Closes: #187417
Note: While there may be more missing features that we want to document, let's first get these updates in.
Note2: If you're wondering where to preview the changes, find the preview link in the Github actions comment and navigate to the "master" version of the Kibana guide.