docs: rewrite README for open-source clarity#36
Merged
Conversation
Remove decorative emoji headings, trim marketing language, and consolidate duplicated configuration/usage examples. Fix a couple of sample snippets that no longer matched the current dependency versions (a nonexistent CurlRequest#url() call, and TotalHits#value being a record accessor rather than a field in the bundled Lucene version). Add a table of the OpenSearch/Elasticsearch versions actually covered by the integration test suite.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CurlRequest#url()call that does not exist, andTotalHits#valuefield access, which is now the record accessorvalue()in the Lucene version bundled with OpenSearch 3.7.0Test plan
TotalHits.value()andCreateIndexResponse.index()signatures against theopensearch-3.7.0/lucene-core-10.4.0jarsCurlRequest#header(String, String)andHttpClient#addRequestBuilder(UnaryOperator<CurlRequest>)against thecurl4jsources