Skip to content

Integrate large curated data sets into the documentation tests (e.g. Kibana sample data) #51580

Open
@lcawl

Description

@lcawl

Currently the examples in the Elasticsearch documentation are tested using the functionality described here: https://github.com/elastic/elasticsearch/tree/master/docs#snippet-testing

The data that is supplied to the examples is typically a very small data set defined in setup scripts in https://github.com/elastic/elasticsearch/blob/master/docs/build.gradle
Some of our features, however, need large data sets to generate interesting results (or any results at all).

Ideally our documentation testing system should be able to pull in large data sets (e.g. Kibana sample data or other public demo data) that customers also have access to. Ideally those data sets should be easy for folks to find and run on their own deployments. These data sets should also be curated such that they provide meaningful results for one or more features. Otherwise, the API examples just prove the API runs but don’t return anything realistic that customers can explore and learn from.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions