Skip to content

Commit 83ebdaf

Browse files
suyash5053ashwin-pc
authored andcommitted
Updated README.md (opensearch-project#4769)
Changed a Typo in README.md file Signed-off-by: Suyash Srivastava <suyashsrivastava5053@gmail.com> (cherry picked from commit 061e476) Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
1 parent 12eade7 commit 83ebdaf

File tree

1 file changed

+30
-13
lines changed

1 file changed

+30
-13
lines changed

README.md

+30-13
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,33 @@
88

99
## Welcome
1010

11-
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.
11+
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.
1212

13-
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).
13+
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).
14+
15+
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.
16+
17+
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.
18+
19+
## Code Summary
20+
21+
[![Build and Test][build-and-test-badge]][build-and-test-link]
22+
[![Unit Test Code Coverage][codecov-badge]][codecov-link]
23+
[![Link Checker][link-checker-badge]][link-checker-link]
1424

1525
## Project Resources
1626

17-
* [Project Website](https://opensearch.org/)
18-
* [Downloads](https://opensearch.org/downloads.html)
19-
* [Documentation](https://opensearch.org/docs/)
20-
* Need help? Try [Forums](https://discuss.opendistrocommunity.dev/)
21-
* [Project Principles](https://opensearch.org/#principles)
22-
* [Developer Guide](DEVELOPER_GUIDE.md)
23-
* [Contributing to OpenSearch](CONTRIBUTING.md)
24-
* [Maintainer Responsibilities](MAINTAINERS.md)
25-
* [Release Management](RELEASING.md)
26-
* [Testing](TESTING.md)
27-
* [Security](SECURITY.md)
27+
- [Project Website](https://opensearch.org/)
28+
- [Downloads](https://opensearch.org/downloads.html)
29+
- [Documentation](https://opensearch.org/docs/)
30+
- Need help? See the [communication guide](COMMUNICATIONS.md) for various options
31+
- [Project Principles](https://opensearch.org/#principles)
32+
- [Developer Guide](DEVELOPER_GUIDE.md)
33+
- [Contributing to OpenSearch](CONTRIBUTING.md)
34+
- [Maintainer Responsibilities](MAINTAINERS.md)
35+
- [Release Management](RELEASING.md)
36+
- [Testing](TESTING.md)
37+
- [Security](SECURITY.md)
2838

2939
## Code of Conduct
3040

@@ -37,3 +47,10 @@ This project is licensed under the [Apache v2.0 License](LICENSE.txt).
3747
## Copyright
3848

3949
Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.
50+
51+
[build-and-test-badge]: https://github.com/opensearch-project/OpenSearch-Dashboards/actions/workflows/build_and_test_workflow.yml/badge.svg
52+
[build-and-test-link]: https://github.com/opensearch-project/OpenSearch-Dashboards/actions/workflows/build_and_test_workflow.yml
53+
[codecov-badge]: https://codecov.io/gh/opensearch-project/OpenSearch-Dashboards/branch/main/graphs/badge.svg
54+
[codecov-link]: https://app.codecov.io/gh/opensearch-project/OpenSearch-Dashboards
55+
[link-checker-badge]: https://github.com/opensearch-project/OpenSearch-Dashboards/actions/workflows/links_checker.yml/badge.svg
56+
[link-checker-link]: https://github.com/opensearch-project/OpenSearch-Dashboards/actions/workflows/links_checker.yml

0 commit comments

Comments
 (0)