elastic / elastic/elasticsearch-py
Add more examples to the documentation
- Dominant language
- Python
- Stars
- 4.4k
- Forks
- 1.2k
- Avg merge
- 17h 17m
- Merged PRs (30d)
- 34
Description
Currently the examples are very limited and mostly limited to search examples. The documentation should be improved to add examples for:
[elasticsearch.client.IndicesClient.put_mapping](https://elasticsearch-py.readthedocs.io/en/latest/api.html?highlight=mapping#elasticsearch.client.IndicesClient.put_mapping)
https://elasticsearch-py.readthedocs.io/en/latest/api.html?highlight=mapping#elasticsearch.client.IndicesClient.put_mapping
https://elasticsearch-py.readthedocs.io/en/master/api.html?highlight=watcher#elasticsearch.client.WatcherClient
Background: just updated my ES 7 to 8 and the python client scripts I had no longer work. After several hours plowing through the documentation I just gave up
Contributor guide
Research direction
Review the existing documentation examples and the linked IndicesClient.put_mapping and WatcherClient API pages first. Add practical examples for those APIs alongside the current search examples, and consider the Elasticsearch 7-to-8 migration context; done means the new examples are clear and rendered in the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elasticsearch, python
- Domain
- documentation, search
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100