-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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.
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
[DOCS] Move search API's docvalue_fields
examples
#57760
[DOCS] Move search API's docvalue_fields
examples
#57760
Conversation
Changes: * Condenses and relocates the `docvalue_fields` example to the 'Search fields' section of the 'Run a search' page. * Adds docs for the `docvalue_fields` request body parameter. * Updates several related xrefs.
Pinging @elastic/es-docs (>docs) |
Pinging @elastic/es-search (:Search/Search) |
docvalue_fields
docsdocvalue_fields
examples
I overall liked having separate sections for source filtering and docvalue fields, I'm worried it makes it harder to grasp the overall summary if there are detailed reference examples embedded throughout. For comparison, the 'paginate search results' section has outgoing links to 'scroll' and 'search_after'. Perhaps we could add subsections below the top-level summary and move this content there? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with @jtibshirani--I think separate sub sections for source filtering and doc values would make this a bit easier to digest. As it is, it really puts the emphasis on source filtering over doc values.
Thanks for the feedback @debadair and @jtibshirani. I've made some changes based on your feedback, including breaking out separate collapsible sections for source filtering, doc value fields, and stored fields. You can check out the changes in this preview: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @jrodewig for the iteration. I took a look at the latest version, and feel like it omits the high-level guidance on how to choose an option. When I added the section #57500, here is the guidance I was trying to convey:
- For retrieving specific fields, source filtering is the right default approach.
- Depending on what limitations you encounter, you may want to try a different approach:
docvalue_fields
, if the number of fields to retrieve is small and all fields support doc values, otherwisestored_fields
as a last expert option
What if we kept the full guidance paragraph, but then had subsections below it for 'source filtering' and 'doc values fields' if the user needs wants detail on each option?
Thanks for the feedback @jtibshirani. I incorporated most of your suggestions. One exception is that I left the xref in the existing doc values section of the search request body API docs page. Because it's an anchor on the page and not a page itself, I can't set up a redirect for it. However, I don't want users that go to that page to wonder where those docs went. Once we're able to remove the search request body page, I'll be able to set up a redirect and remove that xref. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! I just had one comment about restoring a sentence I was attached to :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made a few minor suggestions, but the changes address the main concerns. Thanks!
Co-authored-by: debadair <debadair@elastic.co>
🙇 Thanks so much for your help in getting this over the finish line @debadair and @jtibshirani. I greatly appreciate it. |
Changes: * Condenses and relocates the `docvalue_fields` example to the 'Run a search' page. * Adds docs for the `docvalue_fields` request body parameter. * Updates several related xrefs. Co-authored-by: debadair <debadair@elastic.co>
Changes: * Condenses and relocates the `docvalue_fields` example to the 'Run a search' page. * Adds docs for the `docvalue_fields` request body parameter. * Updates several related xrefs. Co-authored-by: debadair <debadair@elastic.co>
Changes: * Condenses and relocates the `docvalue_fields` example to the 'Run a search' page. * Adds docs for the `docvalue_fields` request body parameter. * Updates several related xrefs. Co-authored-by: debadair <debadair@elastic.co>
Changes:
docvalue_fields
example to the 'Search fields'section of the 'Run a search' page.
docvalue_fields
request body parameter.Relates to #48194