From 0ef1246d716482209b3cbb175b675c4dc16e86ae Mon Sep 17 00:00:00 2001 From: Vacha Shah Date: Tue, 25 Oct 2022 11:41:03 -0700 Subject: [PATCH] Update Maintainers (#248) --- .github/CODEOWNERS | 2 +- ADMINS.md | 32 +++---------------- CHANGELOG.md | 1 + DEVELOPER_GUIDE.md | 36 ---------------------- MAINTAINERS.md | 77 ++++++++-------------------------------------- README.md | 5 +++ 6 files changed, 24 insertions(+), 129 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 794043e9b7..c7b9675ef6 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,2 +1,2 @@ # This should match the team set up in https://github.com/orgs/opensearch-project/teams and include any additional contributors -* @opensearch-project/clients @madhusudhankonda \ No newline at end of file +* @reta @Bukhtawar @dblock @madhusudhankonda @saratvemulapalli @VachaShah \ No newline at end of file diff --git a/ADMINS.md b/ADMINS.md index 600f883b1a..7b467bfdea 100644 --- a/ADMINS.md +++ b/ADMINS.md @@ -1,32 +1,8 @@ -## 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 +## Admins | Admin | GitHub ID | Affiliation | | -------------------------| --------------------------------------- | ----------- | -| Charlotte | [CEHENKLE](https://github.com/CEHENKLE) | Amazon | -| Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon | -| Mital Awachat | [mitalawachat](https://github.com/mitalawachat) | Amazon | -| Bukhtawar Khan | [Bukhtawar](https://github.com/Bukhtawar) | Amazon | -| Ranjith Ramachandra | [rramachand21](https://github.com/rramachand21) | Amazon | - - -## Admin Responsibilities - -As an admin you own stewartship of the repository and its settings. Admins have [admin-level permissions on a repository](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization). Use those privileges to serve the community and protect the repository as follows. - -### Prioritize Security - -Security is your number one priority. Manage security keys and safeguard access to the repository. - -Note that this repository is monitored and supported 24/7 by Amazon Security, see [Reporting a Vulnerability](SECURITY.md) for details. - -### Enforce Code of Conduct - -Act on [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) violations by revoking access, and blocking malicious actors. - -### Adopt Organizational Best Practices +| Charlotte Henkle | [CEHENKLE](https://github.com/cehenkle) | Amazon | +| Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon | -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. +[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). diff --git a/CHANGELOG.md b/CHANGELOG.md index 8eb5e987b4..9534bde8ab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Update tests to use JUnit's Assert ([#244](https://github.com/opensearch-project/opensearch-java/pull/244)) - Add support to parse sub-aggregations from filter/nested aggregations ([#234](https://github.com/opensearch-project/opensearch-java/pull/234)) - Add timeout and throttle to the jenkins workflows ([#231](https://github.com/opensearch-project/opensearch-java/pull/231)) +- Updating maintainers, admins and documentation ([#248](https://github.com/opensearch-project/opensearch-java/pull/248)) ### Deprecated diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 0a6d9a4a63..fa2da6946e 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -7,7 +7,6 @@ - [Run Tests](#run-tests) - [Unit Tests](#unit-tests) - [Integration Tests](#integration-tests) - - [Using the Java Client](#using-the-java-client) - [Use an Editor](#use-an-editor) - [IntelliJ IDEA](#intellij-idea) - [Visual Studio Code](#visual-studio-code) @@ -65,41 +64,6 @@ Run integration tests after starting OpenSearch cluster: ./gradlew clean integrationTest ``` -### Using the Java Client - -An example for using the java client in an application: - -```java -try (RestClient restClient = RestClient.builder(new HttpHost("localhost", 9200)).build()) { - String index = "test-index"; - - // Create Client - OpenSearchTransport transport = new RestClientTransport(restClient, new JacksonJsonpMapper()); - OpenSearchClient client = new OpenSearchClient(transport); - - // Create Index - CreateIndexRequest createIndexRequest = new CreateIndexRequest.Builder().index(index).build(); - CreateIndexResponse createIndexResponse = client.indices().create(createIndexRequest); - assert createIndexResponse.shardsAcknowledged(); - - // Index Document - AppData appData = new AppData(1337, "foo"); - - IndexRequest indexRequest = new IndexRequest.Builder().index("index").id("1").document(appData).build(); - IndexResponse indexResponse = client.index(indexRequest); - assertEquals(Result.Created, indexResponse.result()); - - // Search Documents - SearchResponse search = client.search(b -> b.index(index), AppData.class); - assertEquals(1, search.hits().total().value()); - - // Delete Index - DeleteIndexRequest deleteRequest = new DeleteIndexRequest.Builder().index(index).build(); - DeleteIndexResponse deleteResponse = client.indices().delete(deleteRequest); - assert deleteResponse.shardsAcknowledged(); - } -``` - ## Use an Editor ### IntelliJ IDEA diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 6fee34cd24..422bb1ddda 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,77 +1,26 @@ - [Overview](#overview) - [Current Maintainers](#current-maintainers) -- [Maintainer Responsibilities](#maintainer-responsibilities) - - [Uphold Code of Conduct](#uphold-code-of-conduct) - - [Prioritize Security](#prioritize-security) - - [Review Pull Requests](#review-pull-requests) - - [Triage Open Issues](#triage-open-issues) - - [Backports](#backports) - - [Be Responsive](#be-responsive) - - [Maintain Overall Health of the Repo](#maintain-overall-health-of-the-repo) - - [Use Semver](#use-semver) - - [Release Frequently](#release-frequently) - - [Promote Other Maintainers](#promote-other-maintainers) - +- [Emeritus](#emeritus) + ## Overview -This document explains who the maintainers are (see below), what they do in this repo, and how they should be doing it. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md). +[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). ## Current Maintainers | Maintainer | GitHub ID | Affiliation | | ------------------------ | ------------------------------------------------------ | ----------- | -| Bukhtawar Khan | [Bukhtawar](https://github.com/Bukhtawar) | Amazon | +| Andriy Redko | [reta](https://github.com/reta) | Aiven | +| Bukhtawar Khan | [Bukhtawar](https://github.com/Bukhtawar) | Amazon | +| Daniel Doubrovkine | [dblock](https://github.com/dblock) | Amazon | | Madhusudhan Konda | [madhusudhankonda](https://github.com/madhusudhankonda)| Chocolateminds| +| Sarat Vemulapalli | [saratvemulapalli](https://github.com/saratvemulapalli)| Amazon | +| Vacha Shah | [VachaShah](https://github.com/VachaShah) | Amazon | + +## Emeritus + +| Maintainer | GitHub ID | Affiliation | +| --------------- | --------------------------------------------------- | ----------- | | Mital Awachat | [mitalawachat](https://github.com/mitalawachat) | Amazon | | Rishab Nahata | [imRishN](https://github.com/imRishN) | Amazon | | Vamshi Vijay Nakkirtha | [vamshin](https://github.com/vamshin) | Amazon | - -## Maintainer Responsibilities - -Maintainers are active and visible members of the community, and have [maintain-level permissions on a repository](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization). Use those privileges to serve the community and evolve code as follows. - -### Uphold Code of Conduct - -Model the behavior set forward by the [Code of Conduct](CODE_OF_CONDUCT.md) and raise any violations to other maintainers and admins. - -### Prioritize Security - -Security is your number one priority. Maintainer's Github keys must be password protected securely and any reported security vulnerabilities are addressed before features or bugs. - -Note that this repository is monitored and supported 24/7 by Amazon Security, see [Reporting a Vulnerability](SECURITY.md) for details. - -### Review Pull Requests - -Review pull requests regularly, comment, suggest, reject, merge and close. Accept only high quality pull-requests. Provide code reviews and guidance on incomming pull requests. Don't let PRs be stale and do your best to be helpful to contributors. - -### Triage Open Issues - -Manage labels, review issues regularly, and triage by labelling them. - -All repositories in this organization have a standard set of labels, including `bug`, `documentation`, `duplicate`, `enhancement`, `good first issue`, `help wanted`, `blocker`, `invalid`, `question`, `wontfix`, and `untriaged`, along with release labels, such as `v1.0.0`, `v1.1.0` and `v2.0.0`, and `backport`. - -Use labels to target an issue or a PR for a given release, add `help wanted` to good issues for new community members, and `blocker` for issues that scare you or need immediate attention. Request for more information from a submitter if an issue is not clear. Create new labels as needed by the project. - -### Backports - -The Github workflow in [backport.yml](.github/workflows/backport.yml) creates backport PRs automatically when the original PR with an appropriate label `backport ` is merged to main. To backport a PR to `1.x`, add a label `backport 1.x` to the PR, once this PR is merged to main, the workflow will create a backport PR to the `1.x` branch. - -### Be Responsive - -Respond to enhancement requests, and forum posts. Allocate time to reviewing and commenting on issues and conversations as they come in. - -### Maintain Overall Health of the Repo - -Keep the `main` branch at production quality at all times. Backport features as needed. Cut release branches and tags to enable future patches. - -### Use Semver - -Use and enforce [semantic versioning](https://semver.org/) and do not let breaking changes be made outside of major releases. - -### Release Frequently - -Make frequent project releases to the community. - -### Promote Other Maintainers - -Assist, add, and remove [MAINTAINERS](MAINTAINERS.md). Exercise good judgement, and propose high quality contributors to become co-maintainers. diff --git a/README.md b/README.md index 01a56c28a7..a0563ca3d7 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ OpenSearch Java Client - [Sample Code](#sample-code) - [Project Resources](#project-resources) - [Code of Conduct](#code-of-conduct) +- [User Guide](#user-guide) - [Compatibility with OpenSearch](#compatibility-with-opensearch) - [Security](#security) - [License](#license) @@ -46,6 +47,10 @@ Please see the [USER_GUIDE](USER_GUIDE.md) for code snippets. 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. +## User Guide + +See [User Guide](USER_GUIDE.md). + ## Compatibility with OpenSearch See [Compatibility](COMPATIBILITY.md).