Merge branch 'main' into release-rs-aug

Author: rrelledge

.github/workflows/main-staging.yml

@@ -33,23 +33,92 @@ jobs:
             echo "ERROR: Invalid branch name ${{ github.ref_name }}!"
             exit 1
           fi
-    - name: Configure Hugo
+
+    - name: Install dependencies
+      run: make deps
+
+    - name: Build out all versions
       run: |
+        set -x
+
+        function setBaseUrl() {
           if [[ "${{ github.ref_name }}" == "main" ]]
           then
             hugo_root_path=docs/staging/dev
           elif [[ "${{ github.ref_name }}" == "latest" ]]
           then
-            hugo_root_path="docs/latest" 
+            hugo_root_path="docs/latest"
           elif [[ "${{ endsWith(github.ref_name, '-build') }}" == "true" ]]
           then
             hugo_root_path=`echo docs/version/${{ github.ref_name }} | sed 's/-build$//'`
           else
             hugo_root_path=docs/staging/${{ github.ref_name }}
           fi \
           && sed -i "s#baseURL = \"https://redis.io\"#baseURL = \"https://redis.io/$hugo_root_path\"#g" config.toml
-    - name: Install dependencies and run Hugo
-      run: make all
+        }
+
+        setBaseUrl
+        kubernetes_versions=($(find content/operate/kubernetes/ -maxdepth 1 -type d -regex ".*[0-9-]" | awk -F/ '{print $NF}'))
+        rs_versions=($(find content/operate/rs/ -maxdepth 1 -type d -regex ".*[0-9-]" | awk -F/ '{print $NF}'))
+
+        # build latest
+        for version in "${kubernetes_versions[@]}"; do
+          rm -r "content/operate/kubernetes/${version}"
+        done
+        for version in "${rs_versions[@]}"; do
+          rm -r "content/operate/rs/${version}"
+        done
+        make all
+
+        git checkout .
+
+        # build all versions
+        for version in "${kubernetes_versions[@]}"; do
+
+          setBaseUrl
+
+          # for each version, remove all other versions before building
+          versions_to_remove=($(echo "${kubernetes_versions[@]}" "${version}" | tr ' ' '\n' | sort | uniq -u))
+          for version_to_remove in "${versions_to_remove[@]}"; do
+            rm -r "content/operate/kubernetes/${version_to_remove}"
+          done
+
+          cp -r "content/operate/kubernetes/${version}"/* content/operate/kubernetes/
+          rm -r "content/operate/kubernetes/${version}"
+          sed -i 's/id="versionSelectorKubernetesValue" class="version-selector-control">latest/id="versionSelectorKubernetesValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html
+          sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis for Kubernetes/' content/operate/kubernetes/_index.md
+
+          # inject replace command in meta-links to make sure editURL and issuesURL point to right version
+          sed -i "11i \{\{ \$gh_file = replaceRE \`\^operate\/kubernetes\/\` \"operate\/kubernetes\/$version\/\" \$gh_file }}" layouts/partials/meta-links.html
+
+          hugo -d "kubernetes-${version}"
+
+          git checkout .
+        done
+
+        for version in "${rs_versions[@]}"; do
+
+          setBaseUrl
+
+          # for each version, remove all other versions before building
+          versions_to_remove=($(echo "${rs_versions[@]}" "${version}" | tr ' ' '\n' | sort | uniq -u))
+          for version_to_remove in "${versions_to_remove[@]}"; do
+            rm -r "content/operate/rs/${version_to_remove}"
+          done
+
+          cp -r "content/operate/rs/${version}"/* content/operate/rs/
+          rm -r "content/operate/rs/${version}"
+          sed -i 's/id="versionSelectorRsValue" class="version-selector-control">latest/id="versionSelectorRsValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html
+          sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis Software/' content/operate/rs/_index.md
+
+          # inject replace command in meta-links to make sure editURL and issuesURL point to right version
+          sed -i "11i \{\{ \$gh_file = replaceRE \`\^operate\/rs\/\` \"operate\/rs\/$version\/\" \$gh_file }}" layouts/partials/meta-links.html
+
+          hugo -d "rs-${version}"
+
+          git checkout .
+        done
+
     - name: List client examples
       run: ls "${{ github.workspace }}/examples"
     - name: List files to be published
@@ -80,5 +149,12 @@ jobs:
             bucket_path=staging/${{ github.ref_name }}
           fi \
           && ./google-cloud-sdk/bin/gsutil -m rsync -r -c -j html -d ${{ github.workspace }}/public gs://$BUCKET/$bucket_path
+
+          versioned_builds=($(find . -type d -regex ".*[0-9-]" -maxdepth 1 | sed -E 's/^.\///'))
+          for versioned_build in "${versioned_builds[@]}"; do
+            product=$(grep -Eo '[a-zA-Z]+' <<< $versioned_build)
+            gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/operate/${product}" "gs://${BUCKET}/${versioned_build}/operate/${product}"
+          done
+
     - name: End
       run: echo "This job's status is ${{ job.status }}."

content/commands/del/index.md

@@ -57,6 +57,17 @@ A key is ignored if it does not exist.
 
 ## Examples
 
+{{< clients-example cmds_generic del >}}
+> SET key1 "Hello"
+"OK"
+> SET key2 "World"
+"OK"
+> DEL key1 key2 key3
+(integer) 2
+{{< /clients-example >}}
+
+Give these commands a try in the interactive console:
+
 {{% redis-cli %}}
 SET key1 "Hello"
 SET key2 "World"

content/commands/expire/index.md

@@ -137,6 +137,29 @@ are now fixed.
 
 ## Examples
 
+{{< clients-example cmds_generic expire >}}
+> SET mykey "Hello"
+"OK"
+> EXPIRE mykey 10
+(integer) 1
+> TTL mykey
+(integer) 10
+> SET mykey "Hello World"
+"OK"
+> TTL mykey
+(integer) -1
+> EXPIRE mykey 10 XX
+(integer) 0
+> TTL mykey
+(integer) -1
+> EXPIRE mykey 10 NX
+(integer) 1
+> TTL mykey
+(integer) 10
+{{< /clients-example >}}
+
+Give these commands a try in the interactive console:
+
 {{% redis-cli %}}
 SET mykey "Hello"
 EXPIRE mykey 10

content/commands/ft.info/index.md

@@ -80,7 +80,7 @@ is the name of the given index. You must first create the index using [`FT.CREAT
 | `hash_indexing_failures` | The number of failures encountered during indexing. |
 | `total_indexing_time` | The total time taken for indexing in seconds. |
 | `indexing` | Indicates whether the index is currently being generated. |
-| `percent_indexed` | The percentage of the index that has been successfully generated. |
+| `percent_indexed` | The percentage of the index that has been successfully generated (1 means 100%). |
 | `number_of_uses` | The number of times the index has been used. |
 | `cleaning` | The index deletion flag. A value of `1` indicates index deletion is in progress. |
 

content/commands/ft.search/index.md

@@ -478,6 +478,8 @@ orders the results by the value of this attribute. This applies to both text and
 <summary><code>LIMIT first num</code></summary>
 
 limits the results to the offset and number of results given. Note that the offset is zero-indexed. The default is 0 10, which returns 10 items starting from the first result. You can use `LIMIT 0 0` to count the number of documents in the result set without actually returning them.
+
+**`LIMIT` behavior**:  If you use the `LIMIT` option without sorting, the results returned are non-deterministic, which means that subsequent queries may return duplicated or missing values. Add `SORTBY` with a unique field, or use `FT.AGGREGATE` with the `WITHCURSOR` option to ensure deterministic result set paging.
 </details>
 
 <details open>

content/commands/hget/index.md

@@ -53,9 +53,19 @@ Returns the value associated with `field` in the hash stored at `key`.
 
 ## Examples
 
+{{< clients-example cmds_hash hget >}}
+> HSET myhash field1 "foo"
+(integer) 1
+> HGET myhash field1
+"foo"
+> HGET myhash field2
+(nil)
+{{< /clients-example >}}
+
+Give these commands a try in the interactive console:
+
 {{% redis-cli %}}
 HSET myhash field1 "foo"
 HGET myhash field1
 HGET myhash field2
 {{% /redis-cli %}}
-

content/commands/hset/index.md

@@ -68,12 +68,33 @@ If `key` doesn't exist, a new key holding a hash is created.
 
 ## Examples
 
+{{< clients-example cmds_hash hset >}}
+> HSET myhash field1 "Hello"
+(integer) 1
+> HGET myhash field1
+"Hello"
+> HSET myhash field2 "Hi" field3 "World"
+(integer) 2
+> HGET myhash field2
+"Hi"
+> HGET myhash field3
+"World"
+> HGETALL myhash
+1) "field1"
+2) "Hello"
+3) "field2"
+4) "Hi"
+5) "field3"
+6) "World"
+{{< /clients-example >}}
+
+Give these commands a try in the interactive console:
+
 {{% redis-cli %}}
 HSET myhash field1 "Hello"
 HGET myhash field1
 HSET myhash field2 "Hi" field3 "World"
 HGET myhash field2
 HGET myhash field3
 HGETALL myhash
-{{% /redis-cli %}}
-
+{{% /redis-cli %}}

content/commands/incr/index.md

@@ -67,13 +67,23 @@ representation of the integer.
 
 ## Examples
 
+{{< clients-example cmds_string incr >}}
+> SET mykey "10"
+"OK"
+> INCR mykey
+(integer) 11
+> GET mykey
+"11"
+{{< /clients-example >}}
+
+Give this command a try in the interactive console:
+
 {{% redis-cli %}}
 SET mykey "10"
 INCR mykey
 GET mykey
 {{% /redis-cli %}}
 
-
 ## Pattern: Counter
 
 The counter pattern is the most obvious thing you can do with Redis atomic

content/commands/json.mget/index.md

@@ -33,7 +33,7 @@ title: JSON.MGET
 Return the values at `path` from multiple `key` arguments
 
 {{% warning %}}
-All specified keys must reside on the same [hash slot](https://redis.io/docs/latest/operate/oss_and_stack/reference/cluster-spec/#key-distribution-model).
+When cluster mode is enabled, all specified keys must reside on the same [hash slot](https://redis.io/docs/latest/operate/oss_and_stack/reference/cluster-spec/#key-distribution-model).
 {{% /warning %}}
 
 [Examples](#examples)

content/commands/json.mset/index.md

@@ -44,7 +44,7 @@ Set or update one or more JSON values according to the specified `key`-`path`-`v
 A JSON value is a hierarchical structure. If you change a value in a specific path - nested values are affected.
 
 {{% warning %}}
-All specified keys must reside on the same [hash slot](https://redis.io/docs/latest/operate/oss_and_stack/reference/cluster-spec/#key-distribution-model).
+When cluster mode is enabled, all specified keys must reside on the same [hash slot](https://redis.io/docs/latest/operate/oss_and_stack/reference/cluster-spec/#key-distribution-model).
 {{% /warning %}}
 
 [Examples](#examples)