From aabc86a2e0e1bafa6a9025d50cc8ef0983be5786 Mon Sep 17 00:00:00 2001 From: akshtih30388 Date: Wed, 22 Oct 2025 15:59:03 +0530 Subject: [PATCH 1/3] Update README.md: improve formatting and add table of contents --- README.md.save | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 README.md.save diff --git a/README.md.save b/README.md.save new file mode 100644 index 0000000000000..529704056b368 --- /dev/null +++ b/README.md.save @@ -0,0 +1,58 @@ + + + + +[![License](https://img.shields.io/badge/license-Apache%20v2-blue.svg)](https://github.com/opensearch-project/OpenSearch/blob/main/LICENSE.txt) +[![LFX Health Score](https://insights.production.lfx.dev/api/badge/health-score?project=opensearch-foundation)](https://insights.linuxfoundation.org/project/opensearch-foundation) +[![LFX Active Contributors](https://insights.production.lfx.dev/api/badge/active-contributors?project=opensearch-foundation&repos=https://github.com/opensearch-project/OpenSearch)](https://insights.linuxfoundation.org/project/opensearch-foundation/repository/opensearch-project-opensearch) +[![Code Coverage](https://codecov.io/gh/opensearch-project/OpenSearch/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/OpenSearch) +![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/opensearch-project/OpenSearch?sort=semver) +[![Linkedin](https://img.shields.io/badge/Follow-Linkedin-blue)](https://www.linkedin.com/company/opensearch-project) + +- [Welcome!](#welcome) +- [Project Resources](#project-resources) +- [Code of Conduct](#code-of-conduct) +- [Security](#security) +- [License](#license) +- [Copyright](#copyright) +- [Trademark](#t:? + + +## Welcome! + +OpenSearch is an open-source, enterprise-grade search and observability suite that brings order to unstructured data at scale. + +## Project Resources + +* [Project Website](https://opensearch.org/) +* [Downloads](https://opensearch.org/downloads/) +* [Documentation](https://docs.opensearch.org/) +* Need help? Try [Forums](https://discuss.opendistrocommunity.dev/) or [Slack](https://opensearch.org/slack/) +* [Contributing to OpenSearch](CONTRIBUTING.md) +* [Maintainer Responsibilities](MAINTAINERS.md) +* [Release Management](RELEASING.md) +* [Admin Responsibilities](ADMINS.md) +* [Testing](TESTING.md) +* [Security](SECURITY.md) + +## Code of Conduct + +The project's [Code of Conduct](CODE_OF_CONDUCT.md) outlines our expectations for all participants in our community, based on the [OpenSearch Code of Conduct](https://opensearch.org/code-of-conduct/). Please contact [conduct@opensearch.foundation](mailto:conduct@opensearch.foundation) with any additional questions or comments. + +## Security +If you discover a potential security issue in this project we ask that you notify OpenSearch Security directly via email to security@opensearch.org. Please do **not** create a public GitHub issue. + +## License + +This project is licensed under the [Apache v2.0 License](LICENSE.txt). + +## Copyright + +Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details. + +## Trademark + +OpenSearch is a registered trademark of LF Projects, LLC. + +OpenSearch includes certain Apache-licensed Elasticsearch code from Elasticsearch B.V. and other source code. Elasticsearch B.V. is not the source of that other source code. ELASTICSEARCH is a registered trademark of Elasticsearch B.V. + From 692ebfc67ba0f1693e40b71ba6366ad1e3239adc Mon Sep 17 00:00:00 2001 From: akshith30388 Date: Wed, 22 Oct 2025 19:45:01 +0530 Subject: [PATCH 2/3] Update README.md: improve formatting and add table of contents --- README.md | 79 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 54 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 02f3718ecf1ab..77d77d2ed2c72 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,21 @@ +# OpenSearch + - + OpenSearch Logo +--- + [![License](https://img.shields.io/badge/license-Apache%20v2-blue.svg)](https://github.com/opensearch-project/OpenSearch/blob/main/LICENSE.txt) [![LFX Health Score](https://insights.production.lfx.dev/api/badge/health-score?project=opensearch-foundation)](https://insights.linuxfoundation.org/project/opensearch-foundation) [![LFX Active Contributors](https://insights.production.lfx.dev/api/badge/active-contributors?project=opensearch-foundation&repos=https://github.com/opensearch-project/OpenSearch)](https://insights.linuxfoundation.org/project/opensearch-foundation/repository/opensearch-project-opensearch) [![Code Coverage](https://codecov.io/gh/opensearch-project/OpenSearch/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/OpenSearch) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/opensearch-project/OpenSearch?sort=semver) -[![Linkedin](https://img.shields.io/badge/Follow-Linkedin-blue)](https://www.linkedin.com/company/opensearch-project) +[![LinkedIn](https://img.shields.io/badge/Follow-LinkedIn-blue)](https://www.linkedin.com/company/opensearch-project) + +--- +## 📘 Table of Contents - [Welcome!](#welcome) - [Project Resources](#project-resources) - [Code of Conduct](#code-of-conduct) @@ -17,41 +24,63 @@ - [Copyright](#copyright) - [Trademark](#trademark) -## Welcome! +--- + +## 🧭 Welcome! + +**OpenSearch** is an open-source, enterprise-grade search and observability suite that brings order to unstructured data at scale. +It enables fast, scalable, and secure search, analytics, and visualization. -OpenSearch is an open-source, enterprise-grade search and observability suite that brings order to unstructured data at scale. +--- -## Project Resources +## 📚 Project Resources -* [Project Website](https://opensearch.org/) -* [Downloads](https://opensearch.org/downloads/) -* [Documentation](https://docs.opensearch.org/) -* Need help? Try [Forums](https://discuss.opendistrocommunity.dev/) or [Slack](https://opensearch.org/slack/) -* [Contributing to OpenSearch](CONTRIBUTING.md) -* [Maintainer Responsibilities](MAINTAINERS.md) -* [Release Management](RELEASING.md) -* [Admin Responsibilities](ADMINS.md) -* [Testing](TESTING.md) -* [Security](SECURITY.md) +- [Project Website](https://opensearch.org/) +- [Downloads](https://opensearch.org/downloads/) +- [Documentation](https://docs.opensearch.org/) +- Need help? Try the [Forums](https://discuss.opendistrocommunity.dev/) or [Slack](https://opensearch.org/slack/) +- [Contributing to OpenSearch](CONTRIBUTING.md) +- [Maintainer Responsibilities](MAINTAINERS.md) +- [Release Management](RELEASING.md) +- [Admin Responsibilities](ADMINS.md) +- [Testing](TESTING.md) +- [Security](SECURITY.md) -## Code of Conduct +--- -The project's [Code of Conduct](CODE_OF_CONDUCT.md) outlines our expectations for all participants in our community, based on the [OpenSearch Code of Conduct](https://opensearch.org/code-of-conduct/). Please contact [conduct@opensearch.foundation](mailto:conduct@opensearch.foundation) with any additional questions or comments. +## 🤝 Code of Conduct -## Security -If you discover a potential security issue in this project we ask that you notify OpenSearch Security directly via email to security@opensearch.org. Please do **not** create a public GitHub issue. +The project's [Code of Conduct](CODE_OF_CONDUCT.md) outlines expectations for all community participants, +based on the [OpenSearch Code of Conduct](https://opensearch.org/code-of-conduct/). +Please contact [conduct@opensearch.foundation](mailto:conduct@opensearch.foundation) for questions or comments. -## License +--- + +## 🔐 Security + +If you discover a potential security issue, please contact +**OpenSearch Security** via email: [security@opensearch.org](mailto:security@opensearch.org). +Do **not** create a public GitHub issue for security reports. + +--- + +## ⚖️ License This project is licensed under the [Apache v2.0 License](LICENSE.txt). -## Copyright +--- + +## ©️ Copyright -Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details. +Copyright © OpenSearch Contributors. +See [NOTICE](NOTICE.txt) for details. -## Trademark +--- -OpenSearch is a registered trademark of LF Projects, LLC. +## ™️ Trademark -OpenSearch includes certain Apache-licensed Elasticsearch code from Elasticsearch B.V. and other source code. Elasticsearch B.V. is not the source of that other source code. ELASTICSEARCH is a registered trademark of Elasticsearch B.V. +**OpenSearch** is a registered trademark of LF Projects, LLC. +OpenSearch includes certain Apache-licensed Elasticsearch code from Elasticsearch B.V. and other source code. +Elasticsearch B.V. is **not** the source of that other code. +**ELASTICSEARCH** is a registered trademark of Elasticsearch B.V. From f4367e0bfedf0b454b2ba4de1c964c6887d93e8e Mon Sep 17 00:00:00 2001 From: akshith30388 Date: Sat, 25 Oct 2025 23:44:26 +0530 Subject: [PATCH 3/3] docs: improve README formatting, accessibility, and updated community links Signed-off-by: akshith30388 --- README.md | 81 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 53 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 529704056b368..3f5e752c89bac 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,19 @@ - - - - -[![License](https://img.shields.io/badge/license-Apache%20v2-blue.svg)](https://github.com/opensearch-project/OpenSearch/blob/main/LICENSE.txt) -[![LFX Health Score](https://insights.production.lfx.dev/api/badge/health-score?project=opensearch-foundation)](https://insights.linuxfoundation.org/project/opensearch-foundation) -[![LFX Active Contributors](https://insights.production.lfx.dev/api/badge/active-contributors?project=opensearch-foundation&repos=https://github.com/opensearch-project/OpenSearch)](https://insights.linuxfoundation.org/project/opensearch-foundation/repository/opensearch-project-opensearch) -[![Code Coverage](https://codecov.io/gh/opensearch-project/OpenSearch/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/OpenSearch) -![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/opensearch-project/OpenSearch?sort=semver) -[![Linkedin](https://img.shields.io/badge/Follow-Linkedin-blue)](https://www.linkedin.com/company/opensearch-project) +

+ + OpenSearch logo + +

+ +

+ License: Apache v2 + LFX Health Score + Active Contributors + Code Coverage + Latest Release + Follow on LinkedIn +

+ +--- - [Welcome!](#welcome) - [Project Resources](#project-resources) @@ -18,41 +24,60 @@ - [Trademark](#t:? +--- + ## Welcome! -OpenSearch is an open-source, enterprise-grade search and observability suite that brings order to unstructured data at scale. +OpenSearch is an open-source, enterprise-grade search and observability suite that brings order to unstructured data at scale. +It includes OpenSearch Dashboards and a growing ecosystem of plugins for analytics, alerting, and monitoring. + +--- ## Project Resources -* [Project Website](https://opensearch.org/) -* [Downloads](https://opensearch.org/downloads/) -* [Documentation](https://docs.opensearch.org/) -* Need help? Try [Forums](https://discuss.opendistrocommunity.dev/) or [Slack](https://opensearch.org/slack/) -* [Contributing to OpenSearch](CONTRIBUTING.md) -* [Maintainer Responsibilities](MAINTAINERS.md) -* [Release Management](RELEASING.md) -* [Admin Responsibilities](ADMINS.md) -* [Testing](TESTING.md) -* [Security](SECURITY.md) +- [Project Website](https://opensearch.org/) +- [Downloads](https://opensearch.org/downloads/) +- [Documentation](https://docs.opensearch.org/) +- Need help? Try our [Community Forum](https://forum.opensearch.org/) or [Slack](https://opensearch.org/slack/) +- [Contributing to OpenSearch](CONTRIBUTING.md) +- [Maintainer Responsibilities](MAINTAINERS.md) +- [Release Management](RELEASING.md) +- [Admin Responsibilities](ADMINS.md) +- [Testing](TESTING.md) +- [Security](SECURITY.md) + +--- ## Code of Conduct -The project's [Code of Conduct](CODE_OF_CONDUCT.md) outlines our expectations for all participants in our community, based on the [OpenSearch Code of Conduct](https://opensearch.org/code-of-conduct/). Please contact [conduct@opensearch.foundation](mailto:conduct@opensearch.foundation) with any additional questions or comments. +Our [Code of Conduct](CODE_OF_CONDUCT.md) outlines community expectations. +Please contact [conduct@opensearch.foundation](mailto:conduct@opensearch.foundation) with any questions or concerns. + +--- ## Security -If you discover a potential security issue in this project we ask that you notify OpenSearch Security directly via email to security@opensearch.org. Please do **not** create a public GitHub issue. + +If you discover a potential security issue, please notify the OpenSearch Security Team directly at +[security@opensearch.org](mailto:security@opensearch.org). +Please **do not** create a public GitHub issue. + +--- ## License This project is licensed under the [Apache v2.0 License](LICENSE.txt). +--- + ## Copyright -Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details. +© 2021–Present OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details. -## Trademark +--- -OpenSearch is a registered trademark of LF Projects, LLC. - -OpenSearch includes certain Apache-licensed Elasticsearch code from Elasticsearch B.V. and other source code. Elasticsearch B.V. is not the source of that other source code. ELASTICSEARCH is a registered trademark of Elasticsearch B.V. +## Trademark +OpenSearch is a registered trademark of **LF Projects, LLC**. +OpenSearch includes certain Apache-licensed Elasticsearch code from **Elasticsearch B.V.** and other sources. +**Elasticsearch B.V.** is not the source of that other source code. +ELASTICSEARCH is a registered trademark of **Elasticsearch B.V.**