Merge branch 'main' into DOC-5527

Author: rrelledge

.github/workflows/autocomment_jira_link.yaml

@@ -0,0 +1,50 @@
+name: autocomment_jira_link
+
+on:
+  pull_request:
+    types:
+      - opened
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  auto-comment:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout'
+        uses: 'actions/checkout@v3'
+
+      - name: Create Comment
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+          REPO: ${{ github.repository }}
+          BRANCH_NAME: ${{ github.event.pull_request.head.ref }}
+        run: |
+          CREATE_COMMENT_URL="https://api.github.com/repos/${REPO}/issues/${PR_NUMBER}/comments"
+          
+          JIRA_TICKET=$(grep -Eo '^DOC-[0-9]+' <<< "$BRANCH_NAME")
+          JIRA_LINK="https://redislabs.atlassian.net/browse/${JIRA_TICKET}"
+          COMMENT="[${JIRA_TICKET}](${JIRA_LINK})"
+          
+          generate_post_data()
+          {
+            cat <<EOF
+          {
+            "body": "$COMMENT"
+          EOF
+          }
+
+          if [[ "$BRANCH_NAME" == DOC-* ]]; then
+            # Write comment on pull request
+            curl -Ls \
+              -X POST \
+              -H "Accept: application/vnd.github+json" \
+              -H "X-GitHub-Api-Version: 2022-11-28" \
+              -H "Authorization: token ${GITHUB_TOKEN}" \
+              $CREATE_COMMENT_URL \
+              --data "$(generate_post_data)" 1>/dev/null
+
+            printf '%s\n' 'Comment written!'
+          fi

.github/workflows/autocomment.yaml renamed to .github/workflows/autocomment_staging_links.yaml

@@ -1,4 +1,4 @@
-name: Auto Comment on PR
+name: autocomment_staging_links
 
 on:
   pull_request:
@@ -38,7 +38,7 @@ jobs:
                               -H "X-GitHub-Api-Version: 2022-11-28" \
                               -H "Authorization: Bearer ${GITHUB_TOKEN}" \
                               $CREATE_COMMENT_URL \
-                              | jq -r '.[] | select(.user.login == "github-actions[bot]")'
+                              | jq -r '.[] | select(.user.login == "github-actions[bot]" and ((.body // "") | contains("Staging links:")))'
                             )
           EXISTING_COMMENT_ID=$(jq -r '.id' <<<"$EXISTING_COMMENT_JSON")
           EXISTING_COMMENT=$(jq -r '.body' <<<"$EXISTING_COMMENT_JSON")
@@ -50,7 +50,7 @@ jobs:
             -H "Authorization: Bearer ${GITHUB_TOKEN}" \
             $FILES_URL \
               | jq -r --arg prefix $BRANCH_NAME/ '.[] | select(((.filename | test("content/(?!.*embed).*\\.md")) and .status != "removed")) | ($prefix + .filename)' \
-              | sed -E -e 's|(^[^/]+/)([^/]+/)|\1|' -e 's|^|https://redis.io/docs/staging/|' -e 's|(_?index)?\.md||' \
+              | sed -E -e 's|(^[^/]+/)([^/]+/)|\1|' -e 's|^|https://redis.io/docs/staging/|' -e 's|(\/_?index)?\.md|\/|' \
               | sort \
               | uniq)
 

.github/workflows/k8s_apis_sync.yaml

@@ -50,7 +50,7 @@ jobs:
         run: |-
           mkdir artifacts
           mkdir templates
-          cp content/operate/kubernetes/reference/kubernetes-api-reference-template.tmpl templates/template.tmpl
+          cp content/operate/kubernetes/reference/api/kubernetes-api-reference-template.tmpl templates/template.tmpl
 
           crdoc --resources crds/reaadb_crd.yaml --output artifacts/redis_enterprise_active_active_database_api.md --template templates/template.tmpl
           sed -E -i 's/^### RedisEnterpriseActiveActiveDatabase\./### /g' artifacts/redis_enterprise_active_active_database_api.md
@@ -80,6 +80,80 @@ jobs:
           sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_remote_cluster_api.md
           awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_remote_cluster_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_remote_cluster_api.md
 
+      - name: 'Remove fields without description'
+        run: |-
+          file="artifacts/redis_enterprise_cluster_api.md"
+          empty_fields_file="content/operate/kubernetes/reference/api/redis_enterprise_cluster_empty_fields"
+
+          # Read empty fields and process them
+          while IFS= read -r field; do
+              # Skip empty lines and comments
+              [[ -z "$field" || "$field" =~ ^# ]] && continue
+
+              # Convert field path to section header pattern
+              section_pattern="${field}"
+
+              # Remove subsections that go deeper than [index] level
+              # Keep: spec.extraEnvVars
+              # Keep: spec.extraEnvVars[index]
+              # Remove: spec.extraEnvVars[index].valueFrom
+              # Remove: spec.extraEnvVars[index].valueFrom.fieldRef
+              awk -v base_pattern="${section_pattern}" '
+              BEGIN { skip = 0 }
+              /^### / {
+                  # Check if this line matches a pattern we want to remove
+                  section = $0
+                  gsub(/^### /, "", section)
+
+                  # If it starts with our base pattern
+                  if (index(section, base_pattern) == 1) {
+                      remainder = substr(section, length(base_pattern) + 1)
+
+                      # If remainder is empty, keep it (main section)
+                      if (remainder == "") {
+                          skip = 0
+                      }
+                      # If remainder is just [index], keep it
+                      else if (remainder == "[index]") {
+                          skip = 0
+                      }
+                      # If remainder starts with [index]. (has more after [index]), remove it
+                      else if (index(remainder, "[index].") == 1) {
+                          skip = 1
+                          next
+                      }
+                      # If remainder starts with . (direct subsection), remove it
+                      else if (index(remainder, ".") == 1) {
+                          skip = 1
+                          next
+                      }
+                      # If remainder starts with []. (direct subsection), remove it
+                      else if (index(remainder, "[].") == 1) {
+                          skip = 1
+                          next
+                      }
+                      # Otherwise keep it
+                      else {
+                          skip = 0
+                      }
+                  } else {
+                      # Different section, stop skipping
+                      skip = 0
+                  }
+              }
+
+              skip == 0 { print }
+              ' "$file" > "${file}.tmp" && mv "${file}.tmp" "$file"
+
+          done < "$empty_fields_file"
+
+      - name: 'Fix link titles'
+        run: |-
+          sed -E -i 's/linkTitle: RedisEnterpriseActiveActiveDatabase API Reference/linkTitle: REAADB API/g' artifacts/redis_enterprise_active_active_database_api.md
+          sed -E -i 's/linkTitle: RedisEnterpriseCluster API Reference/linkTitle: REC API/g' artifacts/redis_enterprise_cluster_api.md
+          sed -E -i 's/linkTitle: RedisEnterpriseDatabase API Reference/linkTitle: REDB API/g' artifacts/redis_enterprise_database_api.md
+          sed -E -i 's/linkTitle: RedisEnterpriseRemoteCluster API Reference/linkTitle: RERC API/g' artifacts/redis_enterprise_remote_cluster_api.md
+
       - name: 'Generate YAML snippets'
         run: |-
           function formatYamlSnippet() {
@@ -128,14 +202,12 @@ jobs:
 
           git checkout -b "${BRANCH}"
 
-          cp artifacts/redis_enterprise_active_active_database_api.md content/operate/kubernetes/reference/
-          cp artifacts/redis_enterprise_cluster_api.md content/operate/kubernetes/reference/
-          cp artifacts/redis_enterprise_database_api.md content/operate/kubernetes/reference/
-          cp artifacts/redis_enterprise_remote_cluster_api.md content/operate/kubernetes/reference/
-
-          git apply content/operate/kubernetes/reference/kubernetes-api-reference-frontmatter.patch
+          cp artifacts/redis_enterprise_active_active_database_api.md content/operate/kubernetes/reference/api/
+          cp artifacts/redis_enterprise_cluster_api.md content/operate/kubernetes/reference/api/
+          cp artifacts/redis_enterprise_database_api.md content/operate/kubernetes/reference/api/
+          cp artifacts/redis_enterprise_remote_cluster_api.md content/operate/kubernetes/reference/api/
 
-          git add content/operate/kubernetes/reference/
+          git add content/operate/kubernetes/reference/api/
           git add content/embeds/k8s/
 
           git commit -m "k8s api docs ${RELEASE}"

config.toml

@@ -45,7 +45,7 @@ tagManagerId = "GTM-TKZ6J9R"
 gitHubRepo = "https://github.com/redis/docs"
 
 # Display and sort order for client examples
-clientsExamples = ["Python", "Node.js", "Java-Sync", "Java-Async", "Java-Reactive", "Go", "C#", "RedisVL"]
+clientsExamples = ["Python", "Node.js", "Java-Sync", "Java-Async", "Java-Reactive", "Go", "C#", "RedisVL", "PHP"]
 searchService = "/convai/api/search-service"
 ratingsService = "/docusight/api/rate"
 
@@ -66,6 +66,7 @@ rdi_current_version = "1.12.3"
 "Go"={quickstartSlug="go"}
 "C#"={quickstartSlug="dotnet"}
 "RedisVL"={quickstartSlug="redis-vl"}
+"PHP"={quickstartSlug="php"}
 
 # Markup
 [markup]

content/commands/bitop.md

@@ -21,6 +21,22 @@ arguments:
     name: not
     token: NOT
     type: pure-token
+  - display_text: diff
+    name: diff
+    token: DIFF
+    type: pure-token
+  - display_text: diff1
+    name: diff1
+    token: DIFF1
+    type: pure-token
+  - display_text: andor
+    name: andor
+    token: ANDOR
+    type: pure-token
+  - display_text: one
+    name: one
+    token: ONE
+    type: pure-token
   name: operation
   type: oneof
 - display_text: destkey
@@ -78,26 +94,45 @@ key_specs:
 linkTitle: BITOP
 since: 2.6.0
 summary: Performs bitwise operations on multiple strings, and stores the result.
-syntax_fmt: BITOP <AND | OR | XOR | NOT> destkey key [key ...]
+syntax_fmt: "BITOP <AND | OR | XOR | NOT | DIFF | DIFF1 | ANDOR | ONE> destkey key [key ...]"
 syntax_str: destkey key [key ...]
 title: BITOP
 ---
 Perform a bitwise operation between multiple keys (containing string values) and
 store the result in the destination key.
 
-The `BITOP` command supports four bitwise operations: **AND**, **OR**, **XOR**
-and **NOT**, thus the valid forms to call the command are:
+The `BITOP` command supports eight bitwise operations: `AND`, `OR`, `XOR`,
+`NOT`, `DIFF`, `DIFF1`, `ANDOR`, and `ONE`. The valid forms to call the command are:
 
 
 * `BITOP AND destkey srckey1 srckey2 srckey3 ... srckeyN`
+
+    A bit in `destkey` is set only if it is set in all source bitmaps.
 * `BITOP OR  destkey srckey1 srckey2 srckey3 ... srckeyN`
+
+    A bit in `destkey` is set only if it is set in at least one source bitmap.
 * `BITOP XOR destkey srckey1 srckey2 srckey3 ... srckeyN`
+
+    Mostly used with two source bitmaps, a bit in `destkey` is set only if its value differs between the two source bitmaps.
 * `BITOP NOT destkey srckey`
 
-As you can see **NOT** is special as it only takes an input key, because it
-performs inversion of bits so it only makes sense as a unary operator.
+    `NOT` is a unary operator and only supports a single source bitmap; set the bit to the inverse of its value in the source bitmap.
+* `BITOP DIFF destkey X [Y1 Y2 ...]` <sup>[1](#list-note-1)</sup>
+
+    A bit in `destkey` is set if it is set in `X`, but not in any of `Y1, Y2, ...` .
+* `BITOP DIFF1 destkey X [Y1 Y2 ...]` <sup>[1](#list-note-1)</sup>
 
-The result of the operation is always stored at `destkey`.
+    A bit in `destkey` is set if it is set in one or more of `Y1, Y2, ...`, but not in `X`.
+* `BITOP ANDOR destkey X [Y1 Y2 ...]` <sup>[1](#list-note-1)</sup>
+
+    A bit in `destkey` is set if it is set in `X` and also in one or more of `Y1, Y2, ...`.
+* `BITOP ONE destkey X1 [X2 X3 ...]` <sup>[1](#list-note-1)</sup>
+
+    A bit in `destkey` is set if it is set in exactly one of `X1, X2, ...`.
+
+The result of each operation is always stored at `destkey`.
+
+1. <a name="list-note-1"></a> Added in Redis 8.2.
 
 ## Handling of strings with different lengths
 
@@ -110,13 +145,27 @@ zero bytes up to the length of the longest string.
 
 ## Examples
 
+1. Basic usage example using the `AND` operator:
+
 {{% redis-cli %}}
-SET key1 "foobar"
-SET key2 "abcdef"
+BITFIELD key1 SET i8 #0 255
+BITFIELD key2 SET i8 #0 85
 BITOP AND dest key1 key2
-GET dest
+BITFIELD dest GET i8 #0
 {{% /redis-cli %}}
 
+2. Suppose you want to expose people to a book-related ad. The target audience is people who love to read books and are interested in fantasy, adventure, or science fiction. Assume you have the following bitmaps:
+
+* `LRB` - people who love to read books.
+* `B:F` - people interested in fantasy.
+* `B:A` - people interested in adventure.
+* `B:SF` - people interested in science fiction.
+
+To create a bitmap representing the target audience, use the following command:
+
+```
+BITOP ANDOR TA LRB B:F B:A B:SF
+```
 
 ## Pattern: real time metrics using bitmaps
 

content/commands/client-no-evict.md

@@ -50,3 +50,23 @@ When turned on and client eviction is configured, the current connection will be
 When turned off, the current client will be re-included in the pool of potential clients to be evicted (and evicted if needed).
 
 See [client eviction]({{< relref "/develop/reference/clients" >}}#client-eviction) for more details.
+
+## Return information
+
+{{< multitabs id="client-no-evict-return-info"
+    tab1="RESP2"
+    tab2="RESP3" >}}
+
+One of the following:
+
+* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if the command was successful.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: wrong number of or invalid arguments. 
+
+-tab-sep-
+
+One of the following:
+
+* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if the command was successful.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: wrong number of or invalid arguments.
+
+{{< /multitabs >}}

content/commands/client-no-touch.md

@@ -47,3 +47,23 @@ The `CLIENT NO-TOUCH` command controls whether commands sent by the client will
 When turned on, the current client will not change LFU/LRU stats, unless it sends the [`TOUCH`]({{< relref "/commands/touch" >}}) command.
 
 When turned off, the client touches LFU/LRU stats just as a normal client.
+
+## Return information
+
+{{< multitabs id="client-no-touch-return-info"
+    tab1="RESP2"
+    tab2="RESP3" >}}
+
+One of the following:
+
+* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if the command was successful.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: wrong number of or invalid arguments.
+
+-tab-sep-
+
+One of the following:
+
+* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if the command was successful.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: wrong number of or invalid arguments.
+
+{{< /multitabs >}}