Merge branch 'main' into DOC-4805

Author: dwdougherty

.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

assets/css/index.css

@@ -1073,4 +1073,25 @@ a[href*="#no-click"], img[src*="#no-click"] {
 
 .dd-item .highlight:hover {
   color: #5961ff;
+}
+
+.copy-button {
+  background-color: #eee;
+  border: none;
+  padding: 4px;
+  cursor: pointer;
+  border-radius: 4px;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}
+
+.copy-button svg {
+  width: 16px;
+  height: 16px;
+  fill: #333;
+}
+
+.copy-button:hover {
+  background-color: #ddd;
 }

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 = "1.8.0"
 
 [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/_index.md

@@ -2,4 +2,43 @@
 title: Develop with Redis
 description: Learn how to develop with Redis
 linkTitle: Develop
+hideListLinks: true
 ---
+
+Get a Redis server running in minutes with a free trial of
+[Redis Cloud]({{< relref "/operate/rc" >}}), or install
+[Redis Open Source]({{< relref "/operate/oss_and_stack" >}}) locally
+on your machine. Then, explore Redis with your favorite
+[programming language]({{< relref "/develop/clients" >}})
+or analyze and manage your database with our
+[UI tools]({{< relref "/develop/tools" >}}):
+
+| | Get started | Document search | Vector search |
+|:----- | :-----: | :-----: | :-----:|
+| [Python]({{< relref "/develop/clients/redis-py" >}}) | [See Python examples]({{< relref "/develop/clients/redis-py/connect" >}}) | [See Python examples]({{< relref "/develop/clients/redis-py/queryjson" >}}) | [See Python examples]({{< relref "/develop/clients/redis-py/vecsearch" >}}) |
+| [C#/.NET]({{< relref "/develop/clients/dotnet" >}}) | [See C# examples]({{< relref "/develop/clients/dotnet/connect" >}}) | [See C# examples]({{< relref "/develop/clients/dotnet/queryjson" >}}) | [See C# examples]({{< relref "/develop/clients/dotnet/vecsearch" >}}) |
+| [Node.js]({{< relref "/develop/clients/nodejs" >}}) | [See JS examples]({{< relref "/develop/clients/nodejs/connect" >}}) | [See JS examples]({{< relref "/develop/clients/nodejs/queryjson" >}}) | [See JS examples]({{< relref "/develop/clients/nodejs/vecsearch" >}}) |
+| [Java]({{< relref "/develop/clients/jedis" >}}) | [See Java examples]({{< relref "/develop/clients/jedis/connect" >}}) | [See Java examples]({{< relref "/develop/clients/jedis/queryjson" >}}) | [See Java examples]({{< relref "/develop/clients/jedis/vecsearch" >}}) |
+| [Go]({{< relref "/develop/clients/go" >}}) | [See Go examples]({{< relref "/develop/clients/go/connect" >}}) | [See Go examples]({{< relref "/develop/clients/go/queryjson" >}}) | [See Go examples]({{< relref "/develop/clients/go/vecsearch" >}}) |
+| [PHP]({{< relref "/develop/clients/php" >}}) | [See PHP examples]({{< relref "/develop/clients/php/connect" >}}) | [See PHP examples]({{< relref "/develop/clients/php/queryjson" >}}) | [See PHP examples]({{< relref "/develop/clients/php/vecsearch" >}}) |
+
+<div class="flex flex-col gap-5">
+  <div class="flex items-start">
+    {{< image filename="develop/tools/insight/images/Browser.png" class="w-[300px] mr-4" >}}
+    <div>
+      <h3><a href='{{< relref "/develop/tools/insight">}}'>Redis Insight</a></h3>
+      <p>Visual client tool for creating, managing, and analyzing Redis databases.</p>
+    </div>
+  </div>
+  <div class="flex items-start">
+    {{< image filename="images/dev/connect/vscode/vscode-cli.png" class="w-[300px] mr-4" >}}
+    <div>
+      <h3><a href='{{< relref "/develop/tools/redis-for-vscode" >}}'>Redis for VS Code</a></h3>
+      <p>Visual client tool for creating, managing, and analyzing Redis databases.</p>
+    </div>
+  </div>
+</div>
+
+| {{< image filename="images/icon_logo/icon-developers-32-midnight.png" >}} </br>[**Quick start**]({{< relref "/develop/get-started" >}}) | {{< image filename="images/icon_logo/icon-data-structures-32-midnight.png" >}} </br>[**Data types**]({{< relref "/develop/data-types" >}}) | {{< image filename="images/icon_logo/icon-text-search-32-midnight.png" >}} </br>[**Query engine**]({{< relref "/develop/interact/search-and-query" >}}) |
+|---|---|---|
+| [Vector database]({{< relref "/develop/get-started/vector-database" >}})</br>[Document store]({{< relref "/develop/get-started/document-database" >}})</br>[Data structure store]({{< relref "/develop/get-started/data-store" >}})</br>[RAG with Redis]({{< relref "/develop/get-started/rag" >}})</br>[GenAI]({{< relref "/develop/get-started/redis-in-ai" >}}) | [String]({{< relref "/develop/data-types/strings" >}})</br>[JSON]({{< relref "/develop/data-types/json" >}})</br>[Hash]({{< relref "/develop/data-types/hashes" >}})</br>[Vector set]({{< relref "/develop/data-types/vector-sets" >}})</br>[Probabilistic types]({{< relref "/develop/data-types/probabilistic" >}}) | [Get started]({{< relref "/develop/interact/search-and-query" >}})</br>[Schema field types]({{< relref "/develop/interact/search-and-query/basic-constructs/field-and-type-options" >}})</br>[Indexing]({{< relref "/develop/interact/search-and-query/indexing" >}})</br>[Querying]({{< relref "/develop/interact/search-and-query/query" >}})</br>[Use cases]({{< relref "/develop/interact/search-and-query/query-use-cases" >}})