Skip to content

Commit fcdc0d5

Browse files
Add examples and tutorials page (#4024)
* add exmples and tutorials page * update wordlist
1 parent f498513 commit fcdc0d5

File tree

3 files changed

+45
-10
lines changed

3 files changed

+45
-10
lines changed

.github/wordlist.txt

+23-10
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
!!!Spelling check failed!!!
22
APM
33
ARGV
4-
BaseObjectPoolConfig
54
BFCommands
5+
BaseObjectPoolConfig
66
BitOP
77
BitPosParams
88
BuilderFactory
@@ -20,10 +20,10 @@ CoreCommands
2020
Dockerfile
2121
EVAL
2222
EVALSHA
23-
Failback
24-
Failover
2523
FTCreateParams
2624
FTSearchParams
25+
Failback
26+
Failover
2727
GSON
2828
GenericObjectPool
2929
GenericObjectPoolConfig
@@ -54,6 +54,7 @@ ListPosition
5454
Ludovico
5555
Magnocavallo
5656
McCurdy
57+
MkDocs
5758
NOSCRIPT
5859
NUMPAT
5960
NUMPT
@@ -65,8 +66,10 @@ OpenTracing
6566
Otel
6667
POJO
6768
POJOs
69+
PoolConfig
6870
PubSub
6971
Queable
72+
README
7073
READONLY
7174
RediSearch
7275
RediSearchCommands
@@ -79,9 +82,11 @@ RedisGraph
7982
RedisInstrumentor
8083
RedisJSON
8184
RedisTimeSeries
85+
Redislabs
8286
SHA
8387
SSLParameters
8488
SSLSocketFactory
89+
SafeEncoder
8590
SearchCommands
8691
SentinelCommands
8792
SentinelConnectionPool
@@ -126,6 +131,7 @@ bool
126131
boolean
127132
booleans
128133
bysource
134+
cd
129135
charset
130136
clientId
131137
clientKill
@@ -135,6 +141,7 @@ clusterKeySlot
135141
configs
136142
consumerName
137143
consumername
144+
csc
138145
cumbersome
139146
dbIndex
140147
dbSize
@@ -159,6 +166,7 @@ geoadd
159166
georadiusByMemberStore
160167
georadiusStore
161168
getbit
169+
github
162170
gmail
163171
groupname
164172
hdel
@@ -171,20 +179,25 @@ hset
171179
hsetnx
172180
hstrlen
173181
http
182+
https
174183
idx
175184
iff
176185
incr
177186
incrBy
178187
incrByFloat
179188
ini
180189
io
190+
jedis
181191
json
192+
kb
182193
keyslot
183194
keyspace
184195
keysvalues
196+
kllayn
185197
kwarg
186198
lastName
187199
lastsave
200+
learningpath
188201
linsert
189202
linters
190203
llen
@@ -197,14 +210,13 @@ makeapullrequest
197210
maxLen
198211
maxdepth
199212
maya
213+
md
200214
memberCoordinateMap
201215
mget
202216
microservice
203217
microservices
204218
millisecondsTimestamp
205-
MkDocs
206219
mkdocs
207-
md
208220
mset
209221
msetnx
210222
multikey
@@ -222,16 +234,18 @@ pexpire
222234
pexpireAt
223235
pfadd
224236
pfcount
237+
pipelining
225238
pmessage
226239
png
227240
pre
241+
produsage
228242
psubscribe
229243
pttl
230244
pubsub
231245
punsubscribe
232246
py
233247
pypi
234-
PoolConfig
248+
qsrk
235249
quickstart
236250
readonly
237251
readwrite
@@ -242,12 +256,10 @@ reinitialization
242256
renamenx
243257
replicaof
244258
repo
245-
README
246259
rpush
247260
rpushx
248261
runtime
249262
sadd
250-
SafeEncoder
251263
scard
252264
scoreMembers
253265
sdiffstore
@@ -270,7 +282,6 @@ strlen
270282
stunnel
271283
subcommands
272284
sunionstore
273-
pipelining
274285
thevalueofmykey
275286
timeseries
276287
toctree
@@ -289,13 +300,16 @@ url
289300
virtualenv
290301
waitReplicas
291302
whenver
303+
wtd
292304
www
293305
xack
294306
xdel
295307
xgroupDelConsumer
296308
xgroupDestroy
297309
xlen
310+
xpx
298311
xtrim
312+
yml
299313
zadd
300314
zcard
301315
zcount
@@ -322,4 +336,3 @@ zrevrangeByScore
322336
zrevrangeByScoreWithScores
323337
zrevrangeWithScores
324338
zunionstore
325-
yml

docs/tutorials_examples.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Tutorials and Examples
2+
3+
## General
4+
5+
* Redis for Java Developers: <https://university.redis.io/learningpath/kllayn0wtd847i>
6+
* Jedis Guide: <https://redis.io/docs/latest/develop/clients/jedis/>
7+
* Connecting to a Redis server: <https://redis.io/docs/latest/develop/clients/jedis/connect/>
8+
* Using Jedis in production: <https://redis.io/docs/latest/develop/clients/jedis/produsage/>
9+
10+
## Client-side Caching
11+
12+
* Client-side Caching: <https://github.com/Redislabs-Solution-Architects/redis-client-side-caching-csc-jedis-demo>
13+
14+
## JSON
15+
16+
* Store, Read and Search JSON: <https://redis.io/kb/doc/1cd7hi2721/learn-to-store-read-and-search-data-in-json-documents-using-jedis>
17+
18+
## Search
19+
20+
* Vector Search: <https://redis.io/kb/doc/13qsrk8xpx/how-to-perform-vector-search-in-java-with-the-jedis-client-library>
21+
* Spring Boot Search: <https://github.com/Redislabs-Solution-Architects/Spring-Boot-RediSearch-Example>

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ nav:
3030
- Failover: failover.md
3131
- FAQ: faq.md
3232
- API Reference: https://www.javadoc.io/doc/redis.clients/jedis/latest/index.html
33+
- Tutorials and Examples: tutorials_examples.md
3334
- Jedis Guide: https://redis.io/docs/latest/develop/connect/clients/java/jedis/
3435
- Redis Command Reference: https://redis.io/docs/latest/commands/
3536

0 commit comments

Comments
 (0)