Skip to content

Commit 639e835

Browse files
Updating the license and docs (#7)
* Update license and docs with latest changes from OpenSearch Signed-off-by: Sarat Vemulapalli <vemulapallisarat@gmail.com>
1 parent bcdab8f commit 639e835

10 files changed

+151
-26
lines changed
+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### Description
2+
[Describe what this change achieves]
3+
4+
### Issues Resolved
5+
[List any issues this PR will resolve]
6+
7+
### Check List
8+
- [ ] New functionality includes testing.
9+
- [ ] All tests pass
10+
- [ ] New functionality has been documented.
11+
- [ ] New functionality has javadoc added
12+
- [ ] Commits are signed per the DCO using --signoff
13+
14+
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
15+
For more information on following Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/anomaly-detection/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

CODE_OF_CONDUCT.md

+25-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,25 @@
1-
## Code of Conduct
2-
This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html).
1+
2+
This code of conduct applies to all spaces provided by the OpenSource project including in code, documentation, issue trackers, mailing lists, chat channels, wikis, blogs, social media and any other communication channels used by the project.
3+
4+
5+
**Our open source communities endeavor to:**
6+
7+
* Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language.
8+
* Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute.
9+
* Be Respectful: We are committed to encouraging differing viewpoints, accepting constructive criticism and work collaboratively towards decisions that help the project grow. Disrespectful and unacceptable behavior will not be tolerated.
10+
* Be Collaborative: We are committed to supporting what is best for our community and users. When we build anything for the benefit of the project, we should document the work we do and communicate to others on how this affects their work.
11+
12+
13+
**Our Responsibility. As contributors, members, or bystanders we each individually have the responsibility to behave professionally and respectfully at all times. Disrespectful and unacceptable behaviors include, but are not limited to:**
14+
15+
* The use of violent threats, abusive, discriminatory, or derogatory language;
16+
* Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
17+
* Posting of sexually explicit or violent content;
18+
* The use of sexualized language and unwelcome sexual attention or advances;
19+
* Public or private harassment of any kind;
20+
* Publishing private information, such as physical or electronic address, without permission;
21+
* Other conduct which could reasonably be considered inappropriate in a professional setting;
22+
* Advocating for or encouraging any of the above behaviors.
23+
* Enforcement and Reporting Code of Conduct Issues:
24+
25+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported. [Contact us](mailto:opensource-codeofconduct@amazon.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.

CONTRIBUTING.md

+46-1
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,54 @@ Looking at the existing issues is a great way to find something to contribute on
4646

4747
## Code of Conduct
4848

49-
This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html).
49+
Please refer to [Code of Conduct](./CODE_OF_CONDUCT.md) on this repository.
5050

5151

52+
## Developer Certificate of Origin
53+
54+
OpenSearch is an open source product released under the Apache 2.0 license (see either [the Apache site](https://www.apache.org/licenses/LICENSE-2.0) or the [LICENSE.txt file](./LICENSE.txt)). The Apache 2.0 license allows you to freely use, modify, distribute, and sell your own products that include Apache 2.0 licensed software.
55+
56+
We respect intellectual property rights of others and we want to make sure all incoming contributions are correctly attributed and licensed. A Developer Certificate of Origin (DCO) is a lightweight mechanism to do that.
57+
58+
The DCO is a declaration attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a `Signed-off-by` statement and thereby agrees to the DCO, which you can find below or at [DeveloperCertificate.org](http://developercertificate.org/).
59+
60+
```
61+
Developer's Certificate of Origin 1.1
62+
63+
By making a contribution to this project, I certify that:
64+
65+
(a) The contribution was created in whole or in part by me and I
66+
have the right to submit it under the open source license
67+
indicated in the file; or
68+
69+
(b) The contribution is based upon previous work that, to the
70+
best of my knowledge, is covered under an appropriate open
71+
source license and I have the right under that license to
72+
submit that work with modifications, whether created in whole
73+
or in part by me, under the same open source license (unless
74+
I am permitted to submit under a different license), as
75+
Indicated in the file; or
76+
77+
(c) The contribution was provided directly to me by some other
78+
person who certified (a), (b) or (c) and I have not modified
79+
it.
80+
81+
(d) I understand and agree that this project and the contribution
82+
are public and that a record of the contribution (including
83+
all personal information I submit with it, including my
84+
sign-off) is maintained indefinitely and may be redistributed
85+
consistent with this project or the open source license(s)
86+
involved.
87+
```
88+
We require that every contribution to OpenSearch is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms.
89+
90+
Each commit must include a DCO which looks like this
91+
92+
```
93+
Signed-off-by: Jane Smith <jane.smith@email.com>
94+
```
95+
You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `-s` or `– – signoff` to add the `Signed-off-by` line to the end of the commit message.
96+
5297
## Security issue notifications
5398

5499
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/). Please do **not** create a public GitHub issue.

CONTRIBUTORS

-18
This file was deleted.

MAINTAINERS.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# OpenSearch Anomaly Detection Maintainers
2+
3+
## Maintainers
4+
| Maintainer | GitHub ID | Affiliation |
5+
| --------------- | --------- | ----------- |
6+
| Hanguang Zhang | [zhanghg08](https://github.com/zhanghg08) | Amazon |
7+
| Jack Mazanec | [jmazanec15](https://github.com/jmazanec15) | Amazon |
8+
| Jing Zhang | [jngz-es](https://github.com/jngz-es) | Amazon |
9+
| Kaituo Li | [kaituo](https://github.com/kaituo) | Amazon |
10+
| Lai Jiang | [wnbts](https://github.com/wnbts) | Amazon |
11+
| Sarat Vemulapalli | [saratvemulapalli](https://github.com/saratvemulapalli) | Amazon |
12+
| Tyler Ohlsen | [ohtyler](https://github.com/ohltyler) | Amazon |
13+
| Vamshi Vijay Nakkirtha | [vamshin](https://github.com/vamshin) | Amazon |
14+
| Vijayan Balasubramanian | [VijayanB](https://github.com/VijayanB) | Amazon |
15+
| Weicong Sun | [weicongs-amazon](https://github.com/weicongs-amazon) | Amazon |
16+
| Yaliang Wu | [ylwu-amzn](https://github.com/ylwu-amzn) | Amazon |
17+
| Yizhe Liu | [yizheliu-amazon](https://github.com/yizheliu-amazon) | Amazon |

NOTICE.txt

+12-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
1-
Open Distro For Elasticsearch Anomaly Detection
2-
Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
OpenSearch
2+
Copyright 2021 OpenSearch Contributors
3+
4+
This product includes software developed by
5+
Elasticsearch (http://www.elastic.co).
6+
Copyright 2009-2018 Elasticsearch
7+
8+
This product includes software developed by The Apache Software
9+
Foundation (http://www.apache.org/).
10+
11+
This product includes software developed by
12+
Joda.org (http://www.joda.org/).

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
[![Forum](https://img.shields.io/badge/chat-on%20forums-blue)](https://discuss.opendistrocommunity.dev/c/Use-this-category-for-all-questions-around-machine-learning-plugins)
55
![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)
66

7-
## Open Distro for Elasticsearch Anomaly Detection
7+
## OpenSearch Anomaly Detection
88

9-
The Open Distro for Elasticsearch Anomaly Detection plugin enables you to leverage Machine Learning based algorithms to automatically detect anomalies as your log data is ingested. Combined with Alerting, you can monitor your data in near real time and automatically send alert notifications . With an intuitive Kibana interface and a powerful API, it is easy to set up, tune, and monitor your anomaly detectors.
9+
The OpenSearch Anomaly Detection plugin enables you to leverage Machine Learning based algorithms to automatically detect anomalies as your log data is ingested. Combined with Alerting, you can monitor your data in near real time and automatically send alert notifications . With an intuitive Kibana interface and a powerful API, it is easy to set up, tune, and monitor your anomaly detectors.
1010

1111
## Highlights
1212

build.gradle

+11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
/*
2+
* SPDX-License-Identifier: Apache-2.0
3+
*
4+
* The OpenSearch Contributors require contributions made to
5+
* this file be licensed under the Apache-2.0 license or a
6+
* compatible open source license.
7+
*
8+
* Modifications Copyright OpenSearch Contributors. See
9+
* GitHub history for details.
10+
*/
11+
112
/*
213
* Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
314
*

gradle/wrapper/gradle-wrapper.properties

+11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
/*
2+
* SPDX-License-Identifier: Apache-2.0
3+
*
4+
* The OpenSearch Contributors require contributions made to
5+
* this file be licensed under the Apache-2.0 license or a
6+
* compatible open source license.
7+
*
8+
* Modifications Copyright OpenSearch Contributors. See
9+
* GitHub history for details.
10+
*/
11+
112
/*
213
* Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
314
*

settings.gradle

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
/*
2+
* SPDX-License-Identifier: Apache-2.0
3+
*
4+
* The OpenSearch Contributors require contributions made to
5+
* this file be licensed under the Apache-2.0 license or a
6+
* compatible open source license.
7+
*
8+
* Modifications Copyright OpenSearch Contributors. See
9+
* GitHub history for details.
10+
*/
11+
112
/*
213
* Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
314
*
@@ -13,4 +24,4 @@
1324
* permissions and limitations under the License.
1425
*/
1526

16-
rootProject.name = 'opendistro-anomaly-detection'
27+
rootProject.name = 'opensearch-anomaly-detection'

0 commit comments

Comments
 (0)