Merge main

Author: dwdougherty

.github/workflows/main.yml

@@ -150,11 +150,23 @@ jobs:
           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
+          if [[ "${{ github.ref_name }}" == "latest" ]]
+          then
+            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
+          fi
+
+          if [[ "$bucket_path" == staging/* ]]
+          then
+            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}/${bucket_path}/${versioned_build}/operate/${product}"
+            done
+          fi
 
     - name: End
       run: echo "This job's status is ${{ job.status }}."

.github/workflows/update_command_pages.yaml

@@ -0,0 +1,74 @@
+name: update_command_pages
+
+on:
+  push:
+    branches: ['main']
+    paths:
+      - data/commands_core.json # run when data/commands_core.json is updated on main
+  workflow_dispatch: # or run on manual trigger
+
+jobs:
+  update_command_pages:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+      actions: write
+    steps:
+      - name: 'Checkout'
+        uses: 'actions/checkout@v3'
+      
+      - name: Install dependencies
+        run: make deps
+
+      - name: 'Run build/update_cmds.py script'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          branch="update_command_pages"
+          commands_change=false
+
+          # check if remote branch already exists
+          git fetch --all
+          set +e
+          git ls-remote --exit-code --heads origin "refs/heads/${branch}"
+          if [ "$?" -eq 0 ]; then
+            set -e
+            # if it does, create local branch off existing remote branch
+            git checkout -b "${branch}" "origin/${branch}"
+            git branch --set-upstream-to="origin/${branch}" "${branch}"
+            git pull
+          else
+            set -e
+            # otherwise, create local branch from main
+            git checkout -b "${branch}"
+          fi
+
+          python3 build/update_cmds.py
+          
+          commands_are_different=$(git diff "content/commands/")
+
+          if [[ ! -z $commands_are_different ]]; then
+            commands_change=true
+
+            git add "content/commands/"
+            git config user.email "177626021+redisdocsapp[bot]@users.noreply.github.com"
+            git config user.name "redisdocsapp[bot]"
+            git commit -m "Update content/commands/"
+          fi
+
+          if [ "$commands_change" = true ] ; then
+            git push origin "${branch}"
+
+            # If a pr is not already open, create one
+            set +e
+            gh search prs -R redis/docs --state open --match title "update command pages" | grep -q "update command pages"
+            if [ "$?" -eq 1 ]; then
+              set -e
+              gh pr create \
+                --body "update command pages" \
+                --title "update command pages" \
+                --head "$branch" \
+                --base "main"
+            fi
+          fi

build/components/component.py

@@ -1,6 +1,8 @@
 import logging
 import glob
 import os
+import shutil
+
 import semver
 import uuid
 from typing import Tuple
@@ -514,13 +516,20 @@ def _copy_examples(self):
                 if not example_id:
                     continue
 
-                example_metadata = {'source': f}
+                example_metadata = {
+                    'source': f,
+                    'language': self.get('language').lower()
+                }
+
+                base_path = os.path.join(dst, example_id)
+                mkdir_p(base_path)
+                rsync(example_metadata['source'], base_path)
 
-                mkdir_p(f'{dst}/{example_id}')
-                rsync(example_metadata['source'], f'{dst}/{example_id}/')
+                target_path = os.path.join(base_path, f'{self.get("id")}_{os.path.basename(f)}')
+                shutil.move(os.path.join(base_path, os.path.basename(f)), target_path)
 
-                example_metadata['target'] = f'{dst}/{example_id}/{os.path.basename(f)}'
-                e = Example(self.get('language'), example_metadata['target'])
+                example_metadata['target'] = target_path
+                e = Example(self.get('language'), target_path)
                 example_metadata['highlight'] = e.highlight
                 example_metadata['hidden'] = e.hidden
                 example_metadata['named_steps'] = e.named_steps
@@ -532,7 +541,7 @@ def _copy_examples(self):
                     examples[example_id] = {}
 
                 logging.info(f'Example {example_id} processed successfully.')
-                examples[example_id][self.get('language')] = example_metadata
+                examples[example_id][self.get('label')] = example_metadata
 
     def apply(self) -> None:
         logging.info(f'Applying client {self._id}')

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", "Go", "C#", "RedisVL"]
+clientsExamples = ["Python", "Node.js", "Java Sync", "Java Async", "Java Reactive", "Go", "C#", "RedisVL"]
 searchService = "/convai/api/search-service"
 ratingsService = "/docusight/api/rate"
 
@@ -57,12 +57,14 @@ rdi_db_types = "cassandra|mysql|oracle|postgresql|sqlserver"
 rdi_cli_latest = "latest"
 
 [params.clientsConfig]
-"Python"={lang="python", quickstartSlug="python/redis-py"}
-"Node.js"={lang="javascript", quickstartSlug="nodejs"}
-"Java"={lang="java", quickstartSlug="java/jedis"}
-"Go"={lang="go", quickstartSlug="go"}
-"C#"={lang="C#", quickstartSlug="dotnet"}
-"RedisVL"={lang="python", quickstartSlug="python/redis-vl"}
+"Python"={quickstartSlug="redis-py"}
+"Node.js"={quickstartSlug="nodejs"}
+"Java sync"={quickstartSlug="jedis"}
+"Java async"={quickstartSlug="lettuce"}
+"Java reactive"={quickstartSlug="lettuce"}
+"Go"={quickstartSlug="go"}
+"C#"={quickstartSlug="dotnet"}
+"RedisVL"={quickstartSlug="redis-vl"}
 
 # Markup
 [markup]

content/apis/_index.md

@@ -18,7 +18,7 @@ Redis comes with a wide range of commands that help you to develop real-time app
 
 As a developer, you will likely use one of our supported client libraries for connecting and executing commands.
 
-- [Connect with Redis clients introduction]({{< relref "/develop/connect/clients/" >}})
+- [Connect with Redis clients introduction]({{< relref "/develop/clients" >}})
 
 ### Programmability APIs
 

content/commands/client-caching/index.md

@@ -43,7 +43,7 @@ title: CLIENT CACHING
 This command controls the tracking of the keys in the next command executed
 by the connection, when tracking is enabled in `OPTIN` or `OPTOUT` mode.
 Please check the
-[client side caching documentation]({{< relref "/develop/connect/clients/client-side-caching" >}}) for
+[client side caching documentation]({{< relref "/develop/clients/client-side-caching" >}}) for
 background information.
 
 When tracking is enabled Redis, using the [`CLIENT TRACKING`]({{< relref "/commands/client-tracking" >}}) command, it is

content/commands/client-getredir/index.md

@@ -31,7 +31,7 @@ syntax_str: ''
 title: CLIENT GETREDIR
 ---
 This command returns the client ID we are redirecting our
-[tracking]({{< relref "/develop/connect/clients/client-side-caching#tracking" >}}) notifications to. We set a client
+[tracking]({{< relref "/develop/clients/client-side-caching#tracking" >}}) notifications to. We set a client
 to redirect to when using [`CLIENT TRACKING`]({{< relref "/commands/client-tracking" >}}) to enable tracking. However in
 order to avoid forcing client libraries implementations to remember the
 ID notifications are redirected to, this command exists in order to improve

content/commands/client-kill/index.md

@@ -74,6 +74,12 @@ arguments:
       optional: true
       token: SKIPME
       type: oneof
+    - display_text: maxage
+      name: maxage
+      optional: true
+      since: 7.4.0
+      token: MAXAGE
+      type: integer
     multiple: true
     name: new-format
     type: oneof
@@ -110,6 +116,8 @@ history:
   - Replaced `slave` `TYPE` with `replica`. `slave` still supported for backward compatibility.
 - - 6.2.0
   - '`LADDR` option.'
+- - 7.4.0
+  - '`MAXAGE` option.'
 linkTitle: CLIENT KILL
 since: 2.4.0
 summary: Terminates open connections.

content/commands/client-tracking/index.md

@@ -75,7 +75,7 @@ syntax_str: "[REDIRECT\_client-id] [PREFIX\_prefix [PREFIX prefix ...]] [BCAST]
 title: CLIENT TRACKING
 ---
 This command enables the tracking feature of the Redis server, that is used
-for [server assisted client side caching]({{< relref "/develop/connect/clients/client-side-caching#tracking" >}}).
+for [server assisted client side caching]({{< relref "/develop/clients/client-side-caching#tracking" >}}).
 
 When tracking is enabled Redis remembers the keys that the connection
 requested, in order to send later invalidation messages when such keys are

content/commands/client-trackinginfo/index.md

@@ -29,7 +29,7 @@ syntax_fmt: CLIENT TRACKINGINFO
 syntax_str: ''
 title: CLIENT TRACKINGINFO
 ---
-The command returns information about the current client connection's use of the [server assisted client side caching]({{< relref "/develop/connect/clients/client-side-caching" >}}) feature.
+The command returns information about the current client connection's use of the [server assisted client side caching]({{< relref "/develop/clients/client-side-caching" >}}) feature.
 
 Here's the list of tracking information sections and their respective values: