created page and documentation for querqy plugin (#1047)

* created page and documentation for querqy plugin Signed-off-by: ariamarble <armarble@amazon.com> * made suggested changes Signed-off-by: ariamarble <armarble@amazon.com> * made suggested title change Signed-off-by: ariamarble <armarble@amazon.com> * made further formatting changes Signed-off-by: ariamarble <armarble@amazon.com> * formatting Signed-off-by: ariamarble <armarble@amazon.com> Signed-off-by: ariamarble <armarble@amazon.com>
2022-08-31 15:42:17 -07:00 · 2022-08-31 15:42:17 -07:00 · 3417d8b7b8
parent a890c4e0a3
commit 3417d8b7b8
1 changed files with 63 additions and 0 deletions
--- a/_search-plugins/querqy/index.md
+++ b/_search-plugins/querqy/index.md
@ -0,0 +1,63 @@
+---
+layout: default
+title: Querqy
+has_children: false
+redirect_from:
+  - /search-plugins/querqy/
+nav_order: 10
+---
+
+# Querqy
+
+Querqy is a community plugin for query rewriting that helps to solve relevance issues, making search engines more precise regarding matching and scoring.
+
+## Querqy plugin installation
+
+Querqy is currently only compatible with OpenSearch 1.3.1
+{: .note }
+
+1. The Querqy plugin code is located here: [querqy-opensearch](https://github.com/querqy/querqy-opensearch). To download the plugin code ZIP file, select the green "Code" button, then select "Download ZIP"
+
+1. Install JDK 11. On Amazon Linux 2, install JDK11 with the following command:
+
+   ```bash
+   sudo yum install java-11-amazon-corretto
+   ```
+
+1. Uncompress the ZIP file:
+
+   ```bash
+   unzip querqy-opensearch-main.zip
+   ```
+
+1. Change to the uncompressed Querqy directory:
+
+   ```bash
+   cd querqy-opensearch-main
+   ```
+
+1. Compile the plugin: 
+
+   ```bash
+   ./gradlew build
+   ```
+
+1. The compiled plugin is stored in this directory:
+
+   ```bash
+   /path/to/file/querqy-opensearch-main/build/distributions/opensearch-querqy-1.3.1.0.zip`
+   ```
+
+1. The compiled Querqy plugin is installed the same as [any OpenSearch plugin](https://opensearch.org/docs/latest/opensearch/install/plugins/#install-a-plugin): 
+
+   ```bash
+   /path/to/opensearch/bin/opensearch-plugin install file:///path/to/file/opensearch-querqy-1.3.1.0.zip
+   ```
+
+1. Reboot the OpenSearch node: 
+
+   ```bash
+   sudo reboot
+   ```
+
+After installing the Querqy plugin you can find comprehensive documentation on the Querqy.org site: [Querqy](https://docs.querqy.org/querqy/index.html)