Skip to content

Commit 58d847e

Browse files
dwdoughertymich-elle-lunakaitlynmichaelpaoloredisandy-stark-redis
authored
DOC-5423: update the modules API page (#1815)
* Improve rack-awareness documentation for Kubernetes - Add clear explanation of node labeling requirements for rack-awareness - Emphasize that ALL eligible nodes must be labeled with chosen label - Explain what eligible nodes are (nodes where RS pods can be scheduled) - Suggest topology.kubernetes.io/zone as commonly available label - Clarify that not all platforms have this label by default - Update example to use current topology.kubernetes.io/zone instead of deprecated failure-domain.beta.kubernetes.io/zone - Fix kubectl command formatting (add space after $) - Add warning about operator failing if nodes are missing labels Addresses DOC-1815 * Update content/operate/kubernetes/recommendations/node-selection.md Co-authored-by: Kaitlyn Michael <[email protected]> * Update content/operate/kubernetes/recommendations/node-selection.md Co-authored-by: Kaitlyn Michael <[email protected]> * Update content/operate/kubernetes/recommendations/node-selection.md Co-authored-by: Kaitlyn Michael <[email protected]> * Update content/operate/kubernetes/recommendations/node-selection.md Co-authored-by: Kaitlyn Michael <[email protected]> * Update content/operate/kubernetes/recommendations/node-selection.md Co-authored-by: Kaitlyn Michael <[email protected]> * Move redisvl documentation * Remove type integration * Add redisvl/_index.md * Fix relrefs * Add aliases * Add missing aliases * DOC-3967 moved/expanded keyspace page * DOC-3967 fixed links to keyspace page * DOC-3967 moved transaction and pipeline pages to reference section * DOC-3967 moved patterns folder to clients * DOC-3967 moved programmability folder into develop * DOC-3967 fixed links to programmability section * DOC-3967 added aliases to programmability pages * DOC-3967 moved pub/sub and keyspace notification pages * DOC-3967 added missing aliases * RDI: Add Reboot step after parameter group step * add link icon to section headers (#1755) * add link icon to section headers * review suggestions * toc embed fix * Attempt to fix the broken on this page ToC for embedded content that includes headers --------- Co-authored-by: Rachel Elledge <[email protected]> * mention admission controller (#1791) * relref fix (#1793) * Update content/operate/rc/api/api-reference/openapi.json * fix typo (#1795) * DOC-5419 added commands section * DOC-5419 fixed dodgy link * RS: Adjusted best practices for scalable Redis query engine & add benchmarks (#1687) * DOC-4271 RS: Adjusted best practices for scalable Redis query engine & add benchmarks * Style guide fix for indexes * Fixed broken relrefs after AI/search reorg * RS: Added missing module requirements to recover DB (#1679) * DOC-4564 RS: Added missing module requirements to recover DB * DOC-4564 Added rladmin command to identify module versions required by recoverable DBs * DOC-4564 Copied missing module requirements to recover DB to RS 7.4 and 7.8 versions * RS: Added DB port access requirement for Replica Of between different RS clusters (#1650) * DOC-3829 RS: Added DB port access requirement for Replica Of between different RS clusters * Updated relrefs to correct versions * Update ai-videos.md * Fix search-and-query documentation aliases for backward compatibility ## Critical alias fixes to resolve 404 errors and incorrect redirects: ### Fixed broken basic-constructs aliases: - field-and-type-options.md: Fixed alias to point to correct interact paths - schema-definition.md: Fixed alias to point to correct interact paths - configuration.md: Added missing interact aliases and fixed format ### Fixed directory redirect issues (_index.md files): - Added trailing slash variants for all directory aliases - Fixed indexing/ and query/ URLs that were redirecting to home page - Updated: _index.md, indexing/_index.md, query/_index.md, advanced-concepts/_index.md, administration/_index.md, best-practices/_index.md, deprecated/_index.md ### Added missing aliases: - index-mgmt-best-practices.md: Added missing interact alias - aggregations-syntax.md: Added missing interact alias ### Root causes addressed: - Aliases were incorrectly pointing to /ai/ paths instead of /interact/ paths - Directory aliases needed both with/without trailing slash variants - Some files missing interact aliases entirely These fixes should resolve: - 404 errors on basic-constructs URLs - Directory URLs redirecting to home page instead of correct AI locations - Missing backward compatibility for moved files Addresses DOC-5428 * Update redisvl workflow (#1802) * DEV: (RediSearch) doc expiration capabilities in Redis 8 (#1792) * DEV: (RediSearch) doc expiration capabilities in Redis 8 * Apply suggestions from code review Co-authored-by: andy-stark-redis <[email protected]> * Apply more suggestions from code review --------- Co-authored-by: andy-stark-redis <[email protected]> * add leading slash to alias (#1804) * DOC-5423: update the modules API page --------- Co-authored-by: mich-elle-luna <[email protected]> Co-authored-by: mich-elle-luna <[email protected]> Co-authored-by: Kaitlyn Michael <[email protected]> Co-authored-by: paoloredis <[email protected]> Co-authored-by: Andy Stark <[email protected]> Co-authored-by: Cameron Bates <[email protected]> Co-authored-by: Rachel Elledge <[email protected]> Co-authored-by: redisdocsapp[bot] <177626021+redisdocsapp[bot]@users.noreply.github.com> Co-authored-by: andy-stark-redis <[email protected]> Co-authored-by: JooYoung Lim <[email protected]> Co-authored-by: Cameron Bates <[email protected]> Co-authored-by: Rachel Elledge <[email protected]> Co-authored-by: paoloredis <[email protected]>
1 parent 493e989 commit 58d847e

File tree

170 files changed

+1361
-533
lines changed

Some content is hidden

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

170 files changed

+1361
-533
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: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,39 @@ section.prose {
4747
@apply text-sm font-medium;
4848
}
4949

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;
81+
}
82+
5083
.prose p, .prose ol, .prose ul {
5184
@apply text-base;
5285
}

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/command.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,9 @@ Command flags are an array. It can contain the following simple strings (status
101101
* **no_auth:** executing the command doesn't require authentication.
102102
* **no_async_loading:** the command is denied during asynchronous loading (that is when a replica uses disk-less `SWAPDB SYNC`, and allows access to the old dataset).
103103
* **no_mandatory_keys:** the command may accept key name arguments, but these aren't mandatory.
104-
* **no_multi:** the command isn't allowed inside the context of a [transaction]({{< relref "/develop/interact/transactions" >}}).
105-
* **noscript:** the command can't be called from [scripts]({{< relref "/develop/interact/programmability/eval-intro" >}}) or [functions]({{< relref "/develop/interact/programmability/functions-intro" >}}).
106-
* **pubsub:** the command is related to [Redis Pub/Sub]({{< relref "/develop/interact/pubsub" >}}).
104+
* **no_multi:** the command isn't allowed inside the context of a [transaction]({{< relref "develop/using-commands/transactions" >}}).
105+
* **noscript:** the command can't be called from [scripts]({{< relref "/develop/programmability/eval-intro" >}}) or [functions]({{< relref "/develop/programmability/functions-intro" >}}).
106+
* **pubsub:** the command is related to [Redis Pub/Sub]({{< relref "/develop/pubsub" >}}).
107107
* **random**: the command returns random results, which is a concern with verbatim script replication.
108108
As of Redis 7.0, this flag is a [command tip][tb].
109109
* **readonly:** the command doesn't modify data.

content/commands/eval.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@ title: EVAL
6666
Invoke the execution of a server-side Lua script.
6767

6868
The first argument is the script's source code.
69-
Scripts are written in [Lua](https://lua.org) and executed by the embedded [Lua 5.1]({{< relref "develop/interact/programmability/lua-api" >}}) interpreter in Redis.
69+
Scripts are written in [Lua](https://lua.org) and executed by the embedded [Lua 5.1]({{< relref "develop/programmability/lua-api" >}}) interpreter in Redis.
7070

7171
The second argument is the number of input key name arguments, followed by all the keys accessed by the script.
72-
These names of input keys are available to the script as the [_KEYS_ global runtime variable]({{< relref "develop/interact/programmability/lua-api#the-keys-global-variable" >}})
72+
These names of input keys are available to the script as the [_KEYS_ global runtime variable]({{< relref "develop/programmability/lua-api#the-keys-global-variable" >}})
7373
Any additional input arguments **should not** represent names of keys.
7474

7575
**Important:**
@@ -83,7 +83,7 @@ These are added to the Lua interpreter and cached to redis-server, consuming a l
8383
Starting from Redis 7.4, scripts loaded with `EVAL` or [`EVAL_RO`]({{< relref "/commands/eval_ro" >}}) will be deleted from redis after a certain number (least recently used order).
8484
The number of evicted scripts can be viewed through [`INFO`]({{< relref "/commands/info" >}})'s `evicted_scripts`.
8585

86-
Please refer to the [Redis Programmability]({{< relref "/develop/interact/programmability/" >}}) and [Introduction to Eval Scripts]({{< relref "/develop/interact/programmability/eval-intro" >}}) for more information about Lua scripts.
86+
Please refer to the [Redis Programmability]({{< relref "/develop/programmability/" >}}) and [Introduction to Eval Scripts]({{< relref "/develop/programmability/eval-intro" >}}) for more information about Lua scripts.
8787

8888
## Examples
8989

content/commands/eval_ro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ title: EVAL_RO
6565
---
6666
This is a read-only variant of the [`EVAL`]({{< relref "/commands/eval" >}}) command that cannot execute commands that modify data.
6767

68-
For more information about when to use this command vs [`EVAL`]({{< relref "/commands/eval" >}}), please refer to [Read-only scripts]({{< relref "develop/interact/programmability#read-only-scripts" >}}).
68+
For more information about when to use this command vs [`EVAL`]({{< relref "/commands/eval" >}}), please refer to [Read-only scripts]({{< relref "develop/programmability#read-only-scripts" >}}).
6969

70-
For more information about [`EVAL`]({{< relref "/commands/eval" >}}) scripts please refer to [Introduction to Eval Scripts]({{< relref "/develop/interact/programmability/eval-intro" >}}).
70+
For more information about [`EVAL`]({{< relref "/commands/eval" >}}) scripts please refer to [Introduction to Eval Scripts]({{< relref "/develop/programmability/eval-intro" >}}).
7171

7272
## Examples
7373

content/commands/evalsha.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Evaluate a script from the server's cache by its SHA1 digest.
6767
The server caches scripts by using the [`SCRIPT LOAD`]({{< relref "/commands/script-load" >}}) command.
6868
The command is otherwise identical to [`EVAL`]({{< relref "/commands/eval" >}}).
6969

70-
Please refer to the [Redis Programmability]({{< relref "/develop/interact/programmability/" >}}) and [Introduction to Eval Scripts]({{< relref "/develop/interact/programmability/eval-intro" >}}) for more information about Lua scripts.
70+
Please refer to the [Redis Programmability]({{< relref "/develop/programmability/" >}}) and [Introduction to Eval Scripts]({{< relref "/develop/programmability/eval-intro" >}}) for more information about Lua scripts.
7171

7272
## Return information
7373

content/commands/evalsha_ro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ title: EVALSHA_RO
6464
---
6565
This is a read-only variant of the [`EVALSHA`]({{< relref "/commands/evalsha" >}}) command that cannot execute commands that modify data.
6666

67-
For more information about when to use this command vs [`EVALSHA`]({{< relref "/commands/evalsha" >}}), please refer to [Read-only scripts]({{< relref "develop/interact/programmability#read-only-scripts" >}}).
67+
For more information about when to use this command vs [`EVALSHA`]({{< relref "/commands/evalsha" >}}), please refer to [Read-only scripts]({{< relref "develop/programmability#read-only-scripts" >}}).
6868

69-
For more information about [`EVALSHA`]({{< relref "/commands/evalsha" >}}) scripts please refer to [Introduction to Eval Scripts]({{< relref "/develop/interact/programmability/eval-intro" >}}).
69+
For more information about [`EVALSHA`]({{< relref "/commands/evalsha" >}}) scripts please refer to [Introduction to Eval Scripts]({{< relref "/develop/programmability/eval-intro" >}}).
7070

7171
## Return information
7272

content/commands/expire.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,10 @@ still take the full state of the expires existing in the dataset, so when a
266266
replica is elected to master it will be able to expire the keys independently,
267267
fully acting as a master.
268268

269+
### Redis Query Engine and expiration
270+
271+
Starting with Redis 8, the Redis Query Engine has enhanced behavior when handling expiring keys. For detailed information about how [`FT.SEARCH`]({{< relref "/commands/ft.search" >}}) and [`FT.AGGREGATE`]({{< relref "/commands/ft.aggregate" >}}) commands interact with expiring keys, see [Key and field expiration behavior]({{< relref "/develop/ai/search-and-query/advanced-concepts/expiration" >}}).
272+
269273
## Return information
270274

271275
{{< multitabs id="expire-return-info"

0 commit comments

Comments
 (0)