From 83ebdaf11d9e1c1221d913288722abcb055e4497 Mon Sep 17 00:00:00 2001 From: Suyash Srivastava Date: Sat, 19 Aug 2023 02:48:52 +0530 Subject: [PATCH] Updated README.md (#4769) Changed a Typo in README.md file Signed-off-by: Suyash Srivastava (cherry picked from commit 061e4767404691719d2c3a276f7600ebbf91e37e) Signed-off-by: Ashwin P Chandran --- README.md | 43 ++++++++++++++++++++++++++++++------------- 1 file changed, 30 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2182eab3a6fb..4d4924046027 100644 --- a/README.md +++ b/README.md @@ -8,23 +8,33 @@ ## Welcome -OpenSearch Dashboards is an open source search and analytics visualization. We aim to be the best community-driven platform and provide all the contributors a great open source experience. +OpenSearch Dashboards is an open-source data visualization tool designed to work with OpenSearch. OpenSearch Dashboards gives you data visualization tools to improve and automate business intelligence and support data-driven decision-making and strategic planning. -Feel free to take a look at what the community has been up to, and then head over to the [Project Board](https://github.com/opensearch-project/OpenSearch-Dashboards/projects) to track release targets, or jump in and [start opening issues](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/new/choose), [set up your development environment](DEVELOPER_GUIDE.md#getting-started), or [start contributing](CONTRIBUTING.md). +We aim to be an exceptional community-driven platform and to foster open participation and collective contribution with all contributors. Stay up to date on what's happening with the OpenSearch Project by tracking GitHub [issues](https://github.com/opensearch-project/OpenSearch-Dashboards/issues) and [pull requests](https://github.com/opensearch-project/OpenSearch-Dashboards/pulls). + +You can [contribute to this project](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/CONTRIBUTING.md) by [opening issues](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/new/choose) to give feedback, share ideas, identify bugs, and contribute code. + +Set up your [OpenSearch Dashboards development environment](ttps://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md#getting-started-guide) today! The project team looks forward to your contributions. + +## Code Summary + +[![Build and Test][build-and-test-badge]][build-and-test-link] +[![Unit Test Code Coverage][codecov-badge]][codecov-link] +[![Link Checker][link-checker-badge]][link-checker-link] ## Project Resources -* [Project Website](https://opensearch.org/) -* [Downloads](https://opensearch.org/downloads.html) -* [Documentation](https://opensearch.org/docs/) -* Need help? Try [Forums](https://discuss.opendistrocommunity.dev/) -* [Project Principles](https://opensearch.org/#principles) -* [Developer Guide](DEVELOPER_GUIDE.md) -* [Contributing to OpenSearch](CONTRIBUTING.md) -* [Maintainer Responsibilities](MAINTAINERS.md) -* [Release Management](RELEASING.md) -* [Testing](TESTING.md) -* [Security](SECURITY.md) +- [Project Website](https://opensearch.org/) +- [Downloads](https://opensearch.org/downloads.html) +- [Documentation](https://opensearch.org/docs/) +- Need help? See the [communication guide](COMMUNICATIONS.md) for various options +- [Project Principles](https://opensearch.org/#principles) +- [Developer Guide](DEVELOPER_GUIDE.md) +- [Contributing to OpenSearch](CONTRIBUTING.md) +- [Maintainer Responsibilities](MAINTAINERS.md) +- [Release Management](RELEASING.md) +- [Testing](TESTING.md) +- [Security](SECURITY.md) ## Code of Conduct @@ -37,3 +47,10 @@ This project is licensed under the [Apache v2.0 License](LICENSE.txt). ## Copyright Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details. + +[build-and-test-badge]: https://github.com/opensearch-project/OpenSearch-Dashboards/actions/workflows/build_and_test_workflow.yml/badge.svg +[build-and-test-link]: https://github.com/opensearch-project/OpenSearch-Dashboards/actions/workflows/build_and_test_workflow.yml +[codecov-badge]: https://codecov.io/gh/opensearch-project/OpenSearch-Dashboards/branch/main/graphs/badge.svg +[codecov-link]: https://app.codecov.io/gh/opensearch-project/OpenSearch-Dashboards +[link-checker-badge]: https://github.com/opensearch-project/OpenSearch-Dashboards/actions/workflows/links_checker.yml/badge.svg +[link-checker-link]: https://github.com/opensearch-project/OpenSearch-Dashboards/actions/workflows/links_checker.yml