forked from opensearch-project/OpenSearch
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated READMEs on releasing, maintaining, admins and security. (open…
…search-project#853) Signed-off-by: dblock <[email protected]>
- Loading branch information
Showing
5 changed files
with
42 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,38 @@ | ||
# OpenSearch | ||
|
||
Hello! | ||
- [OpenSearch](#opensearch) | ||
- [Welcome!](#welcome) | ||
- [Project Resources](#project-resources) | ||
- [Code of Conduct](#code-of-conduct) | ||
- [License](#license) | ||
- [Copyright](#copyright) | ||
|
||
OpenSearch is an open source search and analytics engine derived from Elasticsearch 7.10.2, and is currently in an alpha state. While we're still in the process of getting set up, we are excited to build the best distributed search engine on the planet with you. | ||
## Welcome! | ||
|
||
We officially began work on the new fork on January 21st, 2021. Since then, we've been removing non-Apache 2.0 compliant code and doing a full rename of the project. Feel free to take a look around at what we've been up to, and then head over to look at the [open issues](https://github.com/opensearch-project/OpenSearch/issues). Or you could jump right in and [start opening issues](https://github.com/opensearch-project/OpenSearch/issues/new/choose) or [contributing](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md). | ||
**OpenSearch** is [a community-driven, open source fork](https://aws.amazon.com/blogs/opensource/introducing-opensearch/) of [Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch) and [Kibana](https://en.wikipedia.org/wiki/Kibana) following the [licence change](https://opensource.org/node/1099) in early 2021. We're looking to sustain (and evolve!) a search and analytics suite for the multitude of businesses who are dependent on the rights granted by the original, [Apache v2.0 License](LICENSE.txt). | ||
|
||
## Getting Started | ||
## Project Resources | ||
|
||
If you would like to install and run this project, please see the [Downloads Page](https://opensearch.org/downloads.html). | ||
If you would like to build, install and run this project please see the [Developer Guide](https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md). | ||
* [Project Website](https://opensearch.org/) | ||
* [Downloads](https://opensearch.org/downloads.html). | ||
* [Documentation](https://docs-beta.opensearch.org/) | ||
* Need help? Try [Forums](https://discuss.opendistrocommunity.dev/) | ||
* [Project Principles](https://opensearch.org/#principles) | ||
* [Contributing to OpenSearch](CONTRIBUTING.md) | ||
* [Maintainer Responsibilities](MAINTAINERS.md) | ||
* [Release Management](RELEASING.md) | ||
* [Admin Responsibilities](ADMINS.md) | ||
* [Testing](TESTING.md) | ||
* [Security](SECURITY.md) | ||
|
||
## Guiding Principles | ||
## Code of Conduct | ||
|
||
Here are the principles we use to guide our development. From [opensearch.org](http://opensearch.org): | ||
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. | ||
|
||
## License | ||
|
||
> When we (the contributors) are successful, the OpenSearch project will be: | ||
> | ||
>**1. Great software**. If it doesn’t solve your problems, everything else is moot. It’s going to be software you love to use. | ||
> | ||
>**2. Open source like we mean it**. We are invested in this being a successful open source project for the long term. It’s all Apache 2.0. There’s no Contributor License Agreement. Easy. | ||
> | ||
>**3. A level playing field**. We will not tweak the software so that it runs better for any vendor (including AWS) at the expense of others. If this happens, call it out and we will fix it as a community. | ||
> | ||
>**4. Used everywhere**. Our goal is for as many people as possible to use it in their business, their software, and their projects. Use it however you want. Surprise us! | ||
> | ||
>**5. Made with your input**. We will ask for public input on direction, requirements, and implementation for any feature we build. | ||
> | ||
>**6. Open to contributions**. Great open source software is built together, with a diverse community of contributors. If you want to get involved at any level - big, small, or huge - we will find a way to make that happen. We don’t know what that looks like yet, and we look forward to figuring it out together. | ||
> | ||
>**7. Respectful, approachable, and friendly**. This will be a community where you will be heard, accepted, and valued, whether you are a new or experienced user or contributor. | ||
> | ||
>**8. A place to invent**. You will be able to innovate rapidly. This project will have a stable and predictable foundation that is modular, making it easy to extend. | ||
This project is licensed under the [Apache v2.0 License](LICENSE.txt). | ||
|
||
## How you can help | ||
## Copyright | ||
|
||
### Look for the tag "help wanted" | ||
|
||
If you're excited to jump in, we've marked a few issues that would be [really helpful](https://github.com/opensearch-project/OpenSearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). | ||
|
||
### Watch the forum, because there are a bunch of things we want to talk about | ||
As we've been working, we've come up with a bunch of questions that we wanted to get community feedback on. Now that we're done with this first pass of renaming, you'll see us posting those questions to the [forums](https://discuss.opendistrocommunity.dev/). Please let us know your thoughts! | ||
|
||
### Questions? Feedback? | ||
|
||
Found a bug or need to leave feedback? Make sure you open an [issue](https://github.com/opensearch-project/OpenSearch/issues/new/choose). | ||
Questions and discussions on this project can be found on the project [forums](https://discuss.opendistrocommunity.dev/). | ||
Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## Releasing | ||
|
||
This project follows [OpenSearch project branching, labelling, and releasing](https://github.com/opensearch-project/.github/blob/main/RELEASING.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |