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

Should we remove/modify some of the experiment tags in the documentation #19798

Closed
colings86 opened this issue Aug 4, 2016 · 8 comments
Closed
Assignees
Labels
>docs General docs changes :Search/Search Search-related issues that do not fall into other categories v7.0.0-beta1

Comments

@colings86
Copy link
Contributor

colings86 commented Aug 4, 2016

Below is a list of the experimental tags that are in the documentation at the time of writing (I've used blame view for the links only so I can skip to the experimental tag in the file). I have added the link to the PR that added the tag and the version it was added in (where I can find it) to each in the list as well as what I think we should do with the tag (remove or keep):

Feature Documentation Link Pull Request Version Added Action
Adjacency Matrix Agg docs/reference/aggregations/bucket/adjacency-matrix-aggregation.asciidoc:9 Beta
Significant Text Agg docs/reference/aggregations/bucket/significanttext-aggregation.asciidoc:4 Keep tag
Analysis-ICU Rules Customisation docs/plugins/analysis-icu.asciidoc:120 #13651 5.0.0-alpha2 Keep Tag - Add note about experimental in Lucene
Matrix Aggregation docs/reference/aggregations/matrix.asciidoc:4 #18300 v5.0.0-alpha4 Keep Tag
Scripted Metric Aggregation docs/reference/aggregations/metrics/scripted-metric-aggregation.asciidoc:4 #7075 v1.4.0-beta1 Keep Tag
Moving Average Pipeline Agg predict param docs/reference/aggregations/pipeline/movavg-aggregation.asciidoc:4 #10024 v2.0.0-beta1 Keep tag
Normalizers docs/reference/analysis/normalizers.asciidoc:4 Beta
Flatten Graph Token Filter docs/reference/analysis/tokenfilters/flatten-graph-tokenfilter.asciidoc:4 Keep tag
Synonym Graph Token Filter docs/reference/analysis/tokenfilters/synonym-graph-tokenfilter.asciidoc:4 Keep tag
Word Delim Graph Token Filter docs/reference/analysis/tokenfilters/word-delimiter-graph-tokenfilter.asciidoc:4 Keep tag
Simple Pattern Tokenizer docs/reference/analysis/tokenizers/simplepattern-tokenizer.asciidoc:4 Keep tag - Lucene
Simple Pattern Split Tokenizer docs/reference/analysis/tokenizers/simplepatternsplit-tokenizer.asciidoc:4 Keep tag - Lucene
Tasks API docs/reference/cluster/tasks.asciidoc:4 Beta
Index Sorting docs/reference/index-modules/index-sorting.asciidoc:4 Beta
index.store.type docs/reference/index-modules/store.asciidoc:35 Keep tag
fixed_auto_queue_size docs/reference/modules/threadpool.asciidoc:97 Keep tag
@colings86 colings86 added >docs General docs changes discuss v5.0.0-beta1 labels Aug 4, 2016
@jpountz
Copy link
Contributor

jpountz commented Aug 4, 2016

Interestingly if I had built the same table, I would probably have the opposite action in most cases. :)

For instance I think the derivative pipeline aggs or the profile flag map to common use-cases (even though in the case of the profile agg we would probably still need a note that the response format may change). I'd probably also wait for pipeline aggs to be exposed in Kibana since that would be a very good test of the usability of pipeline aggs, but this is something I hope we'll be able to do soon.

On the other hand, I don't like exposing options about internals like the terms agg execution hint or percentiles implementation. In the case of percentiles, I am wondering whether we could replace the option with something that characterizes the data or the expected accuracy without being implementation specific and would allow us to pick an impl internally.

@dadoonet dadoonet changed the title Should we remove/modify some of the experiment tags in the docuemntation Should we remove/modify some of the experiment tags in the documentation Aug 5, 2016
@colings86
Copy link
Contributor Author

Discussed in Fix It Friday and have updated the table to reflect what we talked about

@javanna
Copy link
Member

javanna commented May 5, 2017

@colings86 what is left to do here? anything to discuss further?

@colings86
Copy link
Contributor Author

Nothing to discuss further but the items above that have "remove tag" in the action need to have the experimental tag removed

@clintongormley
Copy link

@colings86 we should consider which features should use the beta tag instead (ie we will support this feature and plan to keep it, but the API may change significantly)

clintongormley added a commit that referenced this issue Jul 14, 2017
Relates #19798

Removed experimental label from:
* Painless
* Diversified Sampler Agg
* Sampler Agg
* Significant Terms Agg
* Terms Agg document count error and execution_hint
* Cardinality Agg precision_threshold
* Percentile Agg compression and HDR Histogram
* Percentile Rank Agg HDR Histogram
* Pipeline Aggregations
* index.shard.check_on_startup
* index.store.type (added warning)
* Preloading data into the file system cache
* foreach ingest processor
* Field caps API
* Profile API

Added experimental label to:
* Moving Average Agg Prediction


Changed experimental to beta for:
* Adjacency matrix agg
* Normalizers
* Tasks API
* Index sorting

Labelled experimental in Lucene:
* ICU plugin custom rules file
* Flatten graph token filter
* Synonym graph token filter
* Word delimiter graph token filter
* Simple pattern tokenizer
* Simple pattern split tokenizer
* Analysis explain output format
* Segments verbose output format
clintongormley added a commit that referenced this issue Jul 18, 2017
Relates #19798

Removed experimental label from:
* Painless
* Diversified Sampler Agg
* Sampler Agg
* Significant Terms Agg
* Terms Agg document count error and execution_hint
* Cardinality Agg precision_threshold
* Pipeline Aggregations
* index.shard.check_on_startup
* index.store.type (added warning)
* Preloading data into the file system cache
* foreach ingest processor
* Field caps API
* Profile API

Added experimental label to:
* Moving Average Agg Prediction


Changed experimental to beta for:
* Adjacency matrix agg
* Normalizers
* Tasks API
* Index sorting

Labelled experimental in Lucene:
* ICU plugin custom rules file
* Flatten graph token filter
* Synonym graph token filter
* Word delimiter graph token filter
* Simple pattern tokenizer
* Simple pattern split tokenizer

Replaced experimental label with warning that details may change in the future:
* Analysis explain output format
* Segments verbose output format
* Percentile Agg compression and HDR Histogram
* Percentile Rank Agg HDR Histogram
@clintongormley
Copy link

Updated the table in the description to account for removed tags in #25727

@colings86 colings86 added the :Search/Search Search-related issues that do not fall into other categories label Apr 25, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search-aggs

@colings86
Copy link
Contributor Author

Closing this as its no longer relevant

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.0-beta1
Projects
None yet
Development

No branches or pull requests

6 participants