Convert wiki to markdown docs (#2944)

* Convert wiki to markdown docs

* Overhaul docs and fix obvious conversion issues

* Update docs workflow

* Fix links and include main README

* Update TLS section

* Fix more links

* Remove ascii docs and maven profile

* Fix spelling

* Build docs only from the main branch

.github/CONTRIBUTING.md

@@ -57,17 +57,16 @@ If you have a question, then check one of the following places first as GitHub i
 
 **Checkout the docs**
 
-* [Reference documentation](https://lettuce.io/docs/)
-* [Wiki](https://github.com/lettuce-io/lettuce-core/wiki)
-* [Javadoc](https://lettuce.io/core/release/api/)
+* [Reference documentation](https://redis.github.io/lettuce/)
+* [Javadoc](https://www.javadoc.io/doc/io.lettuce/lettuce-core/latest/index.html)
 
 **Communication**
 
-* GitHub Discussions (Q&A, Ideas, General discussion): https://github.com/lettuce-io/lettuce-core/discussions 
+* [GitHub Discussions](https://github.com/redis/lettuce/discussions) (Q&A, Ideas, General discussion)
 * Stack Overflow (Questions): [https://stackoverflow.com/questions/tagged/lettuce](https://stackoverflow.com/questions/tagged/lettuce)
-* Gitter (chat): [![Join the chat at https://gitter.im/lettuce-io/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lettuce-io/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-* Twitter: [@LettuceDriver](https://twitter.com/LettuceDriver)
-* [GitHub Issues](https://github.com/lettuce-io/lettuce-core/issues) (Bug reports, feature requests)
+* Discord: [![Discord](https://img.shields.io/discord/697882427875393627.svg?style=social&logo=discord)](https://discord.gg/redis)
+* Twitter: [![Twitter](https://img.shields.io/twitter/follow/redisinc?style=social)](https://twitter.com/redisinc)
+* [GitHub Issues](https://github.com/redis/lettuce/issues) (Bug reports, feature requests)
 
 
 ### Building from Source

.github/wordlist.txt

@@ -80,3 +80,174 @@ DnsResolver
 dnsResolver
 evalReadOnly
 gg
+ACL
+AOT
+APIs
+API’s
+Akka
+Async
+AsyncCommand
+Asynchronicity
+Backpressure
+CamelCase
+Charset
+ClientResources
+CommandLatencyCollector
+CommandWrapper
+CompletionStage
+Config
+Coroutine
+Coroutines
+Customizer
+DNS
+DSL
+EPoll
+ElastiCache
+EventExecutorGroup
+EventLoop
+EventLoopGroup
+EventPublisher
+Failover
+GZIP
+Graal
+GraalVM
+Graal's
+HdrHistogram
+IPs
+Iterable
+JDK
+JFR
+JIT
+JNI
+KeyStreamingChannel
+KeyValueStreamingChannel
+Kops
+Kqueue
+Kryo
+LatencyUtils
+Luascripts
+MasterReplica
+Misconfiguring
+Mult
+NIO
+Netty’s
+NodeSelection
+OpenSSL
+PEM
+POSIX
+Plaintext
+RTT
+Reconnection
+RedisClient
+RedisClusterClient
+RedisURIs
+RxJava
+SHA
+SPI
+ScoredValueStreamingChannel
+Serializer
+Sharded
+Sharding
+SomeClient
+StartTLS
+StreamingChannel
+StreamingChannels
+SubstrateVM
+TCP
+TLS
+TimedScheduler
+TransactionalCommand
+URIs
+Un
+ValueStreamingChannel
+aggregable
+amongst
+analytics
+args
+assignability
+async
+asynchronicity
+backoff
+backpressure
+boolean
+broadcasted
+bytecode
+cancelation
+channelId
+charset
+classpath
+codecs
+config
+coroutines
+customizable
+customizer
+dataset
+deserialization
+desynchronize
+desynchronizes
+encodings
+epId
+epoll
+executables
+extensibility
+failover
+fromExecutor
+gradle
+Graal's
+hasNext
+hostnames
+idempotency
+integrations
+interoperable
+interoperate
+invoker
+json
+keyspace
+kotlinx
+kqueue
+latencies
+lifecycle
+localhost
+macOS
+microservices
+misconfiguration
+multithreaded
+natively
+netty's
+newSingle
+nodeId
+nodeIds
+nodeId's
+nullability
+onCompleted
+onError
+onNext
+oss
+parametrized
+pipelining
+pluggable
+pre
+preconfigured
+predefine
+reconnection
+redirections
+replicaN
+retrigger
+runtimes
+se
+sharding
+stateful
+subclasses
+subcommand
+synthetization
+th
+throwable
+topologies
+transcoding
+typesafe
+un
+unconfigured
+unix
+uring
+whitespace
+xml

.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: Publish Docs
+on:
+  push:
+    branches: ["main"]
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+jobs:
+  build-and-deploy:
+    concurrency: ci-${{ github.ref }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material pymdown-extensions mkdocs-macros-plugin
+      - name: Build docs
+        run: |
+          mkdocs build -d docsbuild
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: 'docsbuild'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

README.md

@@ -16,18 +16,18 @@ Supports advanced Redis features such as Sentinel, Cluster, Pipelining, Auto-Rec
 
 This version of Lettuce has been tested against the latest Redis source-build.
 
-* [synchronous](https://github.com/lettuce-io/lettuce-core/wiki/Basic-usage), [asynchronous](https://github.com/lettuce-io/lettuce-core/wiki/Asynchronous-API-%284.0%29) and [reactive](https://github.com/lettuce-io/lettuce-core/wiki/Reactive-API-%285.0%29) usage
-* [Redis Sentinel](https://github.com/lettuce-io/lettuce-core/wiki/Redis-Sentinel)
-* [Redis Cluster](https://github.com/lettuce-io/lettuce-core/wiki/Redis-Cluster)
-* [SSL](https://github.com/lettuce-io/lettuce-core/wiki/SSL-Connections) and [Unix Domain Socket](https://github.com/lettuce-io/lettuce-core/wiki/Unix-Domain-Sockets) connections
-* [Streaming API](https://github.com/lettuce-io/lettuce-core/wiki/Streaming-API)
-* [CDI](https://github.com/lettuce-io/lettuce-core/wiki/CDI-Support) and [Spring](https://github.com/lettuce-io/lettuce-core/wiki/Spring-Support) integration
-* [Codecs](https://github.com/lettuce-io/lettuce-core/wiki/Codecs) (for UTF8/bit/JSON etc. representation of your data)
-* multiple [Command Interfaces](https://github.com/lettuce-io/lettuce-core/wiki/Command-Interfaces-%284.0%29)
-* Support for [Native Transports](https://github.com/lettuce-io/lettuce-core/wiki/Native-Transports)
+* [synchronous](https://redis.github.io/lettuce/user-guide/connecting-redis/#basic-usage), [asynchronous](https://redis.github.io/lettuce/user-guide/async-api/) and [reactive](https://redis.github.io/lettuce/user-guide/reactive-api/) usage
+* [Redis Sentinel](https://redis.github.io/lettuce/ha-sharding/#redis-sentinel_1)
+* [Redis Cluster](https://redis.github.io/lettuce/ha-sharding/#redis-cluster)
+* [SSL](https://redis.github.io/lettuce/advanced-usage/#ssl-connections) and [Unix Domain Socket](https://redis.github.io/lettuce/advanced-usage/#unix-domain-sockets) connections
+* [Streaming API](https://redis.github.io/lettuce/advanced-usage/#streaming-api)
+* [CDI](https://redis.github.io/lettuce/integration-extension/#cdi-support)
+* [Codecs](https://redis.github.io/lettuce/integration-extension/#codecss) (for UTF8/bit/JSON etc. representation of your data)
+* multiple [Command Interfaces](https://github.com/redis/lettuce/wiki/Command-Interfaces-%284.0%29)
+* Support for [Native Transports](https://redis.github.io/lettuce/advanced-usage/#native-transports)
 * Compatible with Java 8++ (implicit automatic module w/o descriptors)
 
-See the [reference documentation](https://lettuce.io/docs/) and [Wiki](https://github.com/lettuce-io/lettuce-core/wiki) for more details.
+See the [reference documentation](https://redis.github.io/lettuce/) and [API Reference](https://www.javadoc.io/doc/io.lettuce/lettuce-core/latest/index.html) for more details.
 
 ## How do I Redis?
 
@@ -46,27 +46,25 @@ See the [reference documentation](https://lettuce.io/docs/) and [Wiki](https://g
 Communication
 ---------------
 
-* [GitHub Discussions](https://github.com/lettuce-io/lettuce-core/discussions) (Q&A, Ideas, General discussion)
+* [GitHub Discussions](https://github.com/redis/lettuce/discussions) (Q&A, Ideas, General discussion)
 * Stack Overflow (Questions): [https://stackoverflow.com/questions/tagged/lettuce](https://stackoverflow.com/questions/tagged/lettuce)
 * Discord: [![Discord](https://img.shields.io/discord/697882427875393627.svg?style=social&logo=discord)](https://discord.gg/redis)
 * Twitter: [![Twitter](https://img.shields.io/twitter/follow/redisinc?style=social)](https://twitter.com/redisinc)
-* [GitHub Issues](https://github.com/lettuce-io/lettuce-core/issues) (Bug reports, feature requests)
+* [GitHub Issues](https://github.com/redis/lettuce/issues) (Bug reports, feature requests)
 
 
 Documentation
 ---------------
 
-* [Reference documentation](https://lettuce.io/docs/)
-* [Wiki](https://github.com/lettuce-io/lettuce-core/wiki)
-* [Javadoc](https://lettuce.io/core/release/api/)
-
+* [Reference documentation](https://redis.github.io/lettuce/)
+* [Javadoc](https://www.javadoc.io/doc/io.lettuce/lettuce-core/latest/index.html)
 
 Binaries/Download
 ----------------
 
 Binaries and dependency information for Maven, Ivy, Gradle and others can be found at http://search.maven.org.
 
-Releases of lettuce are available in the Maven Central repository. Take also a look at the [Releases](https://github.com/lettuce-io/lettuce-core/releases).
+Releases of lettuce are available in the Maven Central repository. Take also a look at the [Releases](https://github.com/redis/lettuce/releases).
 
 Example for Maven:
 
@@ -114,7 +112,7 @@ to the lowercase Redis command name. Complex commands with multiple modifiers
 that change the result type include the CamelCased modifier as part of the
 command name, e.g. zrangebyscore and zrangebyscoreWithScores.
 
-See [Basic usage](https://github.com/lettuce-io/lettuce-core/wiki/Basic-usage) for further details.
+See [Basic usage](https://redis.github.io/lettuce/user-guide/connecting-redis/#basic-usage) for further details.
 
 Asynchronous API
 ------------------------
@@ -131,7 +129,7 @@ set.get() == "OK"
 get.get() == "value"
 ```
 
-See [Asynchronous API](https://github.com/lettuce-io/lettuce-core/wiki/Asynchronous-API-%284.0%29) for further details.
+See [Asynchronous API](https://redis.github.io/lettuce/user-guide/async-api/) for further details.
 
 Reactive API
 ------------------------
@@ -147,7 +145,7 @@ set.subscribe();
 get.block() == "value"
 ```
 
-See [Reactive API](https://github.com/lettuce-io/lettuce-core/wiki/Reactive-API-%285.0%29) for further details.
+See [Reactive API](https://redis.github.io/lettuce/user-guide/reactive-api/) for further details.
 
 Pub/Sub
 -------
@@ -167,7 +165,7 @@ are configured using a ```Makefile```. Tests run by default against Redis `unsta
 To build:
 
 ```
-$ git clone https://github.com/lettuce-io/lettuce-core.git
+$ git clone https://github.com/redis/lettuce.git
 $ cd lettuce/
 $ make prepare ssl-keys
 $ make test
@@ -194,4 +192,4 @@ Contributing
 -------
 
 Github is for social coding: if you want to write code, I encourage contributions through pull requests from forks of this repository. 
-Create Github tickets for bugs and new features and comment on the ones that you are interested in and take a look into [CONTRIBUTING.md](https://github.com/lettuce-io/lettuce-core/blob/main/.github/CONTRIBUTING.md)
+Create Github tickets for bugs and new features and comment on the ones that you are interested in and take a look into [CONTRIBUTING.md](https://github.com/redis/lettuce/blob/main/.github/CONTRIBUTING.md)