K8s: Add YAML examples

.github/workflows/main.yml

@@ -202,13 +202,14 @@ jobs:
           then
             versioned_builds=($(find . -type d -regex ".*[0-9-]" -maxdepth 1 | sed -E 's/^.\///'))
             for versioned_build in "${versioned_builds[@]}"; do
-              product=$(awk 'BEGIN{FS=OFS="-"}{NF--; print}' <<< $versioned_build)
+              read product version <<< "$(awk -F- '{print $1 " " $2}' <<<"$versioned_build")"
+
               if [[ "${product}" == "redis-data-integration" ]]; then
                 gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/integrate/${product}" "gs://${BUCKET}/${versioned_build}/integrate/${product}"
-                gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/integrate/${product}" "gs://${BUCKET}/docs/${versioned_build}/integrate/${product}"
+                gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/integrate/${product}/${version}" "gs://${BUCKET}/docs/$bucket_path/integrate/${product}/${version}"
               else
                 gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/operate/${product}" "gs://${BUCKET}/${versioned_build}/operate/${product}"
-                gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/operate/${product}" "gs://${BUCKET}/docs/${versioned_build}/operate/${product}"
+                gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/operate/${product}/${version}" "gs://${BUCKET}/docs/$bucket_path/operate/${product}/${version}"
               fi
             done
           fi

.gitignore

@@ -8,7 +8,7 @@
 /data/versions.json
 /data/components_local/
 /examples
-build/components/__pycache__/
+**/__pycache__/
 venv/**
 node_modules/
 package-lock.json 

assets/css/index.css

@@ -521,6 +521,41 @@ select {
   @apply w-10 h-10;
 }
 
+/* YAML embed download button styles */
+.download-yaml-btn {
+  @apply transition-colors;
+}
+
+.download-yaml-btn:disabled {
+  @apply opacity-75 cursor-not-allowed;
+}
+
+.download-yaml-btn svg {
+  @apply w-4 h-4;
+}
+
+/* Make long code blocks scrollable */
+.yaml-embed-container .highlight {
+  max-height: 800px;
+  overflow-y: auto;
+}
+
+.yaml-embed-container .highlight::-webkit-scrollbar {
+  width: 8px;
+}
+
+.yaml-embed-container .highlight::-webkit-scrollbar-track {
+  @apply bg-slate-700 rounded;
+}
+
+.yaml-embed-container .highlight::-webkit-scrollbar-thumb {
+  @apply bg-slate-500 rounded;
+}
+
+.yaml-embed-container .highlight::-webkit-scrollbar-thumb:hover {
+  @apply bg-slate-400;
+}
+
 #download-redis > h3,
 #download-redis-stack > h3 {
   @apply mt-2;

build/local_examples.py

@@ -0,0 +1,158 @@
+#!/usr/bin/env python3
+"""
+Local Examples Processor
+
+This script processes local examples from the local_examples/ directory
+and integrates them into the existing examples system.
+
+Works like remote examples - each file contains an EXAMPLE: header
+and can be any supported language.
+"""
+
+import os
+import glob
+import shutil
+import logging
+from typing import Dict, Any
+
+from components.example import Example
+from components.util import mkdir_p
+from components.structured_data import load_dict, dump_dict
+
+
+# File extension to language mapping
+EXTENSION_TO_LANGUAGE = {
+    '.py': 'python',
+    '.js': 'node.js',
+    '.go': 'go',
+    '.cs': 'c#',
+    '.java': 'java',
+    '.php': 'php'
+}
+
+# Language to client name mapping (from config.toml clientsExamples)
+LANGUAGE_TO_CLIENT = {
+    'python': 'Python',
+    'node.js': 'Node.js',
+    'go': 'Go',
+    'c#': 'C#',
+    'java': 'Java-Sync',  # Default to sync, could be overridden
+    'php': 'PHP',
+    'redisvl': 'RedisVL'
+}
+
+
+def get_language_from_extension(filename: str) -> str:
+    """Get language from file extension."""
+    _, ext = os.path.splitext(filename)
+    return EXTENSION_TO_LANGUAGE.get(ext.lower())
+
+
+def get_client_name_from_language(language: str) -> str:
+    """Get client name from language."""
+    return LANGUAGE_TO_CLIENT.get(language, language.title())
+
+
+def get_example_id_from_file(path: str) -> str:
+    """Extract example ID from the first line of a file."""
+    try:
+        with open(path, 'r') as f:
+            first_line = f.readline().strip()
+            if 'EXAMPLE:' in first_line:
+                return first_line.split(':')[1].strip()
+    except Exception as e:
+        logging.error(f"Error reading example ID from {path}: {e}")
+    return None
+
+
+def process_local_examples(local_examples_dir: str = 'local_examples',
+                          examples_dir: str = 'examples',
+                          examples_json: str = 'data/examples.json') -> None:
+    """
+    Process local examples and integrate them into the examples system.
+
+    Works like remote examples - each file contains an EXAMPLE: header
+    and can be any supported language.
+
+    Args:
+        local_examples_dir: Directory containing local example source files
+        examples_dir: Target directory for processed examples
+        examples_json: Path to examples.json file
+    """
+
+    if not os.path.exists(local_examples_dir):
+        logging.info(f"Local examples directory {local_examples_dir} not found, skipping")
+        return
+
+    # Load existing examples data
+    examples_data = {}
+    if os.path.exists(examples_json):
+        examples_data = load_dict(examples_json)
+
+    # Process each file in local_examples directory
+    for filename in os.listdir(local_examples_dir):
+        source_file = os.path.join(local_examples_dir, filename)
+
+        if not os.path.isfile(source_file):
+            continue
+
+        # Get language from file extension
+        language = get_language_from_extension(filename)
+        if not language:
+            logging.warning(f"Unknown file extension for: {filename}")
+            continue
+
+        # Get example ID from file content
+        example_id = get_example_id_from_file(source_file)
+        if not example_id:
+            logging.warning(f"No EXAMPLE: header found in {filename}")
+            continue
+
+        logging.info(f"Processing local example: {example_id} ({language})")
+
+        # Create target directory
+        target_dir = os.path.join(examples_dir, example_id)
+        mkdir_p(target_dir)
+
+        # Initialize example data
+        if example_id not in examples_data:
+            examples_data[example_id] = {}
+
+        # Copy file to target directory with local_ prefix
+        base_name = os.path.splitext(filename)[0]
+        ext = os.path.splitext(filename)[1]
+        target_filename = f"local_{base_name}{ext}"
+        target_file = os.path.join(target_dir, target_filename)
+        shutil.copy2(source_file, target_file)
+
+        # Process with Example class
+        example = Example(language, target_file)
+
+        # Get client name
+        client_name = get_client_name_from_language(language)
+
+        # Create metadata
+        example_metadata = {
+            'source': source_file,
+            'language': language,
+            'target': target_file,
+            'highlight': example.highlight,
+            'hidden': example.hidden,
+            'named_steps': example.named_steps,
+            'sourceUrl': None  # Local examples don't have source URLs
+        }
+
+        examples_data[example_id][client_name] = example_metadata
+        logging.info(f"Processed {client_name} example for {example_id}")
+
+    # Save updated examples data
+    dump_dict(examples_json, examples_data)
+    logging.info(f"Updated examples data saved to {examples_json}")
+
+
+if __name__ == '__main__':
+    logging.basicConfig(level=logging.INFO, 
+                       format='%(levelname)s: %(message)s')
+
+    process_local_examples()
+    print("Local examples processing complete")

build/make.py

@@ -1,10 +1,12 @@
 import argparse
 from datetime import datetime
 import logging
+import sys
 import tempfile
 
 from components.component import All
 from components.util import mkdir_p
+from local_examples import process_local_examples
 
 
 def parse_args() -> argparse.Namespace:
@@ -30,20 +32,19 @@ def parse_args() -> argparse.Namespace:
     ARGS = parse_args()
     mkdir_p(ARGS.tempdir)
 
-    # Configure logging BEFORE creating objects
-    log_level = getattr(logging, ARGS.loglevel.upper())
-    logging.basicConfig(
-        level=log_level,
-        format='%(message)s %(filename)s:%(lineno)d - %(funcName)s',
-        force=True  # Force reconfiguration in case logging was already configured
-    )
-
     # Load settings
     ALL = All(ARGS.stack, None, ARGS.__dict__)
 
     # Make the stack
+    logging.basicConfig(
+        level=ARGS.loglevel, format=f'{sys.argv[0]}: %(levelname)s %(asctime)s %(message)s')
     print(f'Applying all configured components"{ALL._name}"')
     start = datetime.now()
     ALL.apply()
+
+    # Process local examples
+    print('Processing local examples')
+    process_local_examples()
+
     total = datetime.now() - start
     print(f'+OK ({total.microseconds / 1000} ms)')

content/apis/_index.md

@@ -60,5 +60,5 @@ If you have installed Redis Enterprise Software, you can automate operations wit
 
 If you need to install Redis Enterprise on Kubernetes, then you can use the [Redis Enterprise for Kubernetes Operators]({{< relref "/operate/Kubernetes/" >}}). You can find the resource definitions here:
 
-- [Redis Enterprise Cluster API]({{<relref "/operate/kubernetes/reference/redis_enterprise_cluster_api">}})
-- [Redis Enterprise Database API]({{<relref "/operate/kubernetes/reference/redis_enterprise_database_api">}})
+- [Redis Enterprise Cluster API]({{<relref "/operate/kubernetes/reference/api/redis_enterprise_cluster_api">}})
+- [Redis Enterprise Database API]({{<relref "/operate/kubernetes/reference/api/redis_enterprise_database_api">}})

content/commands/cf.exists.md

@@ -59,6 +59,8 @@ redis> CF.EXISTS cf item2
 (integer) 0
 {{< / highlight >}}
 
+## Return information
+
 {{< multitabs id="cf-exists-return-info" 
     tab1="RESP2" 
     tab2="RESP3" >}}

content/commands/cms.info.md

@@ -47,6 +47,8 @@ redis> CMS.INFO test
  6) (integer) 0
 ```
 
+## Return information
+
 {{< multitabs id=“cms-info-return-info" 
     tab1="RESP2" 
     tab2="RESP3" >}}

content/commands/cms.query.md

@@ -46,6 +46,8 @@ redis> CMS.QUERY test foo bar
 2) (integer) 42
 ```
 
+## Return information
+
 {{< multitabs id=“cms-merge-return-info" 
     tab1="RESP2" 
     tab2="RESP3" >}}

content/commands/ft._list.md

@@ -38,15 +38,25 @@ In the future, a [`SCAN`]({{< relref "/commands/scan" >}}) type of command will
 contains a large number of indices.
 {{% /alert %}}
 
-## Return
-
-[Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) with index names.
-
 ## Examples
 
 ```sql
 FT._LIST
 1) "idx"
 2) "movies"
 3) "imdb"
-```
+```
+
+## Return information
+
+{{< multitabs id="ft-_list-return-info" 
+    tab1="RESP2" 
+    tab2="RESP3" >}}
+
+[Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of index names as [simple strings]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}).
+
+-tab-sep-
+
+[Set]({{< relref "/develop/reference/protocol-spec#sets" >}}) of index names as [simple strings]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}).
+
+{{< /multitabs >}}

content/commands/ft.aggregate.md

@@ -354,12 +354,7 @@ You can use `@__score` in a pipeline as shown in the following example:
 selects the dialect version under which to execute the query. If not specified, the query will execute under the default dialect version set during module initial loading or via [`FT.CONFIG SET`]({{< relref "commands/ft.config-set/" >}}) command.
 </details>
 
-## Return
-
-FT.AGGREGATE returns an array reply where each row is an array reply and represents a single aggregate result.
-The [integer reply]({{< relref "develop/reference/protocol-spec#resp-integers" >}}) at position `1` does not represent a valid value.
-
-### Return multiple values
+## Return multiple values
 
 See [Return multiple values]({{< relref "commands/ft.search#return-multiple-values/" >}}) in [`FT.SEARCH`]({{< relref "commands/ft.search/" >}})
 The `DIALECT` can be specified as a parameter in the FT.AGGREGATE command. If it is not specified, the `DEFAULT_DIALECT` is used, which can be set using [`FT.CONFIG SET`]({{< relref "commands/ft.config-set/" >}}) or by passing it as an argument to the `redisearch` module when it is loaded.
@@ -489,13 +484,35 @@ Next, count GitHub events by user (actor), to produce the most active users.
 
 </details>
 
+## Return information
+
+{{< multitabs id="ft-aggregate-return-info" 
+    tab1="RESP2" 
+    tab2="RESP3" >}}
+
+One of the following:
+* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) with the first element being the total number of results, followed by result rows as [arrays]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of field-value pairs.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: incorrect number of arguments, non-existent index, invalid query syntax.
+
+-tab-sep-
+
+One of the following:
+* [Map]({{< relref "/develop/reference/protocol-spec#maps" >}}) with the following fields:
+    - `attributes`: [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of attribute names.
+    - `format`: [Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - result format.
+    - `results`: [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [maps]({{< relref "/develop/reference/protocol-spec#maps" >}}) containing aggregated data.
+    - `total_results`: [Integer]({{< relref "/develop/reference/protocol-spec#integers" >}}) - total number of results.
+    - `warning`: [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of warning messages.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: incorrect number of arguments, non-existent index, invalid query syntax.
+
+{{< /multitabs >}}
+
 ## See also
 
-[`FT.CONFIG SET`]({{< relref "commands/ft.config-set/" >}}) | [`FT.SEARCH`]({{< relref "commands/ft.search/" >}}) 
+[`FT.CONFIG SET`]({{< relref "commands/ft.config-set/" >}}) | [`FT.SEARCH`]({{< relref "commands/ft.search/" >}})
 
 ## Related topics
 
 - [Aggregations]({{< relref "/develop/ai/search-and-query/advanced-concepts/aggregations" >}})
 - [Key and field expiration behavior]({{< relref "/develop/ai/search-and-query/advanced-concepts/expiration" >}})
 - [RediSearch]({{< relref "/develop/ai/search-and-query" >}})
-