Skip to content

Commit 6e01834

Browse files
codecov badge; edited documentation in README (#91) (#93)
* 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]> (cherry picked from commit 6325c4d) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Mark Cohen <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent f4d3e1c commit 6e01834

File tree

2 files changed

+25
-7
lines changed

2 files changed

+25
-7
lines changed

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
![OpenSearch Project](OpenSearch.svg)
22

33
# Search Relevance Tools
4+
[![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)
45
[![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)
6+
[![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)
57

6-
[![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)
78

89
## Summary
910
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.
1011

1112
# Projects
1213
## Search Comparison UI
13-
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.
14+
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.
1415

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

2025
### Enhancements
2126

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

2631
* Make srdash compatible with default build script ([#46](https://github.com/opensearch-project/dashboards-search-relevance/pull/46))
32+
* Fix default tab spacing ([#77](https://github.com/opensearch-project/dashboards-search-relevance/pull/77))
33+
34+
### Infrastructure
35+
36+
* initial copy of files from .github with updates specific to this repo ([#1](https://github.com/opensearch-project/dashboards-search-relevance/pull/1))
37+
* adding ci workflow ([#12](https://github.com/opensearch-project/dashboards-search-relevance/pull/12))
38+
* Add windows-latest back to test-and-build workflow ([#39](https://github.com/opensearch-project/dashboards-search-relevance/pull/39))
39+
* Configure Mend for GitHub.com ([#49](https://github.com/opensearch-project/dashboards-search-relevance/pull/49))
40+
41+
42+
43+

0 commit comments

Comments
 (0)