Skip to content

Commit 10af9db

Browse files
stockholmuxstockholmux
authored
Merge pull request opensearch-project#247 from stockholmux/community-clients
added blog post, faq entries, and css fix for faq
2 parents fee475b + f2e29bd commit 10af9db

12 files changed

+119
-0
lines changed

‎_faqs/04-01-add-a-project.markdown

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
question: How do I add a project to the community project page on opensearch.org?
3+
category: Community and Collaboration
4+
---
5+
6+
To add a project:
7+
8+
* Fork the [opensearch website repository](https://github.com/opensearch-project/project-website).
9+
* Create a branch. The recommended naming convention is `adds-<your project name>-to-community-projects`
10+
* Add a [markdown file](https://github.com/opensearch-project/project-website/blob/main/_community_projects/_sample.md) for your project to .`/_community_projects/your-project.md`
11+
* Last create a pull request and one of the website maintainers will review it and work with you to merge it.
12+
13+
To see an example pull request, look [here](http://https//github.com/opensearch-project/project-website/pull/186)).
14+

‎_faqs/04-02-kind-of-community-projects.markdown

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
question: What kinds of projects are welcome on the community project page?
3+
category: Community and Collaboration
4+
---
5+
6+
Any project that benefits the OpenSearch community is welcome. These can be both open source licensed projects and proprietary licensed projects.

‎_faqs/04-03-projects-in-project-org.markdown

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
question: What are the requirements for a project before it can be moved into the OpenSearch Project GitHub organization?
3+
category: Community and Collaboration
4+
---
5+
6+
There are three requirements:
7+
8+
- The project is licensed under a permissive open source license, like Apache 2.0.
9+
- The project has broad utility for the OpenSearch community
10+
- The project is currently actively maintained

‎_faqs/04-04-benefits-of-moving-a-project-to-org.markdown

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
question: What are the benefits of moving a project under the OpenSearch Project GitHub organization?
3+
category: Community and Collaboration
4+
---
5+
The main benefits include increased visibility, and if you no longer can or want to maintain the project some day, the project will help find new maintainers to transition the ownership. Everything else remains the same, including that you retain the administrator permissions of your GitHub repository

‎_faqs/04-05-get-into-opensearch-org.markdown

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
question: How can I get my project into the OpenSearch Project GitHub organization?
3+
category: Community and Collaboration
4+
---
5+
6+
If you are interested in moving your project, create an issue in your repository, visibly confirm with your co-maintainers that you would like to make the move, and tag [dblock](https://github.com/dblock) and [elfisher](https://github.com/elfisher) to initiate the process of moving your project.

‎_faqs/04-06-opensearch-org-repo-admin.markdown

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
question: What is an OpenSearch Project Github organization repository administrator?
3+
category: Community and Collaboration
4+
---
5+
6+
An admin owns stewardship 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. Administrator responsibilities can be found in the OpenSearch .github repository [admins file](https://github.com/opensearch-project/.github/blob/main/ADMINS.md).

‎_faqs/04-07-what-is-opensearch-org-maintainer.markdown

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
question: What is an OpenSearch Project Github organization repository maintainer?
3+
category: Community and Collaboration
4+
---
5+
6+
[Maintainers](https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md#maintainer-responsibilities) are active and visible members of the community, and have [maintain-level permissions](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) on a repository. They use those privileges to serve the community and evolve the software in the repository they maintain. Maintainer responsibilities can be found in the OpenSearch .github repository [maintainer file](https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md).

‎_faqs/04-08-security-obligations-github-org.markdown

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
question: What are my security obligations when developing in OpenSearch Project Github organization repositories?
3+
category: Community and Collaboration
4+
---
5+
6+
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 repositories in the OpenSearch GitHub organization are monitored and supported 24/7 by Amazon Security, see [Reporting a Vulnerability](https://github.com/opensearch-project/.github/blob/main/SECURITY.md) for details.

‎_faqs/04-09-opensearch-org-roadmap.markdown

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
question: How should an OpenSearch Project Github organization repository roadmap be managed?
3+
category: Community and Collaboration
4+
---
5+
6+
Maintainers can manage the repository roadmap in the way that best works for them. An example roadmap/project board can be found [here](https://github.com/opensearch-project/opensearch-cli/projects/1).

‎_faqs/04-10-contribute-to-org-repo.markdown

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
question: How do I contribute to an OpenSearch Project Github organization repository?
3+
category: Community and Collaboration
4+
---
5+
6+
It's strongly recommend that you follow the [contributors guide](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md).

‎_posts/2021-08-03-community-clients.markdown

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
layout: post
3+
title: "Carrying forward the OpenSearch client libraries as a community"
4+
authors:
5+
- elifish
6+
date: 2021-08-11 01:01:01 -0700
7+
categories:
8+
- community
9+
---
10+
11+
Software projects often provide language specific client libraries to make it easy to integrate applications. OpenSearch is built to be wire compatible with open source Elasticsearch 7.10.2 so that anyone can leverage the existing clients, connectors, and tools with minimal modifications to their deployments.
12+
13+
Starting with version 7.14, multiple of the [clients maintained by Elastic](https://www.elastic.co/guide/en/elasticsearch/client/index.html) contain [new logic](https://github.com/elastic/elasticsearch-py/pull/1623) that rejects connections to OpenSearch clusters or to clusters running open source distributions of Elasticsearch 7. This includes the [Apache-licensed distribution](https://www.elastic.co/downloads/past-releases/elasticsearch-oss-7-10-2) provided by Elastic, as well as community distributions like [Open Distro for Elasticsearch](https://opendistro.github.io/for-elasticsearch/).
14+
15+
For the time being, people who use open source Elasticsearch, Open Distro, or OpenSearch should avoid upgrading to version 7.14 of these client libraries as this may break applications. Please see [this documentation](https://opensearch.org/docs/clients/index/) for recommended versions of client libraries that have been tested to work with open source Elasticsearch, Open Distro, and OpenSearch.
16+
17+
Over the next few weeks, the OpenSearch project will add new open source clients for connecting applications to any OpenSearch or Elasticsearch version 7 cluster. These clients will be derived from the last compatible version of the corresponding Elastic-maintained client before product checks were added. The list of clients includes:
18+
19+
1. [elasticsearch-py](https://github.com/elastic/elasticsearch-py)
20+
2. [elasticsearch-java](https://github.com/elastic/elasticsearch-java)
21+
3. [elasticsearch-net](https://github.com/elastic/elasticsearch-net)
22+
4. [go-elasticsearch](https://github.com/elastic/go-elasticsearch)
23+
5. [elasticsearch-js](https://github.com/elastic/elasticsearch-js)
24+
6. [elasticsearch-ruby](https://github.com/elastic/elasticsearch-ruby)
25+
7. [eland](https://github.com/elastic/eland)
26+
8. [elasticsearch-php](https://github.com/elastic/elasticsearch-php)
27+
9. [elasticsearch-rs](https://github.com/elastic/elasticsearch-rs)
28+
10. [elasticsearch-perl](https://github.com/elastic/elasticsearch-perl)
29+
11. [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification)
30+
12. [elasticsearch-hadoop](https://github.com/elastic/elasticsearch-hadoop)
31+
32+
If there is a client library that you do not see, but would like to contribute to or maintain, please post a request in [the forums](https://discuss.opendistrocommunity.dev/c/clients/60).
33+
34+
As stated in OpenSearch’s 6th [principle of development](https://opensearch.org/#principles) “Great open source software is built together, with a diverse community of contributors,” and so we are seeking co-maintainers for each of these client libraries.
35+
36+
[Maintainers](https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md#maintainer-responsibilities) are active and visible members of the community, and have [maintain-level permissions](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) on a repository. They use those privileges to serve the community and evolve the software in the repository they maintain. As an OpenSearch project maintainer, you agree to advance the mission of the project and their repo, and to uphold the project's [Code of Conduct](https://opensearch.org/codeofconduct.html). It's up to you.
37+
38+
Should you take on this responsibility, you won’t be alone—AWS will contribute engineers to support each library as well. In addition, AWS will ensure there is continuity should any maintainers step down in the future. If you’re interested in maintaining a client library, you’ll find an open issue in each repo where volunteers are being solicited.
39+
40+
I’d like to give a big thanks to the people who have already stepped up to help progress and maintain the forks of the clients:
41+
42+
* [madhusudhankonda](https://github.com/madhusudhankonda)
43+
* [robcowart](https://github.com/robcowart)
44+
* [svencowart](https://github.com/svencowart)
45+
* [robsears](https://github.com/robsears)

‎_sass/_opensearch.scss

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,9 @@ dl.list-features {
170170
li h3 span {
171171
opacity: 0.9;
172172
}
173+
ol li ul li {
174+
list-style-type: disc;
175+
}
173176
}
174177

175178
.img-fluid {

0 commit comments

Comments
 (0)