Skip to content

Commit

Permalink
Add developer guide (#638)
Browse files Browse the repository at this point in the history
* doc: add skeleton of dev guide

Signed-off-by: Samuel <sam.r.c@hotmail.com>

* doc: do not specify patch version of dotnet

Signed-off-by: Samuel <sam.r.c@hotmail.com>

* doc: remove deleted sections

Signed-off-by: Samuel <sam.r.c@hotmail.com>

* doc: add link to dev guide from readme
Signed-off-by: Samuel <sam.r.c@hotmail.com>

* doc: apply code review comments

Signed-off-by: Samuel <sam.r.c@hotmail.com>

* doc: remove excess lines
Signed-off-by: Samuel <sam.r.c@hotmail.com>

---------

Signed-off-by: Samuel <sam.r.c@hotmail.com>
  • Loading branch information
SamuelCox committed May 27, 2024
1 parent 436df36 commit cdc572f
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
40 changes: 40 additions & 0 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
- [Developer Guide](#developer-guide)
- [Prerequisites](#prerequisites)
- [Install Docker Image](#install-docker-image)
- [Running Tests](#running-tests)
- [Client Code Generator](#client-code-generator)

# Developer Guide

## Prerequisites

The .NET 6.0 SDK is required:

```
$ dotnet --list-sdks
6.0.xxx
```

## Running 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
```

```
build.sh
```

## 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.

```
./build.sh codegen --branch main
```
or
```
./build.bat codegen --branch main
```
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- [OpenSearch.Client](#opensearch-client)
- [Getting Started](#getting-started)
- [Compatibility with OpenSearch](#compatibility-with-opensearch)
- [Developer Guide](#developer-guide)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
- [Copyright](#copyright)
Expand Down Expand Up @@ -55,6 +56,10 @@ See [USER_GUIDE](USER_GUIDE.md) to get started with the .NET client.

See [COMPATIBILITY](COMPATIBILITY.md).

## Developer Guide

See [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md).

## Code of Conduct

This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments.
Expand Down

0 comments on commit cdc572f

Please sign in to comment.