[DOCS] Create top-level "Search your data" page #56058
Merged
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
**Goal** Create a top-level search section. This will let us clean up our search API reference docs, particularly content from [`Request body search`][0]. **Changes** * Creates a top-level `Search your data` page. This page is designed to house concept and tutorial docs related to search. * Creates a `Run a search` page under `Search your data`. For now, This contains a basic search tutorial. The goal is to add content from [`Request body search`][0] to this in the future. * Relocates `Long-running searches` and `Search across clusters` under `Search your data`. Increments several headings in that content. * Reorders the top-level TOC to move `Search your data` higher. Also moves the `Query DSL`, `EQL`, and `SQL access` chapters immediately after. Relates to #48194 [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html
jrodewig
added
>docs
|
Pinging @elastic/es-search (:Search/Search) |
|
Pinging @elastic/es-docs (>docs) |
28 tasks
debadair
approved these changes
May 4, 2020
| .*Example* | ||
| [%collapsible] | ||
| ==== | ||
| The following request uses the glob `user_logs*` in place of the index name. |
There was a problem hiding this comment.
This isn't specifically related to this reorg, but I've been wondering about the use of "glob" vs "index pattern". Given the prevalence of index pattern in other contexts, it feels like the glob terminology is potentially confusing. Glob isn't wrong in this context, but I'd be inclined to use index pattern, anyway.
There was a problem hiding this comment.
Solid point. Removed glob and used index pattern throughout. Thanks @debadair!
lockewritesdocs
approved these changes
May 4, 2020
|
|
||
| [WARNING] | ||
| ==== | ||
| If you specify both a query in both the URI and request body, the search API |
There was a problem hiding this comment.
Suggest removing the first "both" to read:
If you specify a query in both the URI and request body...
There was a problem hiding this comment.
Good catch. Fixed with d05ea62.
| } | ||
| ---- | ||
| // TEST[continued] | ||
| ==== |
There was a problem hiding this comment.
The two previous examples have a lead-in sentence that describes the collapsed example. Just noting that this example does not follow that convention.
There was a problem hiding this comment.
I think I'm okay with that in this case. Thanks for raising though!
This was referenced Jun 1, 2020
jrodewig
added a commit
that referenced
this pull request
Jun 1, 2020
**Goal** Create a top-level search section. This will let us clean up our search API reference docs, particularly content from [`Request body search`][0]. **Changes** * Creates a top-level `Search your data` page. This page is designed to house concept and tutorial docs related to search. * Creates a `Run a search` page under `Search your data`. For now, This contains a basic search tutorial. The goal is to add content from [`Request body search`][0] to this in the future. * Relocates `Long-running searches` and `Search across clusters` under `Search your data`. Increments several headings in that content. * Reorders the top-level TOC to move `Search your data` higher. Also moves the `Query DSL`, `EQL`, and `SQL access` chapters immediately after. Relates to #48194 [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html
jrodewig
added a commit
that referenced
this pull request
Jun 1, 2020
**Goal** Create a top-level search section. This will let us clean up our search API reference docs, particularly content from [`Request body search`][0]. **Changes** * Creates a top-level `Search your data` page. This page is designed to house concept and tutorial docs related to search. * Creates a `Run a search` page under `Search your data`. For now, This contains a basic search tutorial. The goal is to add content from [`Request body search`][0] to this in the future. * Relocates `Long-running searches` and `Search across clusters` under `Search your data`. Increments several headings in that content. * Reorders the top-level TOC to move `Search your data` higher. Also moves the `Query DSL`, `EQL`, and `SQL access` chapters immediately after. Relates to #48194 [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html
jrodewig
added a commit
that referenced
this pull request
Jun 1, 2020
**Goal** Create a top-level search section. This will let us clean up our search API reference docs, particularly content from [`Request body search`][0]. **Changes** * Creates a top-level `Search your data` page. This page is designed to house concept and tutorial docs related to search. * Creates a `Run a search` page under `Search your data`. For now, This contains a basic search tutorial. The goal is to add content from [`Request body search`][0] to this in the future. * Relocates `Long-running searches` and `Search across clusters` under `Search your data`. Increments several headings in that content. * Reorders the top-level TOC to move `Search your data` higher. Also moves the `Query DSL`, `EQL`, and `SQL access` chapters immediately after. Relates to #48194 [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html
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.
Goal
Create a top-level search section. This will let us clean up our search
API reference docs, particularly content from
Request body search.Changes
Creates a top-level
Search your datapage. This page is designed tohouse concept and tutorial docs related to search.
Creates a
Run a searchpage underSearch your data. For now, Thiscontains a basic search tutorial. The goal is to add content from
Request body searchto this in the future.Relocates
Long-running searchesandSearch across clustersunderSearch your data. Increments several headings in that content.Reorders the top-level TOC to move
Search your datahigher. Alsomoves the
Query DSL,EQL, andSQL accesschapters immediatelyafter.
Relates to #48194
As this effort will likely involve several redirects, I plan to merge this to
masteronly.