Update and add documentation files (opensearch-project#38)

ohltyler · web-flow · commit 8919c8f11037 · 2021-06-24T12:45:26.000-07:00
Signed-off-by: Tyler Ohlsen &lt;ohltyler@amazon.com&gt;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,100 +1,4 @@
-# Contributing Guidelines
+## Contributing to this Project
 
-Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
-documentation, we greatly value feedback and contributions from our community.
-
-Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
-information to effectively respond to your bug report or contribution.
-
-## Reporting Bugs/Feature Requests
-
-We welcome you to use the GitHub issue tracker to report bugs or suggest features.
-
-When filing an issue, please check [existing open](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin/issues), or [recently closed](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
-reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
-
-- A reproducible test case or series of steps
-- The version of our code being used
-- Any modifications you've made relevant to the bug
-- Anything unusual about your environment or deployment
-
-## Contributing via Pull Requests
-
-Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
-
-1. You are working against the latest source on the _main_ branch.
-2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
-3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
-
-To send us a pull request, please:
-
-1. Fork the repository.
-2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
-3. Ensure local tests pass.
-4. Commit to your fork using clear commit messages.
-5. Send us a pull request, answering any default questions in the pull request interface.
-6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
-
-GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
-[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
-
-## Finding contributions to work on
-
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin/labels/help%20wanted) issues is a great place to start.
-
-## Developer Certificate of Origin
-
-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.
-
-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.
-
-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/).
-
-```
-Developer's Certificate of Origin 1.1
-
-By making a contribution to this project, I certify that:
-
-(a) The contribution was created in whole or in part by me and I
-    have the right to submit it under the open source license
-    indicated in the file; or
-
-(b) The contribution is based upon previous work that, to the
-    best of my knowledge, is covered under an appropriate open
-    source license and I have the right under that license to
-    submit that work with modifications, whether created in whole
-    or in part by me, under the same open source license (unless
-    I am permitted to submit under a different license), as
-    Indicated in the file; or
-
-(c) The contribution was provided directly to me by some other
-    person who certified (a), (b) or (c) and I have not modified
-    it.
-
-(d) I understand and agree that this project and the contribution
-    are public and that a record of the contribution (including
-    all personal information I submit with it, including my
-    sign-off) is maintained indefinitely and may be redistributed
-    consistent with this project or the open source license(s)
-    involved.
-```
-
-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.
-
-Each commit must include a DCO which looks like this
-
-```
-Signed-off-by: Jane Smith <jane.smith@email.com>
-```
-
-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.
-
-## Security issue notifications
-
-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.
-
-## Licensing
-
-See the [LICENSE](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin/blob/main/LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
-
-We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
+OpenSearch is a community project that is built and maintained by people just like **you**.
+[This document](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md) explains how you can contribute to this and related projects.
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -0,0 +1,71 @@
+- [Developer guide](#developer-guide)
+  - [Forking and Cloning](#forking-and-cloning)
+  - [Install Prerequisites](#install-prerequisites)
+  - [Environment Setup](#environment-setup)
+  - [Build](#build)
+  - [Run](#run)
+  - [Test](#test)
+
+## Developer guide
+
+So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do.
+
+### Forking and Cloning
+
+Fork this repository on GitHub, and clone locally with `git clone`.
+
+### Install Prerequisites
+
+You will need to install [node.js](https://nodejs.org/en/), [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md), and [yarn](https://yarnpkg.com/) in your environment to properly pull down dependencies to build and bootstrap the plugin.
+
+### Environment Setup
+
+1. Download OpenSearch for the version that matches the [OpenSearch Dashboards version specified in package.json](./package.json#L7).
+2. Download and install the appropriate [Anomaly Detection OpenSearch Plugin](https://github.com/opensearch-project/anomaly-detection).
+3. Download the OpenSearch Dashboards source code for the [version specified in package.json](./package.json#L7) you want to set up.
+
+   See the [OpenSearch Dashboards contributing guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/CONTRIBUTING.md) and [developer guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md) for more instructions on setting up your development environment.
+
+4. Change your node version to the version specified in `.node-version` inside the OpenSearch Dashboards root directory (this can be done with the `nvm use` command).
+5. Create a `plugins` directory inside the OpenSearch Dashboards source code directory, if `plugins` directory doesn't exist.
+6. Check out this package from version control into the `plugins` directory.
+7. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards/plugins/anomaly-detection-dashboards-plugin`.
+
+Ultimately, your directory structure should look like this:
+
+<!-- prettier-ignore -->
+```md
+.
+├── OpenSearch-Dashboards
+│   └──plugins
+│      └── anomaly-detection-dashboards-plugin
+```
+
+### Build
+
+To build the plugin's distributable zip simply run `yarn build`.
+
+Example output: `./build/anomalyDetectionDashboards-1.0.0.0.zip`
+
+### Run
+
+In the base OpenSearch Dashboards directory, run
+
+- `yarn start --no-base-path`
+
+  Starts OpenSearch Dashboards and includes this plugin. OpenSearch Dashboards will be available on `localhost:5601`.
+
+### Test
+
+- `yarn test:jest`
+
+  Runs the plugin unit tests.
+
+- `yarn test:e2e`
+
+  Start OpenSearch Dashboards, wait for it to be available on `localhost:5601`, and runs end-to-end tests.
+
+- `yarn cy:run`
+
+  Runs end-to-end tests on a currently running OpenSearch Dashboards server. Defaults to run the tests on `localhost:5601`, although you can change this to run on any
+  OpenSearch Dashboards server with the command `yarn cy:run --config baseUrl=<your-custom-URL>`
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -9,4 +9,5 @@
 | Yizhe Liu               | [yizheliu-amazon](https://github.com/yizheliu-amazon)   | Amazon      |
 | Vijayan Balasubramanian | [VijayanB](https://github.com/VijayanB)                 | Amazon      |
 | Sarat Vemulapalli       | [saratvemulapalli](https://github.com/saratvemulapalli) | Amazon      |
-| Weicong Sun             | [weicongs-amazon](https://github.com/weicongs-amazon)   | 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).
diff --git a/README.md b/README.md
@@ -5,95 +5,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)
 ![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)
 
-## OpenSearch Anomaly Detection Dashboards
+<img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/>
 
-The OpenSearch Anomaly Detection Dashboards 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 OpenSearch Dashboards interface and a powerful API, it is easy to set up, tune, and monitor your anomaly detectors.
+- [OpenSearch Anomaly Detection Dashboards Plugin](#opensearch-anomaly-detection-dashboards-plugin)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [Code of Conduct](#code-of-conduct)
+- [Security](#security)
+- [License](#license)
+- [Copyright](#copyright)
 
-## Highlights
+## OpenSearch Anomaly Detection Dashboards Plugin
 
-Anomaly detection is using Random Cut Forest (RCF) algorithm for detecting anomalous data points.
+The OpenSearch Anomaly Detection Dashboards plugin enables you to leverage Machine Learning based algorithms to automatically detect anomalies as your log data is ingested. Combined with [Alerting](https://docs-beta.opensearch.org/monitoring-plugins/alerting/index/), you can monitor your data in near real time and automatically send alert notifications. With an intuitive OpenSearch Dashboards interface and a powerful API, it is easy to set up, tune, and monitor your anomaly detectors.
 
-You should use the plugin with the same version of the [OpenSearch Alerting Dashboards plugin](https://github.com/opensearch-project/alerting-dashboards-plugin). You can also create monitors based on a created anomaly detector. A scheduled monitor run checks the anomaly detection results regularly and collects anomalies to trigger alerts based on custom trigger conditions.
+Anomaly detection uses the Random Cut Forest (RCF) algorithm for detecting anomalous data points.
 
-## Current Limitations
-
-- We will continuously add new unit test cases, but we don't have 100% unit test coverage for now. This is a great area for developers from the community to contribute and help improve test coverage.
-- Please see documentation links and GitHub issues for other details.
+You should use the plugin with the same version of the [OpenSearch Alerting Dashboards Plugin](https://github.com/opensearch-project/alerting-dashboards-plugin). You can also create monitors based on a created anomaly detector. A scheduled monitor run checks the anomaly detection results regularly and collects anomalies to trigger alerts based on custom trigger conditions.
 
 ## Documentation
 
 Please see our [documentation](https://docs-beta.opensearch.org/monitoring-plugins/ad/index/).
 
-## Setup
-
-1. Download OpenSearch for the version that matches the [OpenSearch Dashboards version specified in package.json](./package.json#L7).
-1. Download and install the appropriate [Anomaly Detection OpenSearch plugin](https://github.com/opensearch-project/anomaly-detection).
-1. Download the OpenSearch Dashboards source code for the [version specified in package.json](./package.json#L7) you want to set up.
-
-   See the [OpenSearch Dashboards contributing guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/CONTRIBUTING.md) and [developer guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md) for more instructions on setting up your development environment.
-
-1. Change your node version to the version specified in `.node-version` inside the OpenSearch Dashboards root directory.
-1. Create a `plugins` directory inside the OpenSearch Dashboards source code directory, if `plugins` directory doesn't exist.
-1. Check out this package from version control into the `plugins` directory.
-1. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards/plugins/anomaly-detection-dashboards-plugin`.
-
-Ultimately, your directory structure should look like this:
-
-<!-- prettier-ignore -->
-```md
-.
-├── OpenSearch-Dashboards
-│   └──plugins
-│      └── anomaly-detection-dashboards-plugin
-```
-
-## Build
-
-To build the plugin's distributable zip simply run `yarn build`.
-
-Example output: `./build/anomalyDetectionDashboards-1.0.0.0.zip`
-
-## Run
-
-In the base OpenSearch Dashboards directory, run
-
-- `yarn start --no-base-path`
-
-  Starts OpenSearch Dashboards and includes this plugin. OpenSearch Dashboards will be available on `localhost:5601`.
-
-## Test
-
-- `yarn test:jest`
-
-  Runs the plugin unit tests.
-
-- `yarn test:e2e`
-
-  Start OpenSearch Dashboards, wait for it to be available on `localhost:5601`, and runs end-to-end tests.
-
-- `yarn cy:run`
-
-  Runs end-to-end tests on a currently running OpenSearch Dashboards server. Defaults to run the tests on `localhost:5601`, although you can change this to run on any
-  OpenSearch Dashboards server with the command `yarn cy:run --config baseUrl=<your-custom-URL>`
-
 ## Contributing
 
-We welcome you to get involved in development, documentation, testing the anomaly detection plugin. See our [CONTRIBUTING.md](CONTRIBUTING.md) and join in.
-
-Since this is a OpenSearch Dashboards plugin, it can be useful to review the [OpenSearch Dashboards contributing guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/CONTRIBUTING.md) as well as the [developer guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md) to help get started.
+See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md).
 
 ## Code of Conduct
 
-This project has adopted an [Open Source Code of Conduct](CODE_OF_CONDUCT.md).
+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.
 
-## Security issue notifications
+## Security
 
 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.
 
 ## License
 
-See the [LICENSE](LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+This project is licensed under the [Apache v2.0 License](LICENSE.txt).
 
 ## Copyright
 
-Copyright 2021 OpenSearch Contributors
+Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
diff --git a/RELEASING.md b/RELEASING.md
@@ -0,0 +1 @@
+This project follows the [OpenSearch release process](https://github.com/opensearch-project/.github/blob/main/RELEASING.md).
diff --git a/SECURITY.md b/SECURITY.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.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+This project follows the [OpenSearch release process](https://github.com/opensearch-project/.github/blob/main/RELEASING.md).`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## Reporting a Vulnerability`
	`2`	`+`
	`3`	`+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.`