opensearch-project / opensearch-project/opensearch-java

Add API Guides

Open
#434 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
Java
Stars
165
Forks
250
Avg merge
1d 18h
Merged PRs (30d)
26

Description

(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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin with the meta issue #56 and review the remaining unchecked Java guide issues, #429 and #430, using the completed guide issues as scope references. Done means adding the remaining client User's Guide articles described there, with Java examples replacing the Ruby examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.