docs: Added documentation

Author: Julien Ruaux

.github/workflows/early-access.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up Java
         uses: actions/setup-java@v1
         with:
-          java-version: 18
+          java-version: 17
 
       - uses: actions/cache@v2
         with:
@@ -63,7 +63,6 @@ jobs:
           JRELEASER_GPG_PUBLIC_KEY: ${{ secrets.GPG_PUBLIC_KEY }}
           JRELEASER_GPG_SECRET_KEY: ${{ secrets.GPG_SECRET_KEY }}
           JRELEASER_SLACK_WEBHOOK: ${{ secrets.JRELEASER_SLACK_WEBHOOK }}
-          JRELEASER_ANNOUNCE_ACTIVE: NEVER
 
       - name: JReleaser output
         if: always()
@@ -74,7 +73,7 @@ jobs:
             out/jreleaser/trace.log
             out/jreleaser/output.properties
             out/jreleaser/release/CHANGELOG.md
-            
+
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2
 
@@ -91,4 +90,4 @@ jobs:
         uses: docker/build-push-action@v3
         with:
           push: ${{ github.event_name != 'pull_request' }}
-          tags: jruaux/trino-redisearch:early-access
+          tags: jruaux/trino-redisearch:early-access

.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Release version"
+        required: true
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Java
+        uses: actions/setup-java@v1
+        with:
+          java-version: 17
+
+      - uses: actions/cache@v2
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+
+      - name: Set release version
+        run: |
+          VERSION=${{ github.event.inputs.version }}
+          ./mvnw versions:set -DnewVersion=$VERSION
+
+      - name: Build
+        run: ./mvnw --no-transfer-progress -B --file pom.xml process-resources
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GIT_ACCESS_TOKEN }}
+          publish_dir: ./target/generated-docs

.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Set up Java
         uses: actions/setup-java@v1
         with:
-          java-version: 18
+          java-version: 17
 
       - uses: actions/cache@v2
         with:
@@ -57,11 +57,12 @@ jobs:
           JRELEASER_GPG_PUBLIC_KEY: ${{ secrets.GPG_PUBLIC_KEY}}
           JRELEASER_GPG_SECRET_KEY: ${{ secrets.GPG_SECRET_KEY }}
           JRELEASER_SLACK_WEBHOOK: ${{ secrets.JRELEASER_SLACK_WEBHOOK }}
-          
+
       - name: Commit release version
         run: |
           VERSION=${{ github.event.inputs.version }}
           sed -i -e "s/^\:project-version\:\ .*/:project-version: $VERSION/g" README.adoc
+          git add pom.xml
           git add README.adoc
           git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
           git config --global user.name "GitHub Action"
@@ -93,4 +94,10 @@ jobs:
         uses: docker/build-push-action@v3
         with:
           push: ${{ github.event_name != 'pull_request' }}
-          tags: jruaux/trino-redisearch:latest,jruaux/trino-redisearch:${{ github.event.inputs.version }}
+          tags: jruaux/trino-redisearch:latest,jruaux/trino-redisearch:${{ github.event.inputs.version }}
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GIT_ACCESS_TOKEN }}
+          publish_dir: ./target/generated-docs

README.adoc

@@ -1,103 +1,36 @@
 = Redis SQL
 :linkattrs:
-:project-owner:   redis-field-engineering
-:project-name:    redis-sql
-:project-group:   com.redis
-:project-version: 0.2.5
-:project-url:     https://github.com/{project-owner}/{project-name}
-:artifact-id:     trino-redisearch
-:trino-dir:       /usr/lib/trino
-:trino-datadir:   /var/trino
-:trino-version:   395
+:project-owner:     redis-field-engineering
+:project-name:      redis-sql
+:project-group:     com.redis
+:project-version:   0.2.5
+:project-url:       https://github.com/{project-owner}/{project-name}
+:documentation-url: https://{project-owner}.github.io/{project-name}
+:artifact-id:       trino-redisearch
+:trino-dir:         /usr/lib/trino
+:trino-datadir:     /var/trino
+:trino-version:     395
+
 
 image:{project-url}/actions/workflows/early-access.yml/badge.svg["Build Status", link="{project-url}/actions/workflows/early-access.yml"]
 image:https://codecov.io/gh/{project-owner}/{project-name}/branch/master/graph/badge.svg?token={codecov-token}["Coverage", link="https://codecov.io/gh/{project-owner}/{project-name}"]
 
 Redis SQL is a https://trino.io[Trino] connector which allows access to RediSearch data from Trino.
-This document describes how to set up the RediSearch Connector to run SQL queries against RediSearch.
-
-image::https://asciinema.org/a/526185.svg[asciicast,link=https://asciinema.org/a/526185]
 
 NOTE: RediSearch 2.0 or later is required.
 
-== Configuration
-To configure the RediSearch connector, create a catalog properties file `etc/catalog/redisearch.properties` with the following contents, replacing the properties as appropriate:
-
-[source,properties]
-----
-connector.name=redisearch
-redisearch.uri=redis://localhost:6379
-redisearch.default-schema-name=default
-----
-
-[[properties]]
-=== Configuration properties
-
-[cols="1,1,1"]
-|===
-|Property name |Description |Default
-
-|`redisearch.uri`
-|A Redis connection string. https://github.com/lettuce-io/lettuce-core/wiki/Redis-URI-and-connection-details#uri-syntax[Redis URI syntax].
-|
-
-|`redisearch.default-schema-name`
-|The schema that contains all tables defined without a qualifying schema name.
-|`default`
-
-|`redisearch.username`
-|Redis connection username.
-|
-
-|`redisearch.password`
-|Redis connection password.
-|
-
-|`redisearch.cluster`
-|Connect to a Redis Cluster.
-|`false`
+== Documentation
 
-|`redisearch.case-insensitive-names`
-|Match index names case insensitively.
-|`false`
+Documentation is available at link:{documentation-url}[{documentation-url}].
 
-|`redisearch.default-limit`
-|Max number of documents returned by FT.SEARCH and FT.AGGREGATE when no limit is present in the SQL query.
-|`10000`
-
-|`redisearch.cursor-count`
-|Number of rows read during each https://redis.io/docs/stack/search/reference/aggregations/#cursor-api[aggregation cursor] fetch.
-|`1000`
-|===
-
-== TLS security
-The RediSearch connector provides additional security options to support Redis servers with TLS mode.
-
-The allowed configuration values are:
-
-[cols="1,1"]
-|===
-|Property name |Description
-
-|`redisearch.insecure`
-|Allow insecure connections (e.g. invalid certificates) when using SSL.
-
-|`redisearch.cacert-path`
-|X.509 CA certificate file to verify with.
-
-|`redisearch.key-path`
-|PKCS#8 private key file to authenticate with (PEM format).
-
-|`redisearch.key-password`
-|Password of the private key file, or null if it's not password-protected.
-
-|`redisearch.cert-path`
-|X.509 certificate chain file to authenticate with (PEM format).
-|===
+== Support
 
+Contact us on the https://forum.redis.com/[Redis Forum] or create an issue on {project-url}/issues[Github] where we provide support on a good faith effort basis.
 
 == Docker Example
 
+image::https://asciinema.org/a/526185.svg[asciicast,link=https://asciinema.org/a/526185]
+
 .Clone the project
 [source,console,subs="verbatim,attributes"]
 ----
@@ -134,164 +67,3 @@ docker exec -it trino trino --catalog redisearch --schema default
 ----
 trino:default> select * from beers;
 ----
-
-== Tableau
-
-Follow these steps to connect Tableau: https://help.tableau.com/current/pro/desktop/en-us/examples_presto.htm
-
-== Install and Run
-
-=== Trino
-
-Trino installation instructions are available here: https://trino.io/docs/current/installation.html
-
-The following steps deploy a single-node Trino server on Ubuntu.
-
-Trino requires a 64-bit of Java 17.
-It is recommended to https://www.azul.com/downloads/?package=jdk[Azul Zulu] as the JDK.
-[source,console]
-----
-$ java -version
-openjdk version "17.0.4.1" 2022-08-12 LTS
-OpenJDK Runtime Environment Zulu17.36+17-CA (build 17.0.4.1+1-LTS)
-OpenJDK 64-Bit Server VM Zulu17.36+17-CA (build 17.0.4.1+1-LTS, mixed mode, sharing)
-----
-
-Download the Trino server tarball and unpack it.
-[source,console,subs="verbatim,attributes"]
-----
-wget https://repo1.maven.org/maven2/io/trino/trino-server/{trino-version}/trino-server-{trino-version}.tar.gz
-mkdir {trino-dir}
-tar xzvf trino-server-{trino-version}.tar.gz --directory {trino-dir} --strip-components 1
-----
-
-Trino needs a data directory for storing logs, etc.
-It is recommended to create a data directory outside of the installation directory, which allows it to be easily preserved when upgrading Trino.
-[source,console,subs="verbatim,attributes"]
-----
-mkdir -p {trino-datadir}
-----
-
-Create an `etc` directory inside the installation directory to hold configuration files.
-[source,console,subs="verbatim,attributes"]
-----
-mkdir {trino-dir}/etc
-----
-
-Create a node properties file `etc/node.properties`.
-
-.{trino-dir}/etc/node.properties
-[source,properties,subs="verbatim,attributes"]
-----
-node.environment=production
-node.id=ffffffff-ffff-ffff-ffff-ffffffffffff
-node.data-dir={trino-datadir}
-----
-
-Create a JVM config file `etc/jvm.config`.
-
-.{trino-dir}/etc/jvm.config
-[source,properties]
-----
--server
--Xmx16G
--XX:InitialRAMPercentage=80
--XX:MaxRAMPercentage=80
--XX:G1HeapRegionSize=32M
--XX:+ExplicitGCInvokesConcurrent
--XX:+ExitOnOutOfMemoryError
--XX:+HeapDumpOnOutOfMemoryError
--XX:-OmitStackTraceInFastThrow
--XX:ReservedCodeCacheSize=512M
--XX:PerMethodRecompilationCutoff=10000
--XX:PerBytecodeRecompilationCutoff=10000
--Djdk.attach.allowAttachSelf=true
--Djdk.nio.maxCachedBufferSize=2000000
--XX:+UnlockDiagnosticVMOptions
--XX:+UseAESCTRIntrinsics
-----
-
-Create a config properties file `etc/config.properties`.
-.{trino-dir}/etc/config.properties
-[source,properties]
-----
-coordinator=true
-node-scheduler.include-coordinator=true
-http-server.http.port=8080
-discovery.uri=http://localhost:8080
-----
-
-Create a log levels file `etc/log.properties`.
-.{trino-dir}/etc/log.properties
-[source,properties]
-----
-io.trino=INFO
-----
-
-=== Redis SQL
-
-Download latest {project-url}/releases/latest[release] and unzip without any directory structure under `<trino>/plugin/redisearch`.
-
-[source,console,subs="verbatim,attributes"]
-----
-wget {project-url}/releases/download/v{trino-version}/{artifact-id}-{trino-version}.zip
-unzip -j {artifact-id}-{project-version}.zip -d {trino-dir}/plugin/redisearch
-----
-
-Create a `redisearch.properties` file under `{trino-dir}/etc/catalog` directory:
-
-[source,properties]
-----
-connector.name=redisearch
-redisearch.uri=redis://localhost:6379
-----
-
-Change and/or add <<properties,properties>> as needed.
-
-=== Run
-
-==== Trino Server
-
-Start the Trino server by running:
-
-[source,console,subs="verbatim,attributes"]
-----
-{trino-dir}/bin/launcher run
-----
-
-==== Trino CLI
-
-Download https://repo1.maven.org/maven2/io/trino/trino-cli/{trino-version}/trino-cli-{trino-version}-executable.jar[trino-cli-{trino-version}-executable.jar], rename it to `trino`, make it executable with `chmod +x`, and run it to show the version of the CLI:
-
-[source,console,subs="verbatim,attributes"]
-----
-wget https://repo1.maven.org/maven2/io/trino/trino-cli/{trino-version}/trino-cli-{trino-version}-executable.jar
-mv trino-cli-{trino-version}-executable.jar trino
-chmod +x trino
-----
-
-Connect to Trino using the CLI:
-
-[source,console]
-----
-./trino --catalog redisearch --schema default
-----
-
-Run a SQL query:
-
-[source,console]
-----
-trino:default> select * from mySearchIndex;
-----
-
-== Build
-
-Run these commands to build the Trino connector for RediSearch from source (requires Java 17+):
-
-[source,console,subs="verbatim,attributes"]
-----
-git clone {project-url}.git
-cd {project-name}
-./gradlew clean build
-----
-