Skip to content

Commit

Permalink
update developer guide
Browse files Browse the repository at this point in the history
Signed-off-by: Hailong Cui <[email protected]>
  • Loading branch information
Hailong-am committed Sep 5, 2023
1 parent be1df94 commit a6fa82f
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Notifications plugin for OpenSearch enables other plugins to send notifications

## Documentation

Please see our [documentation](https://opendistro.github.io/for-elasticsearch-docs/).
Please see our [documentation](https://opensearch.org/docs/latest/observing-your-data/notifications/index/)

## Setup

1. Check out this package from version control.
1. Launch Intellij IDEA, choose **Import Project**, and select the `settings.gradle` file in the root of this package.
1. To build from the command line, set `JAVA_HOME` to point to a JDK >= 14 before running `./gradlew`.
1. Launch Intellij IDEA, choose **Import Project**, and select the `settings.gradle` file under notifications folder of this package.
1. To build from the command line, set `JAVA_HOME` to point to a JDK >= 11 before running `./gradlew`.

### Setup email notification using localhost email relay/server

Expand Down Expand Up @@ -85,8 +85,8 @@ OR
```

The OpenSearch server JVM will launch suspended and wait for a debugger to attach to `localhost:5005` before starting the OpenSearch server.
The IDE needs to listen for the remote JVM. If using Intellij you must set your debug-configuration to "Listen to remote JVM" and make sure "Auto Restart" is checked.
You must start your debugger to listen for remote JVM before running the commands.
The IDE needs to listen for the remote JVM. If using Intellij you must set your debug-configuration to "Listen to remote JVM" and make sure **"Auto Restart"** is checked.
You must start your debugger to listen for remote JVM **before** running the commands.

To debug code running in an integ test (which exercises the server from a separate JVM), run:

Expand Down Expand Up @@ -130,4 +130,4 @@ See [NOTICE](NOTICE.txt) for more information.

## Copyright

Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.
Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.

0 comments on commit a6fa82f

Please sign in to comment.