Skip to content

Commit 496f355

Browse files
committed
Merge branch 'main' into preview-cmek
2 parents 0ce5678 + ac374de commit 496f355

File tree

434 files changed

+6970
-2203
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

434 files changed

+6970
-2203
lines changed

.github/workflows/redisvl_docs_sync.yaml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ jobs:
6666
---
6767
linkTitle: ${linkTitle}
6868
title: ${title}
69-
type: integration
7069
EOL
7170
7271
# Inject weight property for index pages to preserve order
@@ -107,7 +106,6 @@ jobs:
107106
108107
# Convert jupyter notebooks to markdown
109108
jupyter nbconvert --to markdown build/jupyter_execute/user_guide/*.ipynb --output-dir redis_vl_hugo/user_guide/ 2>/dev/null
110-
jupyter nbconvert --to markdown build/jupyter_execute/user_guide/release_guide/*.ipynb --output-dir redis_vl_hugo/user_guide/release_guide/ 2>/dev/null
111109
jupyter nbconvert --to markdown build/jupyter_execute/overview/cli.ipynb --output-dir redis_vl_hugo/overview/ 2>/dev/null
112110
113111
# Prepare markdown files
@@ -125,7 +123,7 @@ jobs:
125123
sed -E -i 's/^> *//g; s/\x1b\[[0-9;]*m//g' "${markdown_page}"
126124
127125
# Replace https://docs.redisvl.com links
128-
sed -E -i 's#https://docs.redisvl.com/en/latest/.+/([^_]+).+\.html(\#[^)]+)#{{< relref "\1\2" >}}#g; s#https://docs.redisvl.com/en/latest/(.+)\.html#https://redis.io/docs/latest/integrate/redisvl/\1#g' "${markdown_page}"
126+
sed -E -i 's#https://docs.redisvl.com/en/latest/.+/([^_]+).+\.html(\#[^)]+)#{{< relref "\1\2" >}}#g; s#https://docs.redisvl.com/en/latest/(.+)\.html#https://redis.io/docs/latest/develop/ai/redisvl/\1#g' "${markdown_page}"
129127
done
130128
131129
# Fix links in api pages
@@ -210,13 +208,11 @@ jobs:
210208
# Format _index.md pages
211209
cp ./build/markdown/api/index.md ./redis_vl_hugo/api/_index.md
212210
cp ./build/markdown/user_guide/index.md ./redis_vl_hugo/user_guide/_index.md
213-
cp ./build/markdown/user_guide/release_guide/index.md ./redis_vl_hugo/user_guide/release_guide/_index.md
214211
cp ./build/markdown/overview/index.md ./redis_vl_hugo/overview/_index.md
215212
216213
index_markdown_pages=(
217214
./redis_vl_hugo/api/_index.md
218215
./redis_vl_hugo/user_guide/_index.md
219-
./redis_vl_hugo/user_guide/release_guide/_index.md
220216
./redis_vl_hugo/overview/_index.md
221217
)
222218
@@ -236,7 +232,7 @@ jobs:
236232
fi
237233
done
238234
239-
cp -r redis_vl_hugo/* content/integrate/redisvl/
235+
cp -r redis_vl_hugo/* content/develop/ai/redisvl/
240236
241237
- name: 'Create pull request if necessary'
242238
env:
@@ -262,12 +258,12 @@ jobs:
262258
git checkout -b "${branch}"
263259
fi
264260
265-
redisvl_is_different=$(git diff content/integrate/redisvl/)
261+
redisvl_is_different=$(git diff content/develop/ai/redisvl/)
266262
267263
if [[ ! -z $redisvl_is_different ]]; then
268264
redisvl_change=true
269265
270-
git add "content/integrate/redisvl/"
266+
git add "content/develop/ai/redisvl/"
271267
git config user.email "177626021+redisdocsapp[bot]@users.noreply.github.com"
272268
git config user.name "redisdocsapp[bot]"
273269
git commit -m "Update for redisvl ${release}"

assets/css/index.css

Lines changed: 53 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,61 @@ section.prose {
2323
@apply font-geist
2424
}
2525

26-
.prose h1,
27-
.prose h3,
28-
.prose h4,
29-
.prose h5,
30-
.prose h6 {
31-
@apply font-normal;
26+
.prose h1 {
27+
@apply text-4xl font-normal break-words;
3228
}
3329

3430
.prose h2 {
35-
@apply text-lg font-medium pb-3 border-b border-b-redis-pen-700 border-opacity-50;
31+
@apply text-2xl font-medium pb-3 border-b border-b-redis-pen-700 border-opacity-50;
32+
}
33+
34+
.prose h3 {
35+
@apply text-xl font-semibold;
36+
}
37+
38+
.prose h4 {
39+
@apply text-lg font-medium;
40+
}
41+
42+
.prose h5 {
43+
@apply text-base font-medium;
44+
}
45+
46+
.prose h6 {
47+
@apply text-sm font-medium;
48+
}
49+
50+
/* Header link styles */
51+
.header-link {
52+
@apply text-slate-400 hover:text-slate-600 transition-all duration-200 no-underline cursor-pointer;
53+
text-decoration: none !important;
54+
vertical-align: baseline;
55+
}
56+
57+
.header-link:hover {
58+
@apply text-slate-600;
59+
text-decoration: none !important;
60+
}
61+
62+
.header-link svg {
63+
@apply w-4 h-4 inline-block;
64+
vertical-align: baseline;
65+
}
66+
67+
/* Ensure header links don't interfere with prose styling */
68+
.prose h1 .header-link,
69+
.prose h2 .header-link,
70+
.prose h3 .header-link,
71+
.prose h4 .header-link,
72+
.prose h5 .header-link,
73+
.prose h6 .header-link {
74+
@apply text-slate-400 hover:text-slate-600;
75+
text-decoration: none !important;
76+
}
77+
78+
/* Feedback state for copied links */
79+
.header-link.copied {
80+
@apply text-green-500;
3681
}
3782

3883
.prose p, .prose ol, .prose ul {
@@ -47,10 +92,6 @@ section.prose {
4792
@apply bg-none font-monogeist;
4893
}
4994

50-
.prose h1 {
51-
@apply text-4xl break-words;
52-
}
53-
5495
.prose h1[id],
5596
.prose h2[id],
5697
.prose h3[id],
@@ -382,7 +423,7 @@ select {
382423

383424
.codetabs.cli > .panel .highlight > .chroma {
384425
margin: 1rem 1rem 0.1rem 0.1rem;
385-
overflow-x: hidden;
426+
overflow-x: auto;
386427
padding-bottom: 0;
387428
}
388429

config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ rdi_redis_gears_version = "1.2.6"
5555
rdi_debezium_server_version = "2.3.0.Final"
5656
rdi_db_types = "cassandra|mysql|oracle|postgresql|sqlserver"
5757
rdi_cli_latest = "latest"
58-
rdi_current_version = "1.10.0"
58+
rdi_current_version = "1.12.2"
5959

6060
[params.clientsConfig]
6161
"Python"={quickstartSlug="redis-py"}

content/apis/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ The existing Redis commands cover most use cases, but if low latency is a critic
2626

2727
Lua scripts have been available since early versions of Redis. With Lua, the script is provided by the client and cached on the server side, which implies the risk that different clients might use a different script version.
2828

29-
- [Redis Lua API reference]({{< relref "/develop/interact/programmability/lua-api" >}})
30-
- [Scripting with Lua introduction]({{< relref "/develop/interact/programmability/eval-intro" >}})
29+
- [Redis Lua API reference]({{< relref "/develop/programmability/lua-api" >}})
30+
- [Scripting with Lua introduction]({{< relref "/develop/programmability/eval-intro" >}})
3131

3232
The Redis functions feature, which became available in Redis 7, supersedes the use of Lua in prior versions of Redis. The client is still responsible for invoking the execution, but unlike the previous Lua scripts, functions can now be replicated and persisted.
3333

34-
- [Functions and scripting in Redis 7 and beyond]({{< relref "/develop/interact/programmability/functions-intro" >}})
34+
- [Functions and scripting in Redis 7 and beyond]({{< relref "/develop/programmability/functions-intro" >}})
3535

3636
If none of the previous methods fulfills your needs, then you can extend the functionality of Redis with new commands using the Redis Modules API.
3737

content/commands/cluster-info.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ Here are the explanation of these fields:
6666
* `cluster_stats_messages_pong_sent` and `cluster_stats_messages_pong_received`: PONG (reply to PING).
6767
* `cluster_stats_messages_meet_sent` and `cluster_stats_messages_meet_received`: Handshake message sent to a new node, either through gossip or [`CLUSTER MEET`]({{< relref "/commands/cluster-meet" >}}).
6868
* `cluster_stats_messages_fail_sent` and `cluster_stats_messages_fail_received`: Mark node xxx as failing.
69-
* `cluster_stats_messages_publish_sent` and `cluster_stats_messages_publish_received`: Pub/Sub Publish propagation, see [Pubsub]({{< relref "/develop/interact/pubsub#pubsub" >}}).
69+
* `cluster_stats_messages_publish_sent` and `cluster_stats_messages_publish_received`: Pub/Sub Publish propagation, see [Pubsub]({{< relref "/develop/pubsub#pubsub" >}}).
7070
* `cluster_stats_messages_auth-req_sent` and `cluster_stats_messages_auth-req_received`: Replica initiated leader election to replace its master.
7171
* `cluster_stats_messages_auth-ack_sent` and `cluster_stats_messages_auth-ack_received`: Message indicating a vote during leader election.
7272
* `cluster_stats_messages_update_sent` and `cluster_stats_messages_update_received`: Another node slots configuration.
7373
* `cluster_stats_messages_mfstart_sent` and `cluster_stats_messages_mfstart_received`: Pause clients for manual failover.
7474
* `cluster_stats_messages_module_sent` and `cluster_stats_messages_module_received`: Module cluster API message.
75-
* `cluster_stats_messages_publishshard_sent` and `cluster_stats_messages_publishshard_received`: Pub/Sub Publish shard propagation, see [Sharded Pubsub]({{< relref "/develop/interact/pubsub#sharded-pubsub" >}}).
75+
* `cluster_stats_messages_publishshard_sent` and `cluster_stats_messages_publishshard_received`: Pub/Sub Publish shard propagation, see [Sharded Pubsub]({{< relref "/develop/pubsub#sharded-pubsub" >}}).
7676

7777
More information about the Current Epoch and Config Epoch variables are available in the [Redis Cluster specification document]({{< relref "/operate/oss_and_stack/reference/cluster-spec#cluster-current-epoch" >}}).
7878

content/commands/cms.incrby.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,30 @@ Increases the count of item by increment. Multiple items can be increased with o
4545
* **item**: The item which counter is to be increased.
4646
* **increment**: Amount by which the item counter is to be increased.
4747

48-
## Return
49-
50-
51-
[Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) with an updated min-count of each of the items in the sketch.
52-
53-
Count of each item after increment.
54-
5548
## Examples
5649

5750
```
5851
redis> CMS.INCRBY test foo 10 bar 42
5952
1) (integer) 10
6053
2) (integer) 42
6154
```
55+
56+
## Return information
57+
58+
{{< multitabs id=“cms-incrby-return-info"
59+
tab1="RESP2"
60+
tab2="RESP3" >}}
61+
62+
One of the following:
63+
64+
* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [integer replies]({{< relref "/develop/reference/protocol-spec#integers" >}}) representing updated min-counts of each of the provided items in the sketch.
65+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, missing key, overflow, or wrong key type.
66+
67+
-tab-sep-
68+
69+
One of the following:
70+
71+
* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [integer replies]({{< relref "/develop/reference/protocol-spec#integers" >}}) representing updated min-counts of each of the provided items in the sketch.
72+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, missing key, overflow, or wrong key type.
73+
74+
{{< /multitabs >}}

content/commands/cms.info.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,6 @@ Returns width, depth and total count of the sketch.
3535

3636
* **key**: The name of the sketch.
3737

38-
## Return
39-
40-
[Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) with information of the filter.
41-
4238
## Examples
4339

4440
```
@@ -50,3 +46,21 @@ redis> CMS.INFO test
5046
5) count
5147
6) (integer) 0
5248
```
49+
50+
{{< multitabs id=“cms-info-return-info"
51+
tab1="RESP2"
52+
tab2="RESP3" >}}
53+
54+
One of the following:
55+
56+
* [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) and [integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) pairs containing sketch information.
57+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, missing key, or wrong key type.
58+
59+
-tab-sep-
60+
61+
One of the following:
62+
63+
* [Map reply]({{< relref "/develop/reference/protocol-spec#maps" >}}) of [simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) and [integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) pairs containing sketch information.
64+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, missing key, or wrong key type.
65+
66+
{{< /multitabs >}}

content/commands/cms.initbydim.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,29 @@ Initializes a Count-Min Sketch to dimensions specified by user.
4242
* **depth**: Number of counter-arrays. Reduces the probability for an
4343
error of a certain size (percentage of total count).
4444

45-
## Return
46-
47-
[Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly, or [] otherwise.
48-
4945
## Examples
5046

5147
```
5248
redis> CMS.INITBYDIM test 2000 5
5349
OK
54-
```
50+
```
51+
52+
## Return information
53+
54+
{{< multitabs id=“cms-initbydim-return-info"
55+
tab1="RESP2"
56+
tab2="RESP3" >}}
57+
58+
One of the following:
59+
60+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
61+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if the given key already exists.
62+
63+
-tab-sep-
64+
65+
One of the following:
66+
67+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
68+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if the given key already exists.
69+
70+
{{< /multitabs >}}

content/commands/cms.initbyprob.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,31 @@ Initializes a Count-Min Sketch to accommodate requested tolerances.
4444
be a decimal value between 0 and 1. This effects the depth of the sketch.
4545
For example, for a desired false positive rate of 0.1% (1 in 1000),
4646
error_rate should be set to 0.001. The closer this number is to zero, the
47-
greater the memory consumption per item and the more CPU usage per operation.
48-
49-
## Return
50-
51-
[Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly, or [] otherwise.
47+
greater the memory consumption per item and the more CPU usage per operation.
5248

5349
## Examples
5450

5551
```
5652
redis> CMS.INITBYPROB test 0.001 0.01
5753
OK
58-
```
54+
```
55+
56+
## Return information
57+
58+
{{< multitabs id=“cms-initbyprob-return-info"
59+
tab1="RESP2"
60+
tab2="RESP3" >}}
61+
62+
One of the following:
63+
64+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
65+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if the given key already exists.
66+
67+
-tab-sep-
68+
69+
One of the following:
70+
71+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
72+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if the given key already exists.
73+
74+
{{< /multitabs >}}

content/commands/cms.merge.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,29 @@ Merges several sketches into one sketch. All sketches must have identical width
5353
* **src**: Names of source sketches to be merged.
5454
* **weight**: Multiple of each sketch. Default =1.
5555

56-
## Return
57-
58-
[Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly, or [] otherwise.
59-
6056
## Examples
6157

6258
```
6359
redis> CMS.MERGE dest 2 test1 test2 WEIGHTS 1 3
6460
OK
6561
```
62+
63+
## Return information
64+
65+
{{< multitabs id=“cms-merge-return-info"
66+
tab1="RESP2"
67+
tab2="RESP3" >}}
68+
69+
One of the following:
70+
71+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
72+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: non-existent key or destination key is not of the same width and/or depth.
73+
74+
-tab-sep-
75+
76+
One of the following:
77+
78+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
79+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: non-existent key or destination key is not of the same width and/or depth.
80+
81+
{{< /multitabs >}}

0 commit comments

Comments
 (0)