Provide a parameters table in each aggregation doc page

[mindrones]

It would be very useful if all aggregation doc pages had a list of parameters like the one in https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-aggregations-bucket-rare-terms-aggregation.html#_syntax. [1]

Right now for most of the aggregations every time we need to inspect the parameters shape we have to look for that info by scrolling a lot ot text. Also sometimes there's no mention of default values or if a parameter is required or not, so having a table like that clearly states it would be really awesome.

As we're doing this anyway, if there is a repository where to provide a PR (elastic/docs maybe?) we'd be glad to help!

[1]

Aggregations to update

Bucket aggregations

• Adjacency matrix [DOCS] Reformat adjacency matrix agg reference #70034
• Auto-interval date histogram
• Children
• Composite
• Date histogram
• Date range
• Diversified sampler
• Filter
• Filters
• Geo-distance
• Geohash grid
• Geotile grid
• Global
• Histogram
• IP range
• Missing
• Nested
• Parent
• Range
• Rare terms
• Reverse nested
• Sampler
• Significant terms
• Significant text
• Terms
• Variable width histogram

Metrics aggregations

• Avg
• Boxplot
• Cardinality
• Extended stats
• Geo-bounds
• Geo-centroid
• Geo-Line
• Matrix stats
• Max
• Median absolute deviation
• Min
• Percentile ranks
• Percentiles
• Rate
• Scripted metric
• Stats
• String stats
• Sum
• T-test
• Top hits
• Top metrics
• Value count
• Weighted avg

Pipeline aggregations

• Avg bucket [DOCS] Reformat avg bucket agg reference #69751
• Bucket script
• Bucket selector
• Bucket sort
• Cumulative cardinality
• Cumulative sum
• Derivative
• Extended stats bucket
• Inference bucket
• Max bucket
• Min bucket
• Moving function
• Moving percentiles
• Normalize
• Percentiles bucket
• Serial differencing
• Stats bucket
• Sum bucket

[elasticmachine]

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

[elasticmachine]

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

[mindrones]

I forgot, it would be useful to have fields sorted alphabetically.

[jrodewig]

Thanks for raising this @mindrones. I'll progressively work on adding these parameter sections to the agg docs. I've updated your issue description with a list of aggregations to update.

As we're doing this anyway, if there is a repository where to provide a PR (elastic/docs maybe?) we'd be glad to help!

Thanks for your interest in contributing! You can find the source .asciidoc files for our docs in the elastic/elasticsearch repo: https://github.com/elastic/elasticsearch/tree/master/docs/reference/aggregations

Please feel free to submit a PR!

[mindrones]

@jrodewig thanks so much for the pointers. More or less we have collected this info for ourselves so it shouldn't take much to transfer that to asciidoc 🍀. I'll open a PR as soon as possible.

[lockewritesdocs]

The creator of this issue is no longer with Elastic and the issue has been stale for over a year. I'm removing the Team:Docs label -- if someone wants to own this from the @elastic/es-analytics-geo team, please take ownership! Otherwise, we can close this issue.

[mitar]

+1 on adding such list.