Updated Developer Guide #16
Merged
Conversation
This file contains 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
Signed-off-by: Joshua Palis <jpalis@amazon.com>
…ether Signed-off-by: Joshua Palis <jpalis@amazon.com>
owaiskazi19
reviewed
Jun 16, 2022
DEVELOPER_GUIDE.md
Outdated
|
|
||
| Run main script using `gradlew run`. | ||
| ## Publish OpenSearch feature/extensions Branch to Maven local | ||
| The work done to support the extensions framework is located on the `Feature/Extensions` branch of the OpenSearch project. It is necessary to publish the dependencies of this branch to your local maven repository prior to running the extension on a seperate process. In order to do this, first navigate to the directory that OpenSearch has been cloned to, checkout the correct branch, e.g. `git checkout feature/extensions`. Then run `./gradlew publishToMavenLocal`. It is necessary to publish dependencies to a local maven repository until this branch is merged to `main`, at which point all dependencies will be published to Maven central. |
There was a problem hiding this comment.
Can we mention these steps in bullet format for better readability?
Something like with more details for each point:
- Clone OpenSearch
git clonehttps://github.com/[your username]/OpenSearch.git``. - cd OpenSearch
git checkout feature/extensions- Publish dependencies to mavenLocal using
./gradlew publishToMavenLocal
There was a problem hiding this comment.
Feature/Extensions -> feature/extensions
owaiskazi19
reviewed
Jun 16, 2022
DEVELOPER_GUIDE.md
Outdated
| - [Git Clone OpenSearch-SDK Repo](#git-clone-OpenSearch-SDK-repo) | ||
| - [Git Clone OpenSearch Repo](#git-clone-opensearch-repo) | ||
| - [Publish OpenSearch Feature/Extensions branch to Maven local](#publish-opensearch-feature/extensions-branch-to-maven-local) | ||
| - [Run Extension](#run-extension) |
owaiskazi19
reviewed
Jun 16, 2022
DEVELOPER_GUIDE.md
Outdated
| ## Publish OpenSearch feature/extensions Branch to Maven local | ||
| The work done to support the extensions framework is located on the `Feature/Extensions` branch of the OpenSearch project. It is necessary to publish the dependencies of this branch to your local maven repository prior to running the extension on a seperate process. In order to do this, first navigate to the directory that OpenSearch has been cloned to, checkout the correct branch, e.g. `git checkout feature/extensions`. Then run `./gradlew publishToMavenLocal`. It is necessary to publish dependencies to a local maven repository until this branch is merged to `main`, at which point all dependencies will be published to Maven central. | ||
|
|
||
| ### Run Extension |
owaiskazi19
reviewed
Jun 16, 2022
DEVELOPER_GUIDE.md
Outdated
|
|
||
| ### Run Extension | ||
|
|
||
| Navigate to the directory that OpenSearch-SDK has been cloned to and run main script using `gradlew run`. |
Signed-off-by: Joshua Palis <jpalis@amazon.com>
Signed-off-by: Joshua Palis <jpalis@amazon.com>
owaiskazi19
reviewed
Jun 16, 2022
|
|
||
| - First navigate to the directory that OpenSearch has been cloned to | ||
| - Checkout the correct branch, e.g. `git checkout feature/extensions`. | ||
| - Run `./gradlew publishToMavenLocal`. |
There was a problem hiding this comment.
The next step should be run ./gradlew check to make sure the build is successful
Signed-off-by: Joshua Palis <jpalis@amazon.com>
owaiskazi19
reviewed
Jun 16, 2022
DEVELOPER_GUIDE.md
Outdated
| @@ -46,7 +64,7 @@ Run tests : | |||
|
|
|||
| ### Send Message using Telnet | |||
There was a problem hiding this comment.
Instead of telnet should we mention about running OpenSearch in another terminal as this was written before the connection was established?
…/process. Added example logs of TCP handshake and plugin name request responses Signed-off-by: Joshua Palis <jpalis@amazon.com>
owaiskazi19
approved these changes
Jun 16, 2022
saratvemulapalli
approved these changes
Jun 16, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.