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.

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

Merged
merged 23 commits into from
Jun 11, 2020
Merged

[DOCS] Move search API's docvalue_fields examples #57760

merged 23 commits into from
Jun 11, 2020

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Jun 5, 2020

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.

Relates to #48194

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.
@jrodewig jrodewig added >docs General docs changes :Search/Search Search-related issues that do not fall into other categories v8.0.0 v7.8.1 v7.9.0 v7.7.2 labels Jun 5, 2020
@jrodewig jrodewig requested a review from debadair June 5, 2020 18:47
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Jun 5, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search (:Search/Search)

@elasticmachine elasticmachine added the Team:Search Meta label for search team label Jun 5, 2020
@jrodewig jrodewig mentioned this pull request Jun 5, 2020
28 tasks
@jrodewig jrodewig changed the title [DOCS] Rearrange search API's docvalue_fields docs [DOCS] Move search API's docvalue_fields examples Jun 5, 2020
@jtibshirani
Copy link
Contributor

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?

Copy link
Contributor

@debadair debadair left a 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.

docs/reference/search/search-fields.asciidoc Outdated Show resolved Hide resolved
@jrodewig
Copy link
Contributor Author

jrodewig commented Jun 9, 2020

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:
https://elasticsearch_57760.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/run-a-search.html#search-fields

@jrodewig jrodewig requested a review from debadair June 9, 2020 19:12
Copy link
Contributor

@jtibshirani jtibshirani left a 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, otherwise
    • stored_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?

docs/reference/search/search-fields.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-fields.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-fields.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-fields.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-fields.asciidoc Outdated Show resolved Hide resolved
@jrodewig
Copy link
Contributor Author

jrodewig commented Jun 9, 2020

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.

Copy link
Contributor

@jtibshirani jtibshirani left a 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 :)

docs/reference/search/search-fields.asciidoc Show resolved Hide resolved
docs/reference/search/search-fields.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@debadair debadair left a 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!

docs/reference/search/search-fields.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-fields.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-fields.asciidoc Outdated Show resolved Hide resolved
docs/reference/search/search-fields.asciidoc Outdated Show resolved Hide resolved
@jrodewig
Copy link
Contributor Author

🙇 Thanks so much for your help in getting this over the finish line @debadair and @jtibshirani. I greatly appreciate it.

@jrodewig jrodewig merged commit 7826bbe into elastic:master Jun 11, 2020
@jrodewig jrodewig deleted the docs__move-docvalue-field-ex branch June 11, 2020 14:57
jrodewig added a commit that referenced this pull request Jun 11, 2020
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>
jrodewig added a commit that referenced this pull request Jun 11, 2020
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>
jrodewig added a commit that referenced this pull request Jun 11, 2020
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>
@jrodewig
Copy link
Contributor Author

Backport commits

master 7826bbe
7.x d534862
7.8 bfe7850
7.7 cb403a6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Search/Search Search-related issues that do not fall into other categories Team:Docs Meta label for docs team Team:Search Meta label for search team v7.7.2 v7.8.1 v7.9.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants