docs: add Getting Started section#5277
Open
dahlinomine wants to merge 1 commit intoopensearch-project:mainfrom
Open
docs: add Getting Started section#5277dahlinomine wants to merge 1 commit intoopensearch-project:mainfrom
dahlinomine wants to merge 1 commit intoopensearch-project:mainfrom
Conversation
dahlinomine
requested review from
LantaoJin,
RyanL1997,
Swiddis,
acarbonetto,
ahkcs,
anirudha,
dai-chen,
joshuali925,
mengweieric,
noCharger,
penghuo,
ps48,
qianheng-aws,
songkant-aws,
vamsimanohar,
ykmr1224 and
yuancu
as code owners
Contributor
|
Failed to generate code suggestions for PR |
penghuo
reviewed
Apr 7, 2026
| ## Highlights | ||
|
|
||
| Copyright OpenSearch Contributors. See [NOTICE](./NOTICE) for details. | ||
| ... (rest of the sections) No newline at end of file |
| ## Forum | ||
|
|
||
| For additional help with the plugin, including questions about opening an issue, visit the OpenSearch [Forum](https://forum.opensearch.org/c/plugins/sql/8). | ||
| ## Getting Started |
Collaborator
There was a problem hiding this comment.
Adding getting Getting Started section looks good.
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
2 participants
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
This PR improves the README documentation for this project.
Changes: Add getting started section
This contribution was made as part of an open-source documentation improvement initiative. All changes are meant to be helpful additions to the project.