doc: apply code review comments

Signed-off-by: Samuel <[email protected]>
opensearch-project · May 20, 2024 · e4c86d6 · e4c86d6
1 parent a55bdbe
commit e4c86d6
Showing 1 changed file with 8 additions and 30 deletions.
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -1,4 +1,4 @@
-  - [Developer Guide](#developer-guide)
+- [Developer Guide](#developer-guide)
   - [Prerequisites](#prerequisites)
   - [Install Docker Image](#install-docker-image)
   - [Running Tests](#running-tests)
@@ -8,36 +8,17 @@
 
 ## Prerequisites
 
-dotnet 6.0 sdk is required
+The .NET 6.0 SDK is required:
 
 ```
 $ dotnet --list-sdks
 6.0.xxx
 ```
 
 
-
-## Install Docker Image
-
-Integration tests require [docker](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/docker/).
-
-Run the following commands to install the docker image:
-
-```
-docker pull opensearchproject/opensearch:latest
-```
-
-Integration tests will auto-start the docker image. To start it manually:
-
-```
-docker run -d -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" opensearchproject/opensearch:latest
-```
-
 ## Running Tests
 
-Tests require a live instance of OpenSearch running in docker.
-
-If you have one running, the build.bat or build.sh commands will run a full run of unit and integration tests.
+The integration tests will download opensearch and run a local cluster for you. To run the full suite of tests, all you need to do is call the below script.
 
 ```
 .\build.bat
@@ -47,17 +28,14 @@ If you have one running, the build.bat or build.sh commands will run a full run
 build.sh
 ```
 
-To run tests in a specific test file.
-
-
-
-Note that integration tests require docker to be installed and running, and downloads quite a bit of data from over the internet and hence take few minutes to complete.
-
-
 ## Client Code Generator
 
 OpenSearch publishes an [OpenAPI specification](https://github.com/opensearch-project/opensearch-api-specification/releases/download/main/opensearch-openapi.yaml) in the [opensearch-api-specification](https://github.com/opensearch-project/opensearch-api-specification) repository, which is used to auto-generate the less interesting parts of the client.
 
 ```
-nox -rs generate
+./build.sh codegen --branch main
+```
+or
+```
+./build.bat codegen --branch main
 ```