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] Correct percentile rank agg example responses #50052

Merged
merged 2 commits into from
Dec 12, 2019
Merged

[DOCS] Correct percentile rank agg example responses #50052

merged 2 commits into from
Dec 12, 2019

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Dec 10, 2019

The example snippets in the percentile rank agg docs use a test dataset named latency, which is generated from docs/gradle.build.

At some point the dataset and example snippets were updated, but the text surrounding the snippets was not. This meant the text and the example snippets shown no longer match up.

Because the surrounding text seemed more realistic, this changes the snippets to match using //TESTRESPONSE magic comments.

Let me know if we prefer to create a new example dataset. This just seemed like a simpler, more straightforward solution.

Supersedes/closes #45069, #45985, #48121

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-analytics-geo (:Analytics/Aggregations)

The example snippets in the percentile rank agg docs use a test dataset
named latency, which is generated from docs/gradle.build.

At some point the dataset and example snippets were updated, but the
text surrounding the snippets was not. This meant the text and the
example snippets shown no longer match up.

Because the surrounding text seemed more realistic, this changes the
snippets to match using //TESTRESPONSE magic comments.
@jrodewig
Copy link
Contributor Author

@elasticmachine update branch

Copy link
Contributor

@polyfractal polyfractal left a comment

Choose a reason for hiding this comment

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

LGTM, I think this trickery is fine. A lot easier than trying to craft a new dataset that fits the narrative, and still tests what we want. I like it!

Thanks for fixing this <3

@jrodewig jrodewig merged commit 2d9ee5d into elastic:master Dec 12, 2019
@jrodewig jrodewig deleted the correct-percentile-rank-agg-ex branch December 12, 2019 13:41
jrodewig added a commit that referenced this pull request Dec 12, 2019
The example snippets in the percentile rank agg docs use a test dataset
named `latency`, which is generated from docs/gradle.build.

At some point the dataset and example snippets were updated, but the
text surrounding the snippets was not. This means the text and the
example snippets shown no longer match up.

This corrects that by changing the snippets using /TESTRESPONSE magic comments.
jrodewig added a commit that referenced this pull request Dec 12, 2019
The example snippets in the percentile rank agg docs use a test dataset
named `latency`, which is generated from docs/gradle.build.

At some point the dataset and example snippets were updated, but the
text surrounding the snippets was not. This means the text and the
example snippets shown no longer match up.

This corrects that by changing the snippets using /TESTRESPONSE magic comments.
jrodewig added a commit that referenced this pull request Dec 12, 2019
The example snippets in the percentile rank agg docs use a test dataset
named `latency`, which is generated from docs/gradle.build.

At some point the dataset and example snippets were updated, but the
text surrounding the snippets was not. This means the text and the
example snippets shown no longer match up.

This corrects that by changing the snippets using /TESTRESPONSE magic comments.
@jrodewig
Copy link
Contributor Author

master: 2d9ee5d
7.x: 364eb2d
7.5: c7ff29f
6.8: 3d9f765

SivagurunathanV pushed a commit to SivagurunathanV/elasticsearch that referenced this pull request Jan 23, 2020
The example snippets in the percentile rank agg docs use a test dataset
named `latency`, which is generated from docs/gradle.build.

At some point the dataset and example snippets were updated, but the
text surrounding the snippets was not. This means the text and the
example snippets shown no longer match up.

This corrects that by changing the snippets using /TESTRESPONSE magic comments.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants