Cleanup READMEs.

- Added ADMINS.md documenting admin responsibilities.
- Standardized CONTRIBUTING.md
- Added DEVELOPER_GUIDE.md and moved content from README.
- Linked standard MAINTAINERS.md.
- Added SECURITY.md.
- Cleaned up README.
- Added a RELEASING.md.

Signed-off-by: dblock <[email protected]>

ADMINS.md

@@ -0,0 +1,7 @@
+## Admins
+
+| Admin           | GitHub ID                               | Affiliation |
+| --------------- | --------------------------------------- | ----------- |
+| Henri Yandell   | [hyandell](https://github.com/hyandell) | Amazon      |
+
+[This document](https://github.com/opensearch-project/.github/blob/main/ADMINS.md) explains what admins 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).

CODE_OF_CONDUCT.md

@@ -1,14 +1,12 @@
 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.
 
-
 **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;

CONTRIBUTING.md

@@ -1,101 +1,4 @@
-# Contributing Guidelines
+## Contributing to this Project
 
-Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
-documentation, we greatly value feedback and contributions from our community.
-
-Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
-information to effectively respond to your bug report or contribution.
-
-
-## Reporting Bugs/Feature Requests
-
-We welcome you to use the GitHub issue tracker to report bugs or suggest features.
-
-When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
-reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
-
-* A reproducible test case or series of steps
-* The version of our code being used
-* Any modifications you've made relevant to the bug
-* Anything unusual about your environment or deployment
-
-
-## Contributing via Pull Requests
-Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
-
-1. You are working against the latest source on the *master* branch.
-2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
-3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
-
-To send us a pull request, please:
-
-1. Fork the repository.
-2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
-3. Ensure local tests pass.
-4. Commit to your fork using clear commit messages.
-5. Send us a pull request, answering any default questions in the pull request interface.
-6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
-
-GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
-[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
-
-
-## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
-
-
-## Code of Conduct
-This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
-For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
-[email protected] with any additional questions or comments.
-
-
-## Security issue notifications
-If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
-
-
-## Developer Certificate of Origin
-
-OpenSearch Common Utils is an open source product released under the Apache 2.0 license (see either [the Apache site](https://www.apache.org/licenses/LICENSE-2.0) or the [LICENSE file](./LICENSE)).  The Apache 2.0 license allows you to freely use, modify, distribute, and sell your own products that include Apache 2.0 licensed software.
-
-We respect intellectual property rights of others and we want to make sure all incoming contributions are correctly attributed and licensed. A Developer Certificate of Origin (DCO) is a lightweight mechanism to do that.
-
-The DCO is a declaration attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a `Signed-off-by` statement and thereby agrees to the DCO, which you can find below or at [DeveloperCertificate.org](http://developercertificate.org/).
-
-```
-Developer's Certificate of Origin 1.1
-By making a contribution to this project, I certify that:
-(a) The contribution was created in whole or in part by me and I
-    have the right to submit it under the open source license
-    indicated in the file; or
-(b) The contribution is based upon previous work that, to the
-    best of my knowledge, is covered under an appropriate open
-    source license and I have the right under that license to
-    submit that work with modifications, whether created in whole
-    or in part by me, under the same open source license (unless
-    I am permitted to submit under a different license), as
-    Indicated in the file; or
-(c) The contribution was provided directly to me by some other
-    person who certified (a), (b) or (c) and I have not modified
-    it.
-(d) I understand and agree that this project and the contribution
-    are public and that a record of the contribution (including
-    all personal information I submit with it, including my
-    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 Common Utils is signed with a Developer Certificate of Origin.  Additionally, please use your real name.  We do not accept anonymous contributors nor those utilizing pseudonyms.
-
-Each commit must include a DCO which looks like this
-
-```
-Signed-off-by: Jane Smith <[email protected]>
-```
-You may type this line on your own when writing your commit messages.  However, if your user.name and user.email are set in your git configs, you can use `-s` or `– – signoff` to add the `Signed-off-by` line to the end of the commit message.
-
-## Licensing
-
-See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
-
-We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
+OpenSearch is a community project that is built and maintained by people just like **you**. 
+[This document](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md) explains how you can contribute to this and related projects.

DEVELOPER_GUIDE.md

@@ -0,0 +1,39 @@
+- [Developer Guide](#developer-guide)
+  - [Forking and Cloning](#forking-and-cloning)
+  - [Install Prerequisites](#install-prerequisites)
+    - [JDK 14](#jdk-14)
+  - [Building](#building)
+  - [Using IntelliJ IDEA](#using-intellij-idea)
+  - [Submitting Changes](#submitting-changes)
+
+## Developer Guide
+
+So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do.
+
+### Forking and Cloning
+
+Fork this repository on GitHub, and clone locally with `git clone`.
+
+### Install Prerequisites
+
+#### JDK 14
+
+OpenSearch components build using Java 14 at a minimum. This means you must have a JDK 14 installed with the environment variable `JAVA_HOME` referencing the path to Java home for your JDK 14 installation, e.g. `JAVA_HOME=/usr/lib/jvm/jdk-14`.
+
+### Building
+
+To build from the command line, use `./gradlew`.
+
+```
+./gradlew clean
+./gradlew build
+./gradlew publishToMavenLocal
+```
+
+### Using IntelliJ IDEA
+
+Launch Intellij IDEA, choose **Import Project**, and select the `settings.gradle` file in the root of this package. 
+
+### Submitting Changes
+
+See [CONTRIBUTING](CONTRIBUTING.md).

MAINTAINERS.md

@@ -1,6 +1,5 @@
-# OpenSearch Alerting Maintainers
-
 ## Maintainers
+
 | Maintainer | GitHub ID | Affiliation |
 | --------------- | --------- | ----------- |
 | Ashish Agrawal | [lezzago](https://github.com/lezzago) | Amazon |
@@ -9,4 +8,6 @@
 | Bowen Lan | [bowenlan-amzn](https://github.com/bowenlan-amzn) | Amazon |
 | Rishabh Maurya | [rishabhmaurya](https://github.com/rishabhmaurya) | Amazon | 
 | Tianli Feng | [tlfeng](https://github.com/tlfeng) | Amazon |
-| Annie Lee | [leeyun-amzn](https://github.com/leeyun-amzn) | Amazon |
+| Annie Lee | [leeyun-amzn](https://github.com/leeyun-amzn) | Amazon |
+
+[This document](https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md) explains what maintainers do in this repo, and how they should be doing it. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md).

README.md

@@ -1,58 +1,47 @@
-# OpenSearch Common Utils 
+<img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/>
 
-OpenSearch Common Utils is focused on providing reusable Java components for OpenSearch plugins.
+- [OpenSearch Common Utils](#opensearch-common-utils)
+- [Contributing](#contributing)
+- [Getting Help](#getting-help)
+- [Code of Conduct](#code-of-conduct)
+- [Security](#security)
+- [License](#license)
+- [Copyright](#copyright)
 
-This library is composed of following parts:
-1. SecureRestClientBuilder - provides methods to create secure low-level and high-level REST client. This is 
-   useful to make secure REST calls to OpenSearch or other plugin api's. 
-2. InjectSecurity - provides methods to inject user or roles. This is useful for running background jobs securely.
-3. IntegTestsWithSecurity - provides methods to create users, roles for running integ tests with security plugin.
-4. Shared Request/Response/Action classes used for plugin to plugin transport layer calls.
-5. Any common functionality across OpenSearch plugins could be moved to this.
+## OpenSearch Common Utils 
 
+OpenSearch Common Utils is focused on providing reusable Java components for [OpenSearch](https://opensearch.org/) plugins.
 
-## 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`.
+This library is composed of following parts:
 
+1. `SecureRestClientBuilder` - provides methods to create secure low-level and high-level REST client. This is useful to make secure REST calls to OpenSearch or other plugin APIs. 
+2. `InjectSecurity` - provides methods to inject user or roles. This is useful for running background jobs securely.
+3. `IntegTestsWithSecurity` - provides methods to create users, roles for running integration tests with security plugin.
+4. Shared request/response/action classes used for plugin to plugin transport layer calls.
+5. Any common functionality across OpenSearch plugins could be moved to this.
 
-## Build
+## Contributing
 
-### Building from the command line
-```
-./gradlew clean
-./gradlew build 
+See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md). 
 
-./gradlew publishToMavenLocal
-```
+## Getting Help
 
-### Logging
+If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository.
 
-To change loglevel, add below to `config/log4j2.properties` or use REST API to set.
-```
-logger.commons.name = org.opensearch.commons
-logger.commons.level = debug
-```
+For more information, see [project website](https://opensearch.org/) and [documentation](https://docs-beta.opensearch.org/). If you need help and are unsure where to open an issue, try [forums](https://discuss.opendistrocommunity.dev/).
 
 ## Code of Conduct
 
-This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
-For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
-[email protected] with any additional questions or comments.
-
+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 [[email protected]](mailto:[email protected]) with any additional questions or comments.
 
-## Security issue notifications
+## Security
 
 If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.
 
+## License
 
-## Licensing
-
-See the [LICENSE](./LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
-
+This project is licensed under the [Apache v2.0 License](LICENSE.txt).
 
 ## Copyright
 
-Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

RELEASING.md

@@ -0,0 +1 @@
+This project follows the [OpenSearch release process](https://github.com/opensearch-project/.github/blob/main/RELEASING.md).

SECURITY.md

@@ -0,0 +1,3 @@
+## Reporting a Vulnerability
+
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/) or directly via email to [email protected]. Please do **not** create a public GitHub issue.