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

Make README examples copy-paste runnable #195

Open
jameslamb opened this issue Oct 24, 2019 · 0 comments
Open

Make README examples copy-paste runnable #195

jameslamb opened this issue Oct 24, 2019 · 0 comments

Comments

@jameslamb
Copy link
Collaborator

Currently, there are some examples in README.md with Elasticsearch queries and corresponding uptasticsearch code. That code is effectively pseudocode right now, as it references a fictional Elasticsearch cluster.

I think this could lead to a bad experience with the docs and lead people to walk away from the project and not come back.

I would love if someone changed those examples to be runnable completely copy-paste with no editing. This project supports the ability to run Elasticsearch locally in a Docker, seeded with a sample dataset that has a few lines from some Shakespeare play.

To run ES 7.3.x locally, you can just run

./setup_local.sh 7.3

You can find example code that works with this dataset in the R package's unit tests.

We would welcome one PR for the R package (the highest priority) and then a separate PR for the Python package.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant