Skip to content

Commit

Permalink
codecov badge; edited documentation in README (opensearch-project#91)
Browse files Browse the repository at this point in the history 
* release notes for 2.4.0

Signed-off-by: Mark Cohen <[email protected]>

* added codecov badge to README

Signed-off-by: Mark Cohen <[email protected]>

* updated README.md to include present tense

Signed-off-by: Mark Cohen <[email protected]>

* revised 2.4 release notes

Signed-off-by: Mark Cohen <[email protected]>

Signed-off-by: Mark Cohen <[email protected]>
  • Loading branch information
@macohen
macohen authored Nov 9, 2022
1 parent 909eef1 commit 6325c4d
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 7 deletions.
5 changes: 3 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
![OpenSearch Project](OpenSearch.svg)

# Search Relevance Tools
[![Build Search Relevance Plugin](https://github.com/opensearch-project/dashboards-search-relevance/actions/workflows/test-and-build.yml/badge.svg)](https://github.com/opensearch-project/dashboards-search-relevance/actions/workflows/test-and-build.yml)
[![Link Checker](https://github.com/opensearch-project/dashboards-search-relevance/actions/workflows/link-checker.yml/badge.svg?branch=main)](https://github.com/opensearch-project/dashboards-search-relevance/actions/workflows/link-checker.yml)
[![codecov](https://codecov.io/gh/opensearch-project/dashboards-search-relevance/branch/main/graph/badge.svg?token=PYQO2GW39S)](https://codecov.io/gh/opensearch-project/dashboards-search-relevance)

[![Build Search Relevance Plugin](https://github.com/opensearch-project/dashboards-search-relevance/actions/workflows/test-and-build.yml/badge.svg)](https://github.com/opensearch-project/dashboards-search-relevance/actions/workflows/test-and-build.yml)

## Summary
In search applications, tuning relevance is a constant, iterative exercise to bring the right search results to your end users. The tooling in this repository aims to help the search relevance engineer and business user create the best search experience possible for application users without hiding internals from engineers who want to go deep into the details.

# Projects
## Search Comparison UI
The first release in this plugin will include an experimental feature to allow users to enter a plain text search query, substitute that query into two different QueryDSLs and compare the results side by side.
The first release in this plugin includes an experimental feature to allow users to enter a plain text search query, substitute that query into two different QueryDSLs and compare the results side by side.

# Security
See [SECURITY](SECURITY.md) for more information.
Expand Down
27 changes: 22 additions & 5 deletions release-notes/opensearch-dashboards-search-relevance.release-notes-2.4.0.0.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
Compatible with OpenSearch and OpenSearch Dashboards Version 2.4.0
* initial copy of files from .github with updates specific to this repo ([#1](https://github.com/opensearch-project/dashboards-search-relevance/pull/1))
* add workflows for backport and linkchecker ([#11](https://github.com/opensearch-project/dashboards-search-relevance/pull/11))
* adding ci workflow ([#12](https://github.com/opensearch-project/dashboards-search-relevance/pull/12))
* Initial version of relevance tools with Search Comparison UI ([#5](https://github.com/opensearch-project/dashboards-search-relevance/pull/5))
* Updating Workflows Location ([#17](https://github.com/opensearch-project/dashboards-search-relevance/pull/17))
* bump to 3.0.0.0 ([#18](https://github.com/opensearch-project/dashboards-search-relevance/pull/18))
Expand All @@ -11,11 +9,18 @@ Compatible with OpenSearch and OpenSearch Dashboards Version 2.4.0
* Add an initial integration test ([#30](https://github.com/opensearch-project/dashboards-search-relevance/pull/30))
* updating backport to 2.0 ([#34](https://github.com/opensearch-project/dashboards-search-relevance/pull/34))
* Moving PULL_REQUEST_TEMPLATE.md to .github dir ([#35](https://github.com/opensearch-project/dashboards-search-relevance/pull/35))
* Add windows-latest back to test-and-build workflow ([#39](https://github.com/opensearch-project/dashboards-search-relevance/pull/39))
* Configure Mend for GitHub.com ([#49](https://github.com/opensearch-project/dashboards-search-relevance/pull/49))
* Change results number to displayed results number ([#55](https://github.com/opensearch-project/dashboards-search-relevance/pull/55))
* Fix styling conflicts ([#59](https://github.com/opensearch-project/dashboards-search-relevance/pull/59))
* Fix backport delete action; Adding Badges for Build and Link Checker ([#54](https://github.com/opensearch-project/dashboards-search-relevance/pull/54))
* release notes for 2.4.0 ([#65](https://github.com/opensearch-project/dashboards-search-relevance/pull/65))
* Remove beta1 from the release notes file name for 2.4.0 ([#70](https://github.com/opensearch-project/dashboards-search-relevance/pull/70))
* Update the release notes folder name for consistency with other repos ([#73](https://github.com/opensearch-project/dashboards-search-relevance/pull/73))
* Unit test ([#83](https://github.com/opensearch-project/dashboards-search-relevance/pull/83))
* Issue fix ([#82](https://github.com/opensearch-project/dashboards-search-relevance/pull/82))
* Unit test ([#88](https://github.com/opensearch-project/dashboards-search-relevance/pull/88))

### Features

* Change results number to displayed results number ([#55](https://github.com/opensearch-project/dashboards-search-relevance/pull/55))

### Enhancements

Expand All @@ -24,3 +29,15 @@ Compatible with OpenSearch and OpenSearch Dashboards Version 2.4.0
### Bug Fixes

* Make srdash compatible with default build script ([#46](https://github.com/opensearch-project/dashboards-search-relevance/pull/46))
* Fix default tab spacing ([#77](https://github.com/opensearch-project/dashboards-search-relevance/pull/77))

### Infrastructure

* initial copy of files from .github with updates specific to this repo ([#1](https://github.com/opensearch-project/dashboards-search-relevance/pull/1))
* adding ci workflow ([#12](https://github.com/opensearch-project/dashboards-search-relevance/pull/12))
* Add windows-latest back to test-and-build workflow ([#39](https://github.com/opensearch-project/dashboards-search-relevance/pull/39))
* Configure Mend for GitHub.com ([#49](https://github.com/opensearch-project/dashboards-search-relevance/pull/49))




0 comments on commit 6325c4d

Please sign in to comment.