Skip to content

[DOCS] Reformat parent_id query docs#44449

Merged
jrodewig merged 2 commits intoelastic:masterfrom
jrodewig:parent-ids-query
Jul 19, 2019
Merged

[DOCS] Reformat parent_id query docs#44449
jrodewig merged 2 commits intoelastic:masterfrom
jrodewig:parent-ids-query

Conversation

@jrodewig
Copy link
Copy Markdown
Contributor

Rewrites the parent_id query to use the new query format.

This creates separate sections for example requests, parameters, and notes.

This is part of #40977, an effort to standardize documentation for query types.

Before

Before image Parent ID Query - Before

After

After image Parent ID Query - After

@jrodewig jrodewig added >docs General docs changes :Search/Search Search-related issues that do not fall into other categories v8.0.0 v7.0.2 v7.1.2 v7.4.0 v7.3.1 v7.2.2 labels Jul 16, 2019
@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-docs

@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-search

@jrodewig jrodewig changed the title [DOCS] Reformat parent_id query docs [DOCS] Reformat parent_id query docs Jul 16, 2019
field mapping. To see how you can set up an index for the `parent_id` query, try
the following example.

. Create an index with a <<parent-join,join>> field mapping.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

. dot at the beginning of the sentence?
Here and in a couple of places below.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This renders as an ordered list in the HTML output. Here's a screenshot:

Screen Shot 2019-07-19 at 10 35 31 AM

--------------------------------------------------
GET /my_index/_search
----
GET /my-index/_search
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

should we have a unified format in all examples: either put / before index name or not? /my-index/_search -> my-index/_search

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thank you for catching this. I added leading slashes with 647110c.

@jrodewig
Copy link
Copy Markdown
Contributor Author

Thanks again for your review @mayya-sharipova!

@jrodewig jrodewig merged commit 3c92e8e into elastic:master Jul 19, 2019
@jrodewig jrodewig deleted the parent-ids-query branch July 19, 2019 15:03
jrodewig added a commit that referenced this pull request Jul 19, 2019
jrodewig added a commit that referenced this pull request Jul 19, 2019
jrodewig added a commit that referenced this pull request Jul 19, 2019
jrodewig added a commit that referenced this pull request Jul 19, 2019
jrodewig added a commit that referenced this pull request Jul 19, 2019
@jpountz jpountz added v7.3.0 and removed v7.3.1 labels Jul 26, 2019
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 v7.0.2 v7.1.2 v7.2.2 v7.3.0 v7.4.0 v8.0.0-alpha1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants