opensearch-project / opensearch-clients

For all things about OpenSearch clients.
Apache License 2.0
9 stars 10 forks source link

User's Guides covering major usecases and sample code for all Clients #56

Open nhtruong opened 1 year ago

nhtruong commented 1 year ago

As brought up in this issue, to help drive adoption of OpenSearch, and improve user's experience, we're working on adding more documentation for all clients. One of the strategies mentioned in said issue is writing a collection of articles serving as a User's Guide for each client. This issue will serve as a hub for all issues related to this topic. The hub will keep track of the progress and assure that every repo has a consistent set of articles.

Conventions

Topics

Below is a list of topic titles, file names, link to the Ruby version of each guide, along with the endpoints that they cover. More topics will be added over time. Feel free to suggest new topics in the comment.

dblock commented 1 year ago
nhtruong commented 1 year ago

@dblock regarding docs, we're already using it for method documentation in a few repos. Plus these articles will be referenced in USER_GUIDE.md as extensions to the base guide.