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] Adds missing_bucket setting to transform APIs #90111

Merged
merged 6 commits into from
Sep 19, 2022

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Sep 15, 2022

Overview

Related to: #42941

This PR adds the missing_bucket setting to the transform group_by property. It also amends the example API call for PUT transform to demonstrate how to use missing_bucket.

Preview

PUT transform

@szabosteve szabosteve added >docs General docs changes :ml Machine learning :ml/Transform Transform Team:Docs Meta label for docs team auto-backport Automatically create backport pull requests when merged v8.1.4 v8.2.3 v8.3.4 v8.5.0 v7.17.7 v8.4.3 labels Sep 15, 2022
@github-actions
Copy link
Contributor

Documentation preview:

@szabosteve szabosteve changed the title [DOCS] Adds missing_bucket setting to transform APIs. [DOCS] Adds missing_bucket setting to transform APIs Sep 15, 2022
@szabosteve szabosteve marked this pull request as ready for review September 15, 2022 16:11
@elasticsearchmachine elasticsearchmachine added the Team:ML Meta label for the ML team label Sep 15, 2022
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/ml-core (Team:ML)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@hendrikmuhs
Copy link

With this change missing_bucket is listed as Properties of group_by, but that is one level higher, missing_bucket is a property of terms, date_histogram, histogram or geotile_grid. We are just linking those and missing_bucket is documented there. This is a problem, I fully agree that we should promote missing_bucket or at least document that per default groupings without a value are ignored. Can we do this in the description of group_by?

@szabosteve
Copy link
Contributor Author

@hendrikmuhs Thanks for the clarification. In the meantime, I also realized that the property was a level "higher" than it should. I was thinking a bit about where to document it; to add it to the group by description or to add a note somewhere else. Finally, I've added two extra sentences to the group_by description I think that's the most obvious place to put it. Let me know if you think we should modify anything.
(Addressed in 1270bee.)

Copy link

@hendrikmuhs hendrikmuhs left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks @szabosteve

@elasticsearchmachine
Copy link
Collaborator

💔 Backport failed

Status Branch Result
8.1
8.2
8.3
7.17 Commit could not be cherrypicked due to conflicts
8.4

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 90111

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes :ml/Transform Transform :ml Machine learning Team:Docs Meta label for docs team Team:ML Meta label for the ML team v7.17.7 v8.1.4 v8.2.3 v8.3.4 v8.4.3 v8.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants