opensearch-java icon indicating copy to clipboard operation
opensearch-java copied to clipboard

Add API Guides

Open nhtruong opened this issue 2 years ago • 0 comments

(Spawn off of meta Issue: https://github.com/opensearch-project/opensearch-clients/issues/56) 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.

Each Guide/Article will be a good-first-issue for new contributors to work on. There's already a Ruby version of each article that the articles on this repo should be based upon. Most of the time, we only need to replace the Ruby code blocks with the client code of this repo. Please refer to the meta issue for more details.

  • [x] https://github.com/opensearch-project/opensearch-java/issues/428
  • [ ] https://github.com/opensearch-project/opensearch-java/issues/429
  • [ ] https://github.com/opensearch-project/opensearch-java/issues/430
  • [ ] https://github.com/opensearch-project/opensearch-java/issues/431
  • [x] https://github.com/opensearch-project/opensearch-java/issues/432
  • [x] https://github.com/opensearch-project/opensearch-java/issues/433

nhtruong avatar Apr 04 '23 20:04 nhtruong