level up markdowns and readme

Signed-off-by: Zhongnan Su <szhongna@amazon.com>
opensearch-project · Jun 23, 2021 · 5ec6585 · 5ec6585
1 parent e5a9bfc
commit 5ec6585
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 16 deletions.
diff --git a/ADMINS.md b/ADMINS.md
@@ -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).
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -1,9 +1,9 @@
-# Dashboards Reports Maintainers
-
 ## Maintainers
 | Maintainer             | GitHub ID                                         | Affiliation |
 |------------------------|---------------------------------------------------|-------------|
 | Anantha Krishna Bhatta | [akbhatta](https://github.com/akbhatta)           | Amazon      |
 | David Cui              | [davidcui-amzn](https://github.com/davidcui-amzn) | Amazon      |
 | Joshua Li              | [joshuali925](https://github.com/joshuali925)     | Amazon      |
 | Zhongnan Su            | [zhongnansu](https://github.com/zhongnansu)       | 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
@@ -4,20 +4,36 @@
 [![Documentation](https://img.shields.io/badge/documentation-blue.svg)](https://docs-beta.opensearch.org/docs/opensearch-dashboards/reporting/)
 ![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)
 
+<img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/>
+
+- [OpenSearch Dashboards Reports](#opensearch-dashboards-reports)
+- [Contributing](#contributing)
+- [Setup](#setup-&-build)
+- [Notifications Integration](#notifications-integration)
+- [Troubleshooting](#troubleshooting)
+- [Code of Conduct](#code-of-conduct)
+- [Security](#security)
+- [License](#license)
+- [Copyright](#copyright)
+
 # OpenSearch Dashboards Reports
 
 OpenSearch Dashboards Reports allows ‘Report Owner’ (engineers, including but not limited to developers, DevOps, IT Engineer, and IT admin) export and share reports from OpenSearch Dashboards dashboards, saved search, alerts and visualizations. It helps automate the process of scheduling reports on an on-demand or a periodical basis (on cron schedules as well). Further, it also automates the process of exporting and sharing reports triggered for various alerts. The feature is present in the Dashboard, Discover, and Visualization tabs. We are currently working on integrating Dashboards Reports with Notifications to enable sharing functionality. After the support is introduced, scheduled reports can be sent to (shared with) self or various stakeholders within the organization. These stakeholders include but are not limited to, executives, managers, engineers (developers, DevOps, IT Engineer) in the form of pdf, hyperlinks, csv, excel via various channels such as email, Slack, and Amazon Chime. However, in order to export, schedule and share reports, report owners should have the necessary permissions as defined under Roles and Privileges.
 
-# Request for Comments ( RFC )
+## Contributing
 
-Please add your feature requests here [ New Requests ](https://github.com/opensearch-project/dashboards-reports/issues) and view project progress here [RFCs](https://github.com/opensearch-project/dashboards-reports/projects/1).
+We welcome you to get involved in development, documentation, testing the OpenSearch Dashboards reports plugin. See our [CONTRIBUTING.md](./CONTRIBUTING.md) and join in.
 
 ## Setup & Build
 
 Complete OpenSearch Dashboards Report feature is composed of 2 plugins. Refer to README in each plugin folder for more details.
 
 - [OpenSearch Dashboards reports plugin](./dashboards-reports/README.md)
-- [Reports scheduler ES plugin](./reports-scheduler/README.md)（TODO）
+- [OpenSearch Reports scheduler plugin](./reports-scheduler/README.md)（TODO）
+
+## Notifications Integration
+
+OpenSearch Dashboards Reports integration with [Notifications](https://github.com/opensearch-project/notifications) is currently in progress, tracking for the 8/30 OpenSearch 1.1 release.
 
 ## Troubleshooting
 
@@ -28,20 +44,11 @@ There could be two reasons for this problem
 1. You are not having the correct version of headless-chrome matching to the OS that your OpenSearch Dashboards is running. Different versions of headless-chrome can be found [here](https://github.com/opensearch-project/dashboards-reports/releases/tag/chromium-1.12.0.0)
 
 2. Missing additional dependencies. Please refer to [additional dependencies section](./dashboards-reports/rendering-engine/headless-chrome/README.md#additional-libaries) to install required dependencies according to your operating system.
-
-## Contributing to OpenSearch Dashboards reports
-
-We welcome you to get involved in development, documentation, testing the OpenSearch Dashboards reports plugin. See our [CONTRIBUTING.md](./CONTRIBUTING.md) and join in.
-
-## Notifications Integration
-
-OpenSearch Dashboards Reports integration with [Notifications](https://github.com/opensearch-project/notifications) is currently in progress, tracking for the 8/30 OpenSearch 1.1 release.
-
 ## Code of Conduct
 
-This project has adopted an [Open Source Code of Conduct](https://opensearch.org/codeofconduct.html).
+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.
 

diff --git a/RELEASING.md b/RELEASING.md
@@ -0,0 +1 @@
+This project follows [OpenSearch branching, labelling, and releasing](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 @@
		This project follows [OpenSearch branching, labelling, and releasing](https://github.com/opensearch-project/.github/blob/main/RELEASING.md).
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 aws-security@amazon.com. Please do not create a public GitHub issue.