Merge branch 'main' into DOC-4928

Author: rrelledge

.github/workflows/redisvl_docs_sync.yaml

@@ -107,13 +107,15 @@ jobs:
 
           # Convert jupyter notebooks to markdown
           jupyter nbconvert --to markdown build/jupyter_execute/user_guide/*.ipynb --output-dir redis_vl_hugo/user_guide/ 2>/dev/null
+          jupyter nbconvert --to markdown build/jupyter_execute/user_guide/release_guide/*.ipynb --output-dir redis_vl_hugo/user_guide/release_guide/ 2>/dev/null
           jupyter nbconvert --to markdown build/jupyter_execute/overview/cli.ipynb --output-dir redis_vl_hugo/overview/ 2>/dev/null
 
           # Prepare markdown files
           rsync -a ./build/markdown/api/ ./redis_vl_hugo/api/ --exclude=index.md
           cp ./build/markdown/overview/installation.md ./redis_vl_hugo/overview/installation.md
 
           # Format markdown files
+          shopt -s globstar
           markdown_pages=(./redis_vl_hugo/**/*.md)
 
           for markdown_page in "${markdown_pages[@]}"; do
@@ -208,19 +210,21 @@ jobs:
           # Format _index.md pages
           cp ./build/markdown/api/index.md ./redis_vl_hugo/api/_index.md
           cp ./build/markdown/user_guide/index.md ./redis_vl_hugo/user_guide/_index.md
+          cp ./build/markdown/user_guide/release_guide/index.md ./redis_vl_hugo/user_guide/release_guide/_index.md
           cp ./build/markdown/overview/index.md ./redis_vl_hugo/overview/_index.md
 
           index_markdown_pages=(
               ./redis_vl_hugo/api/_index.md
               ./redis_vl_hugo/user_guide/_index.md
+              ./redis_vl_hugo/user_guide/release_guide/_index.md
               ./redis_vl_hugo/overview/_index.md
           )
 
           for index_markdown_page in "${index_markdown_pages[@]}"; do
               format "${index_markdown_page}"
 
               # Fix relrefs by removing .md extension and references to numbered pages
-              sed -E -i 's/\.md/\//g; s/\([0-9]+_/\(/g' "${index_markdown_page}"
+              sed -E -i 's/\.md/\//g; s/\([0-9]{2}_/\(/g; s/\/index\//\//g' "${index_markdown_page}"
           done
 
           # Rename user guides to strip leading numbers from filename

content/develop/clients/dotnet/condexec.md

@@ -12,7 +12,7 @@ categories:
 description: Understand how `NRedisStack` uses conditional execution
 linkTitle: Conditional execution
 title: Conditional execution
-weight: 6
+weight: 60
 ---
 
 Most Redis client libraries use transactions with the

content/develop/clients/dotnet/connect.md

@@ -12,7 +12,7 @@ categories:
 description: Connect your .NET application to a Redis database
 linkTitle: Connect
 title: Connect to the server
-weight: 2
+weight: 20
 ---
 
 ## Basic connection

content/develop/clients/dotnet/produsage.md

@@ -0,0 +1,112 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+description: Get your NRedisStack app ready for production
+linkTitle: Production usage
+title: Production usage
+weight: 70
+---
+
+This guide offers recommendations to get the best reliability and
+performance in your production environment.
+
+## Checklist
+
+Each item in the checklist below links to the section
+for a recommendation. Use the checklist icons to record your
+progress in implementing the recommendations.
+
+{{< checklist "dotnetprodlist" >}}
+    {{< checklist-item "#event-handling" >}}Event handling{{< /checklist-item >}}
+    {{< checklist-item "#timeouts" >}}Timeouts{{< /checklist-item >}}
+    {{< checklist-item "#exception-handling" >}}Exception handling{{< /checklist-item >}}
+{{< /checklist >}}
+
+## Recommendations
+
+The sections below offer recommendations for your production environment. Some
+of them may not apply to your particular use case.
+
+### Event handling
+
+The `ConnectionMultiplexer` class publishes several different types of
+[events](https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/events/)
+for situations such as configuration changes and connection failures.
+Use these events to record server activity in a log, which you can then use
+to monitor performance and diagnose problems when they occur.
+See
+the StackExchange.Redis
+[Events](https://stackexchange.github.io/StackExchange.Redis/Events)
+page for the full list of events.
+
+#### Server notification events
+
+Some servers (such as Azure Cache for Redis) send notification events shortly
+before scheduled maintenance is due to happen. You can use code like the
+following to respond to these events (see the 
+[StackExchange.Redis](https://stackexchange.github.io/StackExchange.Redis/ServerMaintenanceEvent)
+docs for the full list of supported events). For example, you could
+inform users who try to connect that service is temporarily unavailable
+rather than letting them run into errors.
+
+```cs
+using NRedisStack;
+using StackExchange.Redis;
+
+ConnectionMultiplexer muxer = ConnectionMultiplexer.Connect("localhost:6379");
+
+muxer.ServerMaintenanceEvent += (object sender, ServerMaintenanceEvent e) => {
+    // Identify the event and respond to it here.
+    Console.WriteLine($"Maintenance event: {e.RawMessage}");
+};
+```
+
+### Timeouts
+
+If a network or server error occurs while your code is opening a
+connection or issuing a command, it can end up hanging indefinitely.
+To prevent this, `NRedisStack` sets timeouts for socket
+reads and writes and for opening connections.
+
+By default, the timeout is five seconds for all operations, but
+you can set the time (in milliseconds) separately for connections
+and commands using the `ConnectTimeout`, `SyncTimeout`, and
+`AsyncTimeout` configuration options:
+
+```cs
+var muxer = ConnectionMultiplexer.Connect(new ConfigurationOptions {
+    ConnectTimeout = 1000,  // 1 second timeout for connections.
+    SyncTimeout = 2000,     // 2 seconds for synchronous commands.
+    AsyncTimeout = 3000     // 3 seconds for asynchronous commands.
+        .
+        .
+});
+
+var db = muxer.GetDatabase();
+```
+
+The default timeouts are a good starting point, but you may be able
+to improve performance by adjusting the values to suit your use case.
+
+### Exception handling
+
+Redis handles many errors using return values from commands, but there
+are also situations where exceptions can be thrown. In production code,
+you should handle exceptions as they occur. The list below describes some
+the most common Redis exceptions:
+
+- `RedisConnectionException`: Thrown when a connection attempt fails.
+- `RedisTimeoutException`: Thrown when a command times out.
+- `RedisCommandException`: Thrown when you issue an invalid command.
+- `RedisServerException`: Thrown when you attempt an invalid operation
+  (for example, trying to access a
+  [stream entry]({{< relref "/develop/data-types/streams#entry-ids" >}})
+  using an invalid ID).

content/develop/clients/dotnet/queryjson.md

@@ -12,7 +12,7 @@ categories:
 description: Learn how to use the Redis query engine with JSON and hash documents.
 linkTitle: Index and query documents
 title: Index and query documents
-weight: 2
+weight: 30
 ---
 
 This example shows how to create a

content/develop/clients/dotnet/transpipe.md

@@ -12,7 +12,7 @@ categories:
 description: Learn how to use Redis pipelines and transactions
 linkTitle: Pipelines/transactions
 title: Pipelines and transactions
-weight: 5
+weight: 50
 ---
 
 Redis lets you send a sequence of commands to the server together in a batch.

content/develop/clients/dotnet/vecsearch.md

@@ -12,7 +12,7 @@ categories:
 description: Learn how to index and query vector embeddings with Redis
 linkTitle: Index and query vectors
 title: Index and query vectors
-weight: 3
+weight: 40
 ---
 
 [Redis Query Engine]({{< relref "/develop/interact/search-and-query" >}})

content/develop/clients/nodejs/connect.md

@@ -94,7 +94,7 @@ await cluster.set('foo', 'bar');
 const value = await cluster.get('foo');
 console.log(value); // returns 'bar'
 
-await cluster.quit();
+await cluster.close();
 ```
 
 ## Connect to your production Redis with TLS
@@ -123,15 +123,21 @@ await client.set('foo', 'bar');
 const value = await client.get('foo');
 console.log(value) // returns 'bar'
 
-await client.disconnect();
+await client.destroy();
 ```
 
 You can also use discrete parameters and UNIX sockets. Details can be found in the [client configuration guide](https://github.com/redis/node-redis/blob/master/docs/client-configuration.md).
 
 ## Reconnect after disconnection
 
-By default, `node-redis` doesn't attempt to reconnect automatically when
-the connection to the server is lost. However, you can set the
+`node-redis` can attempt to reconnect automatically when
+the connection to the server is lost. By default, it will retry
+the connection using an
+[exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff)
+strategy with some random "jitter" added to avoid multiple
+clients retrying in sync with each other.
+
+You can also set the
 `socket.reconnectionStrategy` field in the configuration to decide
 whether to try to reconnect and how to approach it. Choose one of the following values for
 `socket.reconnectionStrategy`:
@@ -159,19 +165,18 @@ from the function can be any of the following:
     no attempt was made to reconnect.
 
 The example below shows a `reconnectionStrategy` function that implements a
-custom [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff)
-strategy:
+custom exponential backoff strategy:
 
 ```js
 createClient({
   socket: {
     reconnectStrategy: retries => {
-        // Generate a random jitter between 0 – 200 ms:
-        const jitter = Math.floor(Math.random() * 200);
+        // Generate a random jitter between 0 – 100 ms:
+        const jitter = Math.floor(Math.random() * 100);
 
-        // Delay is an exponential back off, (times^2) * 50 ms, with a
-        // maximum value of 2000 ms:
-        const delay = Math.min(Math.pow(2, retries) * 50, 2000);
+        // Delay is an exponential backoff, (2^retries) * 50 ms, with a
+        // maximum value of 3000 ms:
+        const delay = Math.min(Math.pow(2, retries) * 50, 3000);
 
         return delay + jitter;
     }
@@ -193,6 +198,12 @@ related to connection:
     parameter. This is usually a network issue such as "Socket closed unexpectedly".
 -   `reconnecting`: (No parameters) The client is about to try reconnecting after the
     connection was lost due to an error.
+-   `sharded-channel-moved`: The cluster slot of a subscribed
+    [sharded pub/sub channel]({{< relref "/develop/interact/pubsub#sharded-pubsub" >}})
+    has been moved to another shard. Note that when you use a
+    [`RedisCluster`](#connect-to-a-redis-cluster) connection, this event is automatically
+    handled for you. See
+    [`sharded-channel-moved` event](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md#sharded-channel-moved-event) for more information.
 
 Use code like the following to respond to these events:
 

content/develop/clients/nodejs/produsage.md

@@ -15,8 +15,22 @@ title: Production usage
 weight: 5
 ---
 
-The following sections explain how to handle situations that may occur
-in your production environment.
+This guide offers recommendations to get the best reliability and
+performance in your production environment.
+
+## Checklist
+
+Each item in the checklist below links to the section
+for a recommendation. Use the checklist icons to record your
+progress in implementing the recommendations.
+
+{{< checklist "nodeprodlist" >}}
+    {{< checklist-item "#handling-errors" >}}Handling errors{{< /checklist-item >}}
+    {{< checklist-item "#handling-reconnections" >}}Handling reconnections{{< /checklist-item >}}
+    {{< checklist-item "#timeouts" >}}Timeouts{{< /checklist-item >}}
+{{< /checklist >}}
+
+## Recommendations
 
 ### Handling errors
 
@@ -41,36 +55,13 @@ client.on('error', error => {
 
 ### Handling reconnections
 
-If network issues or other problems unexpectedly close the socket, the client will reject all commands already sent, since the server might have already executed them.
-The rest of the pending commands will remain queued in memory until a new socket is established.
-This behaviour is controlled by the `enableOfflineQueue` option, which is enabled by default.
-
-The client uses `reconnectStrategy` to decide when to attempt to reconnect. 
-The default strategy is to calculate the delay before each attempt based on the attempt number `Math.min(retries * 50, 500)`. You can customize this strategy by passing a supported value to `reconnectStrategy` option:
-
-
-1. Define a callback `(retries: number, cause: Error) => false | number | Error` **(recommended)**
-```typescript
-const client = createClient({
-  socket: {
-    reconnectStrategy: function(retries) {
-        if (retries > 20) {
-            console.log("Too many attempts to reconnect. Redis connection was terminated");
-            return new Error("Too many retries.");
-        } else {
-            return retries * 500;
-        }
-    }
-  }
-});
-client.on('error', error => console.error('Redis client error:', error));
-```
-In the provided reconnection strategy callback, the client attempts to reconnect up to 20 times with a delay of `retries * 500` milliseconds between attempts. 
-After approximately two minutes, the client logs an error message and terminates the connection if the maximum retry limit is exceeded.
-
-
-2. Use a numerical value to set a fixed delay in milliseconds.
-3. Use `false` to disable reconnection attempts. This option should only be used for testing purposes.
+When the socket closes unexpectedly (without calling the `quit()` or `disconnect()` methods),
+the client can automatically restore the connection.  A simple
+[exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) strategy
+for reconnection is enabled by default, but you can replace this with your
+own custom strategy. See
+[Reconnect after disconnection]({{< relref "/develop/clients/nodejs/connect#reconnect-after-disconnection" >}})
+for more information.
 
 ### Timeouts
 

content/develop/clients/nodejs/queryjson.md

@@ -34,9 +34,9 @@ Add the following dependencies:
 ```js
 import {
     createClient,
-    SchemaFieldTypes,
-    AggregateGroupByReducers,
-    AggregateSteps,
+    SCHEMA_FIELD_TYPE,
+    FT_AGGREGATE_GROUP_BY_REDUCERS,
+    FT_AGGREGATE_STEPS,
 } from 'redis';
 ```