From fcdc0d5b6bf1cb793376d39e305d3fad819c71ad Mon Sep 17 00:00:00 2001
From: josh rotenberg <joshrotenberg@gmail.com>
Date: Tue, 19 Nov 2024 03:14:31 -0800
Subject: [PATCH] Add examples and tutorials page (#4024)

* add exmples and tutorials page

* update wordlist
---
 .github/wordlist.txt       | 33 +++++++++++++++++++++++----------
 docs/tutorials_examples.md | 21 +++++++++++++++++++++
 mkdocs.yml                 |  1 +
 3 files changed, 45 insertions(+), 10 deletions(-)
 create mode 100644 docs/tutorials_examples.md

diff --git a/.github/wordlist.txt b/.github/wordlist.txt
index ee74a49a51..3c522108fd 100644
--- a/.github/wordlist.txt
+++ b/.github/wordlist.txt
@@ -1,8 +1,8 @@
 !!!Spelling check failed!!!
 APM
 ARGV
-BaseObjectPoolConfig
 BFCommands
+BaseObjectPoolConfig
 BitOP
 BitPosParams
 BuilderFactory
@@ -20,10 +20,10 @@ CoreCommands
 Dockerfile
 EVAL
 EVALSHA
-Failback
-Failover
 FTCreateParams
 FTSearchParams
+Failback
+Failover
 GSON
 GenericObjectPool
 GenericObjectPoolConfig
@@ -54,6 +54,7 @@ ListPosition
 Ludovico
 Magnocavallo
 McCurdy
+MkDocs
 NOSCRIPT
 NUMPAT
 NUMPT
@@ -65,8 +66,10 @@ OpenTracing
 Otel
 POJO
 POJOs
+PoolConfig
 PubSub
 Queable
+README
 READONLY
 RediSearch
 RediSearchCommands
@@ -79,9 +82,11 @@ RedisGraph
 RedisInstrumentor
 RedisJSON
 RedisTimeSeries
+Redislabs
 SHA
 SSLParameters
 SSLSocketFactory
+SafeEncoder
 SearchCommands
 SentinelCommands
 SentinelConnectionPool
@@ -126,6 +131,7 @@ bool
 boolean
 booleans
 bysource
+cd
 charset
 clientId
 clientKill
@@ -135,6 +141,7 @@ clusterKeySlot
 configs
 consumerName
 consumername
+csc
 cumbersome
 dbIndex
 dbSize
@@ -159,6 +166,7 @@ geoadd
 georadiusByMemberStore
 georadiusStore
 getbit
+github
 gmail
 groupname
 hdel
@@ -171,6 +179,7 @@ hset
 hsetnx
 hstrlen
 http
+https
 idx
 iff
 incr
@@ -178,13 +187,17 @@ incrBy
 incrByFloat
 ini
 io
+jedis
 json
+kb
 keyslot
 keyspace
 keysvalues
+kllayn
 kwarg
 lastName
 lastsave
+learningpath
 linsert
 linters
 llen
@@ -197,14 +210,13 @@ makeapullrequest
 maxLen
 maxdepth
 maya
+md
 memberCoordinateMap
 mget
 microservice
 microservices
 millisecondsTimestamp
-MkDocs
 mkdocs
-md
 mset
 msetnx
 multikey
@@ -222,16 +234,18 @@ pexpire
 pexpireAt
 pfadd
 pfcount
+pipelining
 pmessage
 png
 pre
+produsage
 psubscribe
 pttl
 pubsub
 punsubscribe
 py
 pypi
-PoolConfig
+qsrk
 quickstart
 readonly
 readwrite
@@ -242,12 +256,10 @@ reinitialization
 renamenx
 replicaof
 repo
-README
 rpush
 rpushx
 runtime
 sadd
-SafeEncoder
 scard
 scoreMembers
 sdiffstore
@@ -270,7 +282,6 @@ strlen
 stunnel
 subcommands
 sunionstore
-pipelining
 thevalueofmykey
 timeseries
 toctree
@@ -289,13 +300,16 @@ url
 virtualenv
 waitReplicas
 whenver
+wtd
 www
 xack
 xdel
 xgroupDelConsumer
 xgroupDestroy
 xlen
+xpx
 xtrim
+yml
 zadd
 zcard
 zcount
@@ -322,4 +336,3 @@ zrevrangeByScore
 zrevrangeByScoreWithScores
 zrevrangeWithScores
 zunionstore
-yml
diff --git a/docs/tutorials_examples.md b/docs/tutorials_examples.md
new file mode 100644
index 0000000000..16b90842ba
--- /dev/null
+++ b/docs/tutorials_examples.md
@@ -0,0 +1,21 @@
+# Tutorials and Examples
+
+## General
+
+* Redis for Java Developers: <https://university.redis.io/learningpath/kllayn0wtd847i>
+* Jedis Guide: <https://redis.io/docs/latest/develop/clients/jedis/>
+* Connecting to a Redis server: <https://redis.io/docs/latest/develop/clients/jedis/connect/>
+* Using Jedis in production: <https://redis.io/docs/latest/develop/clients/jedis/produsage/>
+
+## Client-side Caching
+
+* Client-side Caching: <https://github.com/Redislabs-Solution-Architects/redis-client-side-caching-csc-jedis-demo>
+
+## JSON
+
+* Store, Read and Search JSON: <https://redis.io/kb/doc/1cd7hi2721/learn-to-store-read-and-search-data-in-json-documents-using-jedis>
+
+## Search
+
+* Vector Search: <https://redis.io/kb/doc/13qsrk8xpx/how-to-perform-vector-search-in-java-with-the-jedis-client-library>
+* Spring Boot Search: <https://github.com/Redislabs-Solution-Architects/Spring-Boot-RediSearch-Example>
diff --git a/mkdocs.yml b/mkdocs.yml
index 83000d59c1..679393261b 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -30,6 +30,7 @@ nav:
   - Failover: failover.md
   - FAQ: faq.md
   - API Reference: https://www.javadoc.io/doc/redis.clients/jedis/latest/index.html
+  - Tutorials and Examples:  tutorials_examples.md
   - Jedis Guide: https://redis.io/docs/latest/develop/connect/clients/java/jedis/
   - Redis Command Reference: https://redis.io/docs/latest/commands/