search

elastic / elasticsearch

Free and Open, Distributed, RESTful Search Engine
https://www.elastic.co/products/elasticsearch
Other
69.41k stars 24.56k forks source link

Update Painless Context Examples #47736

Open jdconrad opened 4 years ago

jdconrad commented 4 years ago

The Painless context documentation need new/improved examples on a per context basis as several have been updated/added since the previous examples were created. My suggestions here would be to go with a small data set that doesn't require a download as only a few documents are actually required to illustrate most examples, and to possibly have it as more of a walkthrough style instead of examples spanning across each page of the context docs. The second suggestion is related to the reasoning that it's possible the context docs are auto-generated and moved to core at some point, so it no longer makes sense for Painless to have a page for each context.

elasticmachine commented 4 years ago

Pinging @elastic/es-docs (>docs)

elasticmachine commented 4 years ago

Pinging @elastic/es-core-infra (:Core/Infra/Scripting)

debadair commented 4 years ago

[docs issue triage]

jdconrad commented 4 years ago

So a few more thoughts: 1) I realize that having a large dataset that requires a download was probably poor design on my part. I would replace this with a small subset of docs that can be easily loaded from a copy curl command. 2) I would probably move the examples into a single page and out of the context doc pages so it's more cohesive. 3) I think this could be set up nicely in more of a tutorial-style. 4) The examples should not depend on ingest, they should all be executable individually with just the mappings and docs.

elasticsearchmachine commented 2 years ago

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

elasticsearchmachine commented 2 years ago

Pinging @elastic/es-core-infra (Team:Core/Infra)