From 86b88c51a7145a1ea0fdb386a8e0a435f6922406 Mon Sep 17 00:00:00 2001 From: Huan Jiang Date: Mon, 4 Apr 2022 14:17:55 -0700 Subject: [PATCH 1/2] Initial draft for project readme Signed-off-by: Huan Jiang --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 847260c..e943a0f 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,32 @@ -## My Project + -TODO: Fill this README out! +- [Welcome!](#Dashboards Desktop) +- [Security!](#Security) +- [License!](#License) +- [Copyright](#copyright) -Be sure to: +## Dashboards Desktop -* Change the title in this README -* Edit your repository description on GitHub +Dashboards Desktop offers desktop experiene to OpenSearch Dashboards Users. OpenSearch Dashboards is an open source search and analytics visualization application. + +Dashboards Desktop provides end user *flexibility* and *extensibility* to install any Dashboards pluings they want. Dashboards Desktop could store data into local storage or cloud drive. User has full control of the data they have. + +Dashboards Desktop could be downloaded from internet. Not only deliver stable version to customer in monthly/quarterly release cadence. It will deliver experimental versions. + +Deskboards has build-in data source selector which allow user to connect to any OpenSearch endpoint they want with pre-configured credential or access key. ## Security See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information. +## Code of Conduct + +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. + ## License This project is licensed under the Apache-2.0 License. +## Copyright + +Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details. From 011b3f0c17dfe7c73cbd556abc9188d57dbb4675 Mon Sep 17 00:00:00 2001 From: Huan Jiang Date: Tue, 5 Apr 2022 09:14:41 -0700 Subject: [PATCH 2/2] fix broken anchor link Signed-off-by: Huan Jiang --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e943a0f..bd5a217 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -- [Welcome!](#Dashboards Desktop) -- [Security!](#Security) -- [License!](#License) +- [Welcome!](#welcome) +- [Security!](#security) +- [License!](#license) - [Copyright](#copyright) -## Dashboards Desktop +## Welcome Dashboards Desktop offers desktop experiene to OpenSearch Dashboards Users. OpenSearch Dashboards is an open source search and analytics visualization application. @@ -29,4 +29,4 @@ This project is licensed under the Apache-2.0 License. ## Copyright -Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details. +Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details. \ No newline at end of file