opensearch-project / opensearch-project/opensearch-java

[FEATURE] Write a migration guide from HLRC

Open
#1,073 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Is your feature request related to a problem?

We have deprecated and plan to remove HLRC from OpenSearch 3.0 and opensearch-java.

What solution would you like?

A combination of a migration guide added to https://github.com/opensearch-project/opensearch-java/blob/main/USER_GUIDE.md#advanced-features and a blog post about it on for https://opensearch.org/blog/.

Do you have any additional context?

https://opensearch.org/docs/latest/clients/java-rest-high-level/

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

Start by reading USER_GUIDE.md at the Advanced Features section and the linked HLRC documentation. Document the migration from HLRC to opensearch-java there, then prepare the requested blog post for opensearch.org/blog/. Done means both the migration guide and blog post are completed and cover the transition clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
content, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.