Format markdown files with prettier 2.8.6 (opensearch-project#258)

- Ran `npx prettier -w *.md` and committed the results. Signed-off-by: Harrison Jones <harrison@hhj.me>
VachaShah · Mar 22, 2023 · 5c62768 · 5c62768
1 parent 6bcda60
commit 5c62768
Show file tree

Hide file tree

Showing 11 changed files with 86 additions and 75 deletions.
diff --git a/ADMINS.md b/ADMINS.md
@@ -4,19 +4,20 @@
   - [Prioritize Security](#prioritize-security)
   - [Enforce Code of Conduct](#enforce-code-of-conduct)
   - [Adopt Organizational Best Practices](#adopt-organizational-best-practices)
+
 ## Overview
 
 This document explains who the admins are (see below), what they do in this repo, and how they should be doing it. If you're interested in becoming a maintainer, see [MAINTAINERS](MAINTAINERS.md). If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Current Admins
 
-| Admin                    | GitHub ID                               | Affiliation |
-| -------------------------| --------------------------------------- | ----------- |
-| Charlotte                | [CEHENKLE](https://github.com/CEHENKLE) | Amazon |
-| Henri Yandell            | [hyandell](https://github.com/hyandell) | Amazon      |
-| Jack Mazanec             | [jmazanec15](https://github.com/jmazanec15) | Amazon |
-| Vamshi Vijay Nakkirtha   | [vamshin](https://github.com/vamshin)   |   Amazon    |
-| Vijayan Balasubramanian  | [VijayanB](https://github.com/VijayanB) |   Amazon    |
+| Admin                   | GitHub ID                                   | Affiliation |
+| ----------------------- | ------------------------------------------- | ----------- |
+| Charlotte               | [CEHENKLE](https://github.com/CEHENKLE)     | Amazon      |
+| Henri Yandell           | [hyandell](https://github.com/hyandell)     | Amazon      |
+| Jack Mazanec            | [jmazanec15](https://github.com/jmazanec15) | Amazon      |
+| Vamshi Vijay Nakkirtha  | [vamshin](https://github.com/vamshin)       | Amazon      |
+| Vijayan Balasubramanian | [VijayanB](https://github.com/VijayanB)     | Amazon      |
 
 ## Admin Responsibilities
 
@@ -34,4 +35,4 @@ Act on [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) violations by revoking access, and
 
 ### Adopt Organizational Best Practices
 
-Adopt organizational best practices, work in the open, and collaborate with other admins by opening issues before making process changes. Prefer consistency, and avoid diverging from practices in the opensearch-project organization.
+Adopt organizational best practices, work in the open, and collaborate with other admins by opening issues before making process changes. Prefer consistency, and avoid diverging from practices in the opensearch-project organization.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,11 @@
 # CHANGELOG
+
 Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## [Unreleased]
+
 ### Dependencies
+
 - Bumps `github.com/aws/aws-sdk-go-v2` from 1.17.1 to 1.17.6
 - Bumps `github.com/aws/aws-sdk-go-v2/config` from 1.18.10 to 1.18.18
 - Bumps `github.com/aws/aws-sdk-go-v2/config` from 1.18.9 to 1.18.12
@@ -16,28 +19,32 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Bumps `github.com/stretchr/testify` from 1.8.1 to 1.8.2
 
 ### Added
+
 - Github workflow for changelog verification ([#172](https://github.com/opensearch-project/opensearch-go/pull/172))
 - Add Go Documentation link for the client ([#182](https://github.com/opensearch-project/opensearch-go/pull/182))
 - Support for Amazon OpenSearch Serverless ([#216](https://github.com/opensearch-project/opensearch-go/pull/216), [#259](https://github.com/opensearch-project/opensearch-go/pull/259))
 
 ### Dependencies
+
 - Bumps `github.com/stretchr/testify` from 1.8.0 to 1.8.1
 - Bumps `github.com/aws/aws-sdk-go` from 1.44.45 to 1.44.132
 
 ### Changed
+
 - Workflow improvements ([#242](https://github.com/opensearch-project/opensearch-go/pull/242))
 
 ### Deprecated
 
 ### Removed
+
 - Remove info call before performing every request ([#219](https://github.com/opensearch-project/opensearch-go/pull/219))
 
 ### Fixed
- - Renamed the sequence number struct tag to if_seq_no to fix optimistic concurrency control ([#166](https://github.com/opensearch-project/opensearch-go/pull/166))
- - Fix `RetryOnConflict` on bulk indexer ([#215](https://github.com/opensearch-project/opensearch-go/pull/215))
- - Correct curl logging to emit the correct URL destination ([#101](https://github.com/opensearch-project/opensearch-go/pull/101))
 
-### Security
+- Renamed the sequence number struct tag to if_seq_no to fix optimistic concurrency control ([#166](https://github.com/opensearch-project/opensearch-go/pull/166))
+- Fix `RetryOnConflict` on bulk indexer ([#215](https://github.com/opensearch-project/opensearch-go/pull/215))
+- Correct curl logging to emit the correct URL destination ([#101](https://github.com/opensearch-project/opensearch-go/pull/101))
 
+### Security
 
-[Unreleased]: https://github.com/opensearch-project/opensearch-go/compare/2.1...HEAD
+[Unreleased]: https://github.com/opensearch-project/opensearch-go/compare/2.1...HEAD
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,25 +1,22 @@
-
 This code of conduct applies to all spaces provided by the OpenSource project including in code, documentation, issue trackers, mailing lists, chat channels, wikis, blogs, social media and any other communication channels used by the project.
 
-
 **Our open source communities endeavor to:**
 
-* Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language.
-* Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute.
-* Be Respectful: We are committed to encouraging differing viewpoints, accepting constructive criticism and work collaboratively towards decisions that help the project grow. Disrespectful and unacceptable behavior will not be tolerated.
-* Be Collaborative: We are committed to supporting what is best for our community and users. When we build anything for the benefit of the project, we should document the work we do and communicate to others on how this affects their work.
-
+- Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language.
+- Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute.
+- Be Respectful: We are committed to encouraging differing viewpoints, accepting constructive criticism and work collaboratively towards decisions that help the project grow. Disrespectful and unacceptable behavior will not be tolerated.
+- Be Collaborative: We are committed to supporting what is best for our community and users. When we build anything for the benefit of the project, we should document the work we do and communicate to others on how this affects their work.
 
 **Our Responsibility. As contributors, members, or bystanders we each individually have the responsibility to behave professionally and respectfully at all times. Disrespectful and unacceptable behaviors include, but are not limited to:**
 
-* The use of violent threats, abusive, discriminatory, or derogatory language;
-* Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
-* Posting of sexually explicit or violent content;
-* The use of sexualized language and unwelcome sexual attention or advances;
-* Public or private harassment of any kind;
-* Publishing private information, such as physical or electronic address, without permission;
-* Other conduct which could reasonably be considered inappropriate in a professional setting;
-* Advocating for or encouraging any of the above behaviors.
-* Enforcement and Reporting Code of Conduct Issues:
+- The use of violent threats, abusive, discriminatory, or derogatory language;
+- Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
+- Posting of sexually explicit or violent content;
+- The use of sexualized language and unwelcome sexual attention or advances;
+- Public or private harassment of any kind;
+- Publishing private information, such as physical or electronic address, without permission;
+- Other conduct which could reasonably be considered inappropriate in a professional setting;
+- Advocating for or encouraging any of the above behaviors.
+- Enforcement and Reporting Code of Conduct Issues:
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be reported. [Contact us](mailto:opensource-codeofconduct@amazon.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md
@@ -6,14 +6,14 @@
 The below matrix shows the compatibility of the [`opensearch-go`](https://pkg.go.dev/github.com/opensearch-project/opensearch-go) with versions of [`OpenSearch`](https://opensearch.org/downloads.html#opensearch).
 
 | Client Version | OpenSearch Version |
-| --- | --- |
-| 1.0.0 | 1.0.0-1.0.1 |
-| 1.1.0 | 1.1.0-1.3.1 |
-| 2.0.0 | 2.0.0-2.1.0 |
-| 2.0.1 | 2.0.0-2.1.0 |
-| 2.1.0 | 2.0.0-2.5.0 |
-| 2.2.0 | 2.0.0-2.5.0 |
+| -------------- | ------------------ |
+| 1.0.0          | 1.0.0-1.0.1        |
+| 1.1.0          | 1.1.0-1.3.1        |
+| 2.0.0          | 2.0.0-2.1.0        |
+| 2.0.1          | 2.0.0-2.1.0        |
+| 2.1.0          | 2.0.0-2.5.0        |
+| 2.2.0          | 2.0.0-2.5.0        |
 
 ## Upgrading
 
-Major versions of OpenSearch introduce breaking changes that require careful upgrades of the client. While `opensearch-go-client` 2.0.0 works against the latest OpenSearch 1.x, certain deprecated features removed in OpenSearch 2.0 have also been removed from the client. Please refer to the [OpenSearch documentation](https://opensearch.org/docs/latest/clients/index/) for more information.
+Major versions of OpenSearch introduce breaking changes that require careful upgrades of the client. While `opensearch-go-client` 2.0.0 works against the latest OpenSearch 1.x, certain deprecated features removed in OpenSearch 2.0 have also been removed from the client. Please refer to the [OpenSearch documentation](https://opensearch.org/docs/latest/clients/index/) for more information.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -17,7 +17,7 @@ OpenSearch is a community project that is built and maintained by people just li
 
 1. **When in doubt, open an issue** - For almost any type of contribution, the first step is opening an issue. Even if you think you already know what the solution is, writing down a description of the problem you're trying to solve will help everyone get context when they review your pull request. If it's truly a trivial change (e.g. spelling error), you can skip this step -- but as the subject says, when it doubt, [open an issue](https://github.com/opensearch-project/opensearch-go/issues/new/choose).
 
-2. **Only submit your own work**  (or work you have sufficient rights to submit) - Please make sure that any code or documentation you submit is your work or you have the rights to submit. We respect the intellectual property rights of others, and as part of contributing, we'll ask you to sign your contribution with a "Developer Certificate of Origin" (DCO) that states you have the rights to submit this work and you understand we'll use your contribution. There's more information about this topic in the [DCO section](#developer-certificate-of-origin).
+2. **Only submit your own work** (or work you have sufficient rights to submit) - Please make sure that any code or documentation you submit is your work or you have the rights to submit. We respect the intellectual property rights of others, and as part of contributing, we'll ask you to sign your contribution with a "Developer Certificate of Origin" (DCO) that states you have the rights to submit this work and you understand we'll use your contribution. There's more information about this topic in the [DCO section](#developer-certificate-of-origin).
 
 ## Ways to Contribute
 
@@ -35,7 +35,6 @@ If you've upgraded to the latest version and you can't find it in our open issue
 
 If you've thought of a way that OpenSearch could be better, we want to hear about it. We track feature requests using GitHub, so please feel free to open an issue which describes the feature you would like to see, why you need it, and how it should work.
 
-
 ### Contributing Code
 
 As with other types of contributions, the first step is to [open an issue on GitHub](https://github.com/opensearch-project/opensearch-go/issues/new/choose). Opening an issue before you make changes makes sure that someone else isn't already working on that particular problem. It also lets us all work together to find the right approach before you spend a bunch of time on a PR. So again, when in doubt, open an issue.
@@ -75,7 +74,7 @@ By making a contribution to this project, I certify that:
     sign-off) is maintained indefinitely and may be redistributed
     consistent with this project or the open source license(s)
     involved.
- ```
+```
 
 We require that every contribution to OpenSearch is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms.
 
@@ -93,12 +92,12 @@ OpenSearch-go maintains a version specific changelog by enforcing a change to th
 
 The changes are curated by version, with the changes to the main branch added chronologically to the `Unreleased` version. Each version has corresponding sections which list out the category of the change - `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`.
 
-
 ### Adding Changes
 
 As a contributor, you must ensure that every pull request has its changes listed out within the corresponding version and appropriate section of the [CHANGELOG](CHANGELOG.md) file.
 
 Adding in the change is a two step process -
+
 1. Add your changes to the corresponding section within the CHANGELOG file with dummy pull request information, publish the PR.
 
 2. Update the entry for your change in [`CHANGELOG.md`](CHANGELOG.md) and make sure that you reference the pull request there.

diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -9,9 +9,10 @@
       - [Execute integration tests from your terminal](#execute-integration-tests-from-your-terminal)
   - [Use an Editor](#use-an-editor)
     - [GoLand](#goland)
+
 # Developer Guide
 
-So you want to contribute code to the OpenSearch Go Client?  Excellent!  We're glad you're here.  Here's what you need to do:
+So you want to contribute code to the OpenSearch Go Client? Excellent! We're glad you're here. Here's what you need to do:
 
 ## Getting Started
 
@@ -23,26 +24,31 @@ e.g. `git clone https://github.com/[your username]/opensearch-go.git`.
 ### Install Prerequisites
 
 #### Go 1.11
+
 OpenSearch Go Client builds using [Go](https://golang.org/doc/install) 1.11 at a minimum.
 
 #### Docker
 
 [Docker](https://docs.docker.com/install/) is required for building some OpenSearch artifacts and executing integration tests.
 
 ### Unit Testing
+
 Go has a simple tool for running tests, and we simplified it further by creating this make command:
- ```
+
+```
 make test-unit
 ```
- 
+
 Individual unit tests can be run with the following command:
+
 ```
 cd folder-path/to/test;
-go test -v -run TestName; 
+go test -v -run TestName;
 ```
 
 ### Integration Testing
-In order to test opensearch-go client, you need a running OpenSearch cluster. You can use Docker to accomplish this. 
+
+In order to test opensearch-go client, you need a running OpenSearch cluster. You can use Docker to accomplish this.
 The [Docker Compose file](.ci/opensearch/docker-compose.yml) supports the ability to run integration tests for the project in local environments.
 If you have not installed docker-compose, you can install it from this [link](https://docs.docker.com/compose/install/).
 
@@ -51,6 +57,7 @@ with [build tags](https://pkg.go.dev/cmd/go#hdr-Build_constraints). The build ta
 Hence, create all integration tests with build tag 'integration'.
 
 #### Execute integration tests from your terminal
+
 1. Run below command to start containers. By default, it will launch latest OpenSearch cluster.
    ```
    make cluster.build cluster.start
@@ -63,14 +70,16 @@ Hence, create all integration tests with build tag 'integration'.
    ```
    make cluster.stop cluster.clean
    ```
+
 ## Use an Editor
 
 ### GoLand
+
 You can import the OpenSearch project into GoLand as follows:
 
 1. Select **File | Open**
 2. In the subsequent dialog navigate to the ~/go/src/opensearch-go and click **Open**
 
 After you have opened your project, you need to specify the location of the Go SDK.
-You can either specify a local path to the SDK or download it. To set the Go SDK, navigate to **Go | GOROOT** and 
+You can either specify a local path to the SDK or download it. To set the Go SDK, navigate to **Go | GOROOT** and
 set accordingly.
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -13,8 +13,8 @@ This document contains a list of maintainers in this repo. See [opensearch-proje
 
 ## Emeritus
 
-| Maintainer              | GitHub ID                                   | Affiliation |
-| ----------------------- | ------------------------------------------- | ----------- |
-| Jack Mazanec            | [jmazanec15](https://github.com/jmazanec15) | Amazon      |
-| Vamshi Vijay Nakkirtha  | [vamshin](https://github.com/vamshin)       | Amazon      |
-| Rob Cowart              | [robcowart](https://github.com/robcowart)   | ElastiFlow  |
+| Maintainer             | GitHub ID                                   | Affiliation |
+| ---------------------- | ------------------------------------------- | ----------- |
+| Jack Mazanec           | [jmazanec15](https://github.com/jmazanec15) | Amazon      |
+| Vamshi Vijay Nakkirtha | [vamshin](https://github.com/vamshin)       | Amazon      |
+| Rob Cowart             | [robcowart](https://github.com/robcowart)   | ElastiFlow  |
diff --git a/README.md b/README.md
@@ -22,18 +22,18 @@ OpenSearch Go Client
 
 ## Project Resources
 
-* [Project Website](https://opensearch.org/)
-* [Developer Guide](DEVELOPER_GUIDE.md)
-* [User Guide](USER_GUIDE.md)
-* [Documentation](https://opensearch.org/docs/latest/clients/go/)
-* [API Documentation](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v2)
-* Need help? Try [Forums](https://discuss.opendistrocommunity.dev/c/clients/)
-* [Project Principles](https://opensearch.org/#principles)
-* [Contributing to OpenSearch](CONTRIBUTING.md)
-* [Maintainer Responsibilities](MAINTAINERS.md)
-* [Release Management](RELEASING.md)
-* [Admin Responsibilities](ADMINS.md)
-* [Security](SECURITY.md)
+- [Project Website](https://opensearch.org/)
+- [Developer Guide](DEVELOPER_GUIDE.md)
+- [User Guide](USER_GUIDE.md)
+- [Documentation](https://opensearch.org/docs/latest/clients/go/)
+- [API Documentation](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v2)
+- Need help? Try [Forums](https://discuss.opendistrocommunity.dev/c/clients/)
+- [Project Principles](https://opensearch.org/#principles)
+- [Contributing to OpenSearch](CONTRIBUTING.md)
+- [Maintainer Responsibilities](MAINTAINERS.md)
+- [Release Management](RELEASING.md)
+- [Admin Responsibilities](ADMINS.md)
+- [Security](SECURITY.md)
 
 ## Code of Conduct