Updated READMEs on releasing, maintaining, admins and security. (#853)
* Updated READMEs on releasing, maintaining, admins and security. Signed-off-by: dblock <dblock@amazon.com> * Ensuing -> following. Signed-off-by: dblock <dblock@amazon.com>
This commit is contained in:
Daniel Doubrovkine (dB.)
GitHub
parent
11babe7782
commit
6018a5d6d3
|
|
@ -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).
|
||||
|
|
@ -1,6 +1,5 @@
|
|||
# OpenSearch Maintainers
|
||||
|
||||
## Maintainers
|
||||
|
||||
| Maintainer | GitHub ID | Affiliation |
|
||||
| --------------- | --------- | ----------- |
|
||||
| Abbas Hussain | [abbashus](https://github.com/abbashus) | Amazon |
|
||||
|
|
@ -16,3 +15,5 @@
|
|||
| Shweta Thareja |[shwetathareja](https://github.com/shwetathareja) | Amazon |
|
||||
| Itiyama Sadana | [itiyamas](https://github.com/itiyamas) | Amazon |
|
||||
| Daniel "dB." Doubrovkine | [dblock](https://github.com/dblock) | 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).
|
||||
|
|
|
|||
68
README.md
68
README.md
|
|
@ -1,49 +1,37 @@
|
|||
<img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/>
|
||||
|
||||
**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) ensuing 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 2.0,
|
||||
licence.
|
||||
- [Welcome!](#welcome)
|
||||
- [Project Resources](#project-resources)
|
||||
- [Code of Conduct](#code-of-conduct)
|
||||
- [License](#license)
|
||||
- [Copyright](#copyright)
|
||||
|
||||
To install and run this project, please see the [Downloads Page](https://opensearch.org/downloads.html).
|
||||
## Welcome!
|
||||
|
||||
## How you can help
|
||||
**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).
|
||||
|
||||
We love issues. The best thing you can do for us is to [start opening issues](https://github.com/opensearch-project/OpenSearch/issues/new/choose).
|
||||
Just jump right in and don't hesitate to [contribute](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md)
|
||||
if anything strikes your fancy. In case you don't know where to start, we've
|
||||
marked a few [open issues](https://github.com/opensearch-project/OpenSearch/issues)
|
||||
that would be [really helpful](https://github.com/opensearch-project/OpenSearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
|
||||
There's also a [Developer Guide](https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md)
|
||||
to help you on your way.
|
||||
## Project Resources
|
||||
|
||||
Additionally, we have a [forum](https://discuss.opendistrocommunity.dev/)
|
||||
dedicated to more general questions and discussions concerning the OpenSearch
|
||||
project as a whole. It's a space for community feedback and we'd be grateful to
|
||||
hear your opinions and suggestions.
|
||||
* [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 [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments.
|
||||
|
||||
> 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.
|
||||
## License
|
||||
|
||||
This project is licensed under the [Apache v2.0 License](LICENSE.txt).
|
||||
|
||||
## Copyright
|
||||
|
||||
Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
## Releasing
|
||||
|
||||
This project follows [OpenSearch project branching, labelling, and releasing](https://github.com/opensearch-project/.github/blob/main/RELEASING.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 aws-security@amazon.com. Please do **not** create a public GitHub issue.
|
||||
Loading…
Reference in New Issue