Merge branch 'main' into release-rs-apr

Author: rrelledge

.github/workflows/redisvl_docs_sync.yaml

@@ -34,7 +34,7 @@ jobs:
 
           # Get latest release
           latest_release=$(gh release -R redis/redis-vl-python list --json name,isLatest --jq '.[] | select(.isLatest)|.name')
-          git checkout "tags/${latest_release}"
+          git checkout "tags/${latest_release}" || git checkout "tags/v${latest_release}"
           pip3 install -e .
 
           popd
@@ -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

README.md

@@ -102,7 +102,7 @@ The `filename` property value can be any file name path which is relative to the
 We added a new property `class` which allows you to override the CSS class of the image. Images have by default a `block` display in Tailwind. You can change this by setting the class property to `inline`. The following example shows two images that are in a single line:
 
 ```
-{{< image filename="/images/rc/icon-database-update-status-pending.png#no-click" alt="Pending database status" class="inline" >}} &nbsp; {{< image filename="/images/rc/icon-database-update-status-active.png#no-click" alt="Active database status" class="inline" >}}
+{{< image filename="/images/rc/icon-database-update-status-pending.png#no-click" alt="Pending database status" class="inline" >}} &nbsp; {{< image filename="/images/rc/icon-database-status-active.png#no-click" alt="Active database status" class="inline" >}}
 ```
 
 ### Templating

build/image_report.py

@@ -7,17 +7,19 @@
 import os
 
 
-def scan_file(path: str) -> int:
+def scan_file(path: str, verbose: bool = True) -> list:
     """Scans a file for all `image` shortcodes.
 
     Args:
         path (str): Path to file.
+        verbose (bool, optional): If True, prints the shortcodes found. Defaults to True.
 
     Returns:
-        (int) Number of shortcodes found.
+        (list) A list of all image shortcodes found.
     """
 
     img_list = []
+    img_names = []
 
     with open(path, encoding="utf_8") as md_file:
         text = md_file.read()
@@ -26,16 +28,18 @@ def scan_file(path: str) -> int:
             text, lambda t: t.tag == "image"
         ):
             img_list.append((img, pos_info))
+            img_names.append(img.named_params["filename"])
 
-    if len(img_list) > 0:
+    if len(img_list) > 0 and verbose:
         print(f"File '{path}':")
 
         for img in img_list:
             print(
                 f"    Line {img[1].line}: '{img[0].named_params['filename']}'"
             )
 
-    return len(img_list)
+    # return len(img_list)
+    return img_names
 
 
 parser = argparse.ArgumentParser(
@@ -44,20 +48,50 @@ def scan_file(path: str) -> int:
 )
 
 parser.add_argument("pathname", help="Path of the folder to scan")
+parser.add_argument("--find-unused", nargs=1, help="Prints out all images in IMAGEFOLDER that are not found in pathname. Set pathname to the top content folder to scan all content for images.", metavar="IMAGEFOLDER")
 
 args = parser.parse_args()
 
 print(f"Scanning '{args.pathname}'")
 
 num_found = 0
+all_images_found = []
 
 for root, dirs, files in os.walk(args.pathname):
     for file in files:
         if file.endswith(".md"):
             fullpath = os.path.join(root, file)
-            num_found += scan_file(fullpath)
+            images_found = scan_file(fullpath, verbose=args.find_unused is None)
+            num_found += len(images_found)
+            all_images_found.extend(images_found)
 
 if num_found == 0:
     print(f"No image shortcodes found in '{args.pathname}'")
 else:
     print(f"Found {num_found} image shortcodes.")
+
+if args.find_unused and num_found > 0:
+    unique_images = list(set(all_images_found))
+    print(f"Found {len(unique_images)} unique images in '{args.pathname}'.")
+    print(f"Checking for images not found in '{args.pathname}' that are in '{args.find_unused[0]}'")
+
+    unused_images = []
+    total_images = 0
+
+    for root, dirs, files in os.walk(args.find_unused[0]):
+        for file in files:
+            if (file.endswith(".png") or file.endswith(".jpg") or file.endswith(".webp")):
+                total_images += 1
+                if not any(file in img for img in unique_images):
+                    img_filepath = os.path.join(root, file)
+                    print(f"    Image '{img_filepath}' not found in '{args.pathname}'")
+                    unused_images.append(img_filepath)
+
+    print(f"Found {len(unused_images)} unused images out of {total_images} images in '{args.find_unused[0]}.'")
+
+    if len(unused_images) > 0:
+        print("Do you want to remove these images? (y/n) (DO NOT DO ON MAIN BRANCH!)")
+        if input().lower() == "y":
+            for img in unused_images:
+                os.remove(img)
+                print(f"Removed '{img}'")

config.toml

@@ -55,7 +55,7 @@ rdi_redis_gears_version = "1.2.6"
 rdi_debezium_server_version = "2.3.0.Final"
 rdi_db_types = "cassandra|mysql|oracle|postgresql|sqlserver"
 rdi_cli_latest = "latest"
-rdi_current_version = "v1.6.6"
+rdi_current_version = "v1.6.7"
 
 [params.clientsConfig]
 "Python"={quickstartSlug="redis-py"}

content/commands/client-list/index.md

@@ -117,6 +117,9 @@ Here is the meaning of the fields:
 * `rbp`: peak size of the client's read buffer since the client connected. Added in Redis 7.0
 * `rbs`: current size of the client's read buffer in bytes. Added in Redis 7.0
 * `io-thread`: id of I/O thread assigned to the client. Added in Redis 8.0
+* `tot-net-in`: total network input bytes read from this client.
+* `tot-net-out`: total network output bytes sent to this client.
+* `tot-cmds`: total count of commands this client executed.
 
 The client flags can be a combination of:
 

content/commands/json.debug-memory/index.md

@@ -35,6 +35,10 @@ title: JSON.DEBUG MEMORY
 ---
 Report a value's memory usage in bytes 
 
+{{< warning >}}
+The actual total memory consumption by a key could be much lower than the value reported by this command because of an internal JSON string reuse mechanism. For more information, see the [JSON memory usage page]({{< relref "/develop/data-types/json/ram#json-string-reuse-mechanism" >}}).
+{{< /warning >}}
+
 [Examples](#examples)
 
 ## Required arguments

content/commands/spublish/index.md

@@ -52,14 +52,14 @@ title: SPUBLISH
 Posts a message to the given shard channel.
 
 In Redis Cluster, shard channels are assigned to slots by the same algorithm used to assign keys to slots.
-A shard message must be sent to a node that own the slot the shard channel is hashed to. 
-The cluster makes sure that published shard messages are forwarded to all the node in the shard, so clients can subscribe to a shard channel by connecting to any one of the nodes in the shard.
+A shard message must be sent to a node that owns the slot the shard channel is hashed to. 
+The cluster makes sure that published shard messages are forwarded to all the nodes in the shard, so clients can subscribe to a shard channel by connecting to any one of the nodes in the shard.
 
 For more information about sharded pubsub, see [Sharded Pubsub]({{< relref "/develop/interact/pubsub#sharded-pubsub" >}}).
 
 ## Examples
 
-For example the following command publish to channel `orders` with a subscriber already waiting for message(s).
+For example the following command publishes to the `orders` channel with a subscriber already waiting for message(s).
 
 ```
 > spublish orders hello

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).