Skip to content

Commit

Permalink
Add examples and tutorials page (#4024)
Browse files Browse the repository at this point in the history
* add exmples and tutorials page

* update wordlist
  • Loading branch information
joshrotenberg authored Nov 19, 2024
1 parent f498513 commit fcdc0d5
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 10 deletions.
33 changes: 23 additions & 10 deletions .github/wordlist.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
!!!Spelling check failed!!!
APM
ARGV
BaseObjectPoolConfig
BFCommands
BaseObjectPoolConfig
BitOP
BitPosParams
BuilderFactory
Expand All @@ -20,10 +20,10 @@ CoreCommands
Dockerfile
EVAL
EVALSHA
Failback
Failover
FTCreateParams
FTSearchParams
Failback
Failover
GSON
GenericObjectPool
GenericObjectPoolConfig
Expand Down Expand Up @@ -54,6 +54,7 @@ ListPosition
Ludovico
Magnocavallo
McCurdy
MkDocs
NOSCRIPT
NUMPAT
NUMPT
Expand All @@ -65,8 +66,10 @@ OpenTracing
Otel
POJO
POJOs
PoolConfig
PubSub
Queable
README
READONLY
RediSearch
RediSearchCommands
Expand All @@ -79,9 +82,11 @@ RedisGraph
RedisInstrumentor
RedisJSON
RedisTimeSeries
Redislabs
SHA
SSLParameters
SSLSocketFactory
SafeEncoder
SearchCommands
SentinelCommands
SentinelConnectionPool
Expand Down Expand Up @@ -126,6 +131,7 @@ bool
boolean
booleans
bysource
cd
charset
clientId
clientKill
Expand All @@ -135,6 +141,7 @@ clusterKeySlot
configs
consumerName
consumername
csc
cumbersome
dbIndex
dbSize
Expand All @@ -159,6 +166,7 @@ geoadd
georadiusByMemberStore
georadiusStore
getbit
github
gmail
groupname
hdel
Expand All @@ -171,20 +179,25 @@ hset
hsetnx
hstrlen
http
https
idx
iff
incr
incrBy
incrByFloat
ini
io
jedis
json
kb
keyslot
keyspace
keysvalues
kllayn
kwarg
lastName
lastsave
learningpath
linsert
linters
llen
Expand All @@ -197,14 +210,13 @@ makeapullrequest
maxLen
maxdepth
maya
md
memberCoordinateMap
mget
microservice
microservices
millisecondsTimestamp
MkDocs
mkdocs
md
mset
msetnx
multikey
Expand All @@ -222,16 +234,18 @@ pexpire
pexpireAt
pfadd
pfcount
pipelining
pmessage
png
pre
produsage
psubscribe
pttl
pubsub
punsubscribe
py
pypi
PoolConfig
qsrk
quickstart
readonly
readwrite
Expand All @@ -242,12 +256,10 @@ reinitialization
renamenx
replicaof
repo
README
rpush
rpushx
runtime
sadd
SafeEncoder
scard
scoreMembers
sdiffstore
Expand All @@ -270,7 +282,6 @@ strlen
stunnel
subcommands
sunionstore
pipelining
thevalueofmykey
timeseries
toctree
Expand All @@ -289,13 +300,16 @@ url
virtualenv
waitReplicas
whenver
wtd
www
xack
xdel
xgroupDelConsumer
xgroupDestroy
xlen
xpx
xtrim
yml
zadd
zcard
zcount
Expand All @@ -322,4 +336,3 @@ zrevrangeByScore
zrevrangeByScoreWithScores
zrevrangeWithScores
zunionstore
yml
21 changes: 21 additions & 0 deletions docs/tutorials_examples.md
Original file line number Diff line number Diff line change
@@ -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>
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/

0 comments on commit fcdc0d5

Please sign in to comment.