opensearch-project / opensearch-project/opensearch-java

[Guide] Advanced Index Actions

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

Nobody has claimed this yet.

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

Description

Create guides/advanced_index_actions.md similar to the Ruby guide

You must assure that:

  • All code-blocks, when run from start to finish in order they appear in the guide, do not throw any errors. If you want to demonstrate that certain statements will throw errors, they must be wrapped in a try/catch and print out the expected error.
  • All code-blocks are properly marked with the language it's written in (i.e. ```ruby)
  • The instructions, though mostly identical to the Ruby guide, are suitable for this repo.

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

Create guides/advanced_index_actions.md using the Ruby guide at the linked reference as the starting point. Read the repository's Java client usage patterns, then check every code block in order by running it from start to finish and verify each block has an appropriate language marker. Done means the guide is suitable for this repository and all examples either run without errors or explicitly catch and print expected errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.