Skip to content

Commit 0ef1246

Browse files
authored
Update Maintainers (#248)
1 parent 9865478 commit 0ef1246

File tree

6 files changed

+24
-129
lines changed

6 files changed

+24
-129
lines changed

.github/CODEOWNERS

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
# This should match the team set up in https://github.com/orgs/opensearch-project/teams and include any additional contributors
2-
* @opensearch-project/clients @madhusudhankonda
2+
* @reta @Bukhtawar @dblock @madhusudhankonda @saratvemulapalli @VachaShah

ADMINS.md

+4-28
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,8 @@
1-
## Overview
2-
3-
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).
4-
5-
## Current Admins
1+
## Admins
62

73
| Admin | GitHub ID | Affiliation |
84
| -------------------------| --------------------------------------- | ----------- |
9-
| Charlotte | [CEHENKLE](https://github.com/CEHENKLE) | Amazon |
10-
| Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon |
11-
| Mital Awachat | [mitalawachat](https://github.com/mitalawachat) | Amazon |
12-
| Bukhtawar Khan | [Bukhtawar](https://github.com/Bukhtawar) | Amazon |
13-
| Ranjith Ramachandra | [rramachand21](https://github.com/rramachand21) | Amazon |
14-
15-
16-
## Admin Responsibilities
17-
18-
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.
19-
20-
### Prioritize Security
21-
22-
Security is your number one priority. Manage security keys and safeguard access to the repository.
23-
24-
Note that this repository is monitored and supported 24/7 by Amazon Security, see [Reporting a Vulnerability](SECURITY.md) for details.
25-
26-
### Enforce Code of Conduct
27-
28-
Act on [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) violations by revoking access, and blocking malicious actors.
29-
30-
### Adopt Organizational Best Practices
5+
| Charlotte Henkle | [CEHENKLE](https://github.com/cehenkle) | Amazon |
6+
| Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon |
317

32-
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.
8+
[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).

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
1414
- Update tests to use JUnit's Assert ([#244](https://github.com/opensearch-project/opensearch-java/pull/244))
1515
- Add support to parse sub-aggregations from filter/nested aggregations ([#234](https://github.com/opensearch-project/opensearch-java/pull/234))
1616
- Add timeout and throttle to the jenkins workflows ([#231](https://github.com/opensearch-project/opensearch-java/pull/231))
17+
- Updating maintainers, admins and documentation ([#248](https://github.com/opensearch-project/opensearch-java/pull/248))
1718

1819
### Deprecated
1920

DEVELOPER_GUIDE.md

-36
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
- [Run Tests](#run-tests)
88
- [Unit Tests](#unit-tests)
99
- [Integration Tests](#integration-tests)
10-
- [Using the Java Client](#using-the-java-client)
1110
- [Use an Editor](#use-an-editor)
1211
- [IntelliJ IDEA](#intellij-idea)
1312
- [Visual Studio Code](#visual-studio-code)
@@ -65,41 +64,6 @@ Run integration tests after starting OpenSearch cluster:
6564
./gradlew clean integrationTest
6665
```
6766

68-
### Using the Java Client
69-
70-
An example for using the java client in an application:
71-
72-
```java
73-
try (RestClient restClient = RestClient.builder(new HttpHost("localhost", 9200)).build()) {
74-
String index = "test-index";
75-
76-
// Create Client
77-
OpenSearchTransport transport = new RestClientTransport(restClient, new JacksonJsonpMapper());
78-
OpenSearchClient client = new OpenSearchClient(transport);
79-
80-
// Create Index
81-
CreateIndexRequest createIndexRequest = new CreateIndexRequest.Builder().index(index).build();
82-
CreateIndexResponse createIndexResponse = client.indices().create(createIndexRequest);
83-
assert createIndexResponse.shardsAcknowledged();
84-
85-
// Index Document
86-
AppData appData = new AppData(1337, "foo");
87-
88-
IndexRequest<AppData> indexRequest = new IndexRequest.Builder<AppData>().index("index").id("1").document(appData).build();
89-
IndexResponse indexResponse = client.index(indexRequest);
90-
assertEquals(Result.Created, indexResponse.result());
91-
92-
// Search Documents
93-
SearchResponse<AppData> search = client.search(b -> b.index(index), AppData.class);
94-
assertEquals(1, search.hits().total().value());
95-
96-
// Delete Index
97-
DeleteIndexRequest deleteRequest = new DeleteIndexRequest.Builder().index(index).build();
98-
DeleteIndexResponse deleteResponse = client.indices().delete(deleteRequest);
99-
assert deleteResponse.shardsAcknowledged();
100-
}
101-
```
102-
10367
## Use an Editor
10468

10569
### IntelliJ IDEA

MAINTAINERS.md

+13-64
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,26 @@
11
- [Overview](#overview)
22
- [Current Maintainers](#current-maintainers)
3-
- [Maintainer Responsibilities](#maintainer-responsibilities)
4-
- [Uphold Code of Conduct](#uphold-code-of-conduct)
5-
- [Prioritize Security](#prioritize-security)
6-
- [Review Pull Requests](#review-pull-requests)
7-
- [Triage Open Issues](#triage-open-issues)
8-
- [Backports](#backports)
9-
- [Be Responsive](#be-responsive)
10-
- [Maintain Overall Health of the Repo](#maintain-overall-health-of-the-repo)
11-
- [Use Semver](#use-semver)
12-
- [Release Frequently](#release-frequently)
13-
- [Promote Other Maintainers](#promote-other-maintainers)
14-
3+
- [Emeritus](#emeritus)
4+
155
## Overview
166

17-
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).
7+
[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).
188

199
## Current Maintainers
2010

2111
| Maintainer | GitHub ID | Affiliation |
2212
| ------------------------ | ------------------------------------------------------ | ----------- |
23-
| Bukhtawar Khan | [Bukhtawar](https://github.com/Bukhtawar) | Amazon |
13+
| Andriy Redko | [reta](https://github.com/reta) | Aiven |
14+
| Bukhtawar Khan | [Bukhtawar](https://github.com/Bukhtawar) | Amazon |
15+
| Daniel Doubrovkine | [dblock](https://github.com/dblock) | Amazon |
2416
| Madhusudhan Konda | [madhusudhankonda](https://github.com/madhusudhankonda)| Chocolateminds|
17+
| Sarat Vemulapalli | [saratvemulapalli](https://github.com/saratvemulapalli)| Amazon |
18+
| Vacha Shah | [VachaShah](https://github.com/VachaShah) | Amazon |
19+
20+
## Emeritus
21+
22+
| Maintainer | GitHub ID | Affiliation |
23+
| --------------- | --------------------------------------------------- | ----------- |
2524
| Mital Awachat | [mitalawachat](https://github.com/mitalawachat) | Amazon |
2625
| Rishab Nahata | [imRishN](https://github.com/imRishN) | Amazon |
2726
| Vamshi Vijay Nakkirtha | [vamshin](https://github.com/vamshin) | Amazon |
28-
29-
## Maintainer Responsibilities
30-
31-
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.
32-
33-
### Uphold Code of Conduct
34-
35-
Model the behavior set forward by the [Code of Conduct](CODE_OF_CONDUCT.md) and raise any violations to other maintainers and admins.
36-
37-
### Prioritize Security
38-
39-
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.
40-
41-
Note that this repository is monitored and supported 24/7 by Amazon Security, see [Reporting a Vulnerability](SECURITY.md) for details.
42-
43-
### Review Pull Requests
44-
45-
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.
46-
47-
### Triage Open Issues
48-
49-
Manage labels, review issues regularly, and triage by labelling them.
50-
51-
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`.
52-
53-
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.
54-
55-
### Backports
56-
57-
The Github workflow in [backport.yml](.github/workflows/backport.yml) creates backport PRs automatically when the original PR with an appropriate label `backport <backport-branch-name>` 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.
58-
59-
### Be Responsive
60-
61-
Respond to enhancement requests, and forum posts. Allocate time to reviewing and commenting on issues and conversations as they come in.
62-
63-
### Maintain Overall Health of the Repo
64-
65-
Keep the `main` branch at production quality at all times. Backport features as needed. Cut release branches and tags to enable future patches.
66-
67-
### Use Semver
68-
69-
Use and enforce [semantic versioning](https://semver.org/) and do not let breaking changes be made outside of major releases.
70-
71-
### Release Frequently
72-
73-
Make frequent project releases to the community.
74-
75-
### Promote Other Maintainers
76-
77-
Assist, add, and remove [MAINTAINERS](MAINTAINERS.md). Exercise good judgement, and propose high quality contributors to become co-maintainers.

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ OpenSearch Java Client
1313
- [Sample Code](#sample-code)
1414
- [Project Resources](#project-resources)
1515
- [Code of Conduct](#code-of-conduct)
16+
- [User Guide](#user-guide)
1617
- [Compatibility with OpenSearch](#compatibility-with-opensearch)
1718
- [Security](#security)
1819
- [License](#license)
@@ -46,6 +47,10 @@ Please see the [USER_GUIDE](USER_GUIDE.md) for code snippets.
4647

4748
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.
4849

50+
## User Guide
51+
52+
See [User Guide](USER_GUIDE.md).
53+
4954
## Compatibility with OpenSearch
5055

5156
See [Compatibility](COMPATIBILITY.md).

0 commit comments

Comments
 (0)