Merge branch 'release-rs-fuya-fuya' into DOC-3944

Author: rrelledge

.github/workflows/redis_modules_docs_sync.yaml

@@ -0,0 +1,84 @@
+name: redis_modules_docs_sync
+
+on:
+  schedule:
+    - cron: '0 0 * * *' # run every day at midnight UTC time
+  workflow_dispatch: # or run on manual trigger
+
+jobs:
+  redis_modules_docs_sync:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+      actions: write
+    steps:
+      - name: 'Checkout'
+        uses: 'actions/checkout@v3'
+
+      - name: 'Fetch commands json files from modules'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          branch="redis_modules_docs_sync"
+          modules_list=("redisjson" "redisbloom" "redistimeseries" "redisearch")
+          module_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
+
+          for module in "${modules_list[@]}"; do
+            # Find latest version
+            module_version=$(
+              curl -Ls \
+              -H "Accept: application/vnd.github+json" \
+              -H "Authorization: Bearer ${GH_TOKEN}" \
+              -H "X-GitHub-Api-Version: 2022-11-28" \
+              "https://api.github.com/repos/${module}/${module}/releases/latest" \
+              | jq -r '.tag_name'
+            )
+
+            # Fetch release
+            gh release download "$module_version" -R "${module}/${module}" -A zip -O "${module}.zip"
+            unzip "${module}.zip" -d "${module}"
+            cp ${module}/*/commands.json "data/commands_${module}.json"
+
+            modules_commands_is_different=$(git diff "data/commands_${module}.json")
+            if [[ ! -z $modules_commands_is_different ]]; then
+              module_change=true
+              
+              git add "data/commands_${module}.json"
+              git config user.email "177626021+redisdocsapp[bot]@users.noreply.github.com"
+              git config user.name "redisdocsapp[bot]"
+              git commit -m "Update data/commands_${module}.json for release ${module_version}"
+            fi
+          done
+
+          if [ "$module_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 "redis modules docs sync" | grep -q "redis modules docs sync"
+            if [ "$?" -eq 1 ]; then
+              set -e
+              gh pr create \
+                --body "redis modules docs sync" \
+                --title "redis modules docs sync" \
+                --head "$branch" \
+                --base "main"
+            fi
+          fi

assets/css/index.css

@@ -969,4 +969,103 @@ code {
 /* no-click turns off border and click event on small icons */
 a[href*="#no-click"], img[src*="#no-click"] {
   @apply border-none cursor-default pointer-events-none no-underline;
+}
+
+/* Version selector in side menu */
+.menu__version-selector {
+  float: right;
+  left: 18px;
+  padding: 0 22px 0;
+  position: relative;
+  top: -28px;
+  z-index: 1;
+  border: 1px solid #dfdfdf;
+}
+
+.menu__version-selector button {
+  background: transparent;
+  border: none;
+  font-size: 13px;
+  outline: none;
+}
+
+.menu__version-selector button span.menu__version-selector__toggler {
+  display: none;
+  font-size: 8px;
+  transform: translateY(-1px) translateX(2px);
+}
+
+.menu__version-selector span.menu__version-selector__toggler.opener {
+  display: inline-block;
+}
+
+.menu__version-selector span.menu__version-selector__toggler.closer {
+  display: none;
+}
+
+.menu__version-selector .menu__version-selector__list {
+  background: #f7f7f7;
+  border: 1px solid #dfdfdf;
+  border-top: none;
+  display: none;
+  font-size: 13px;
+  left: -1px;
+  position: absolute;
+  width: calc(100% + 2px);
+  z-index: 1;
+}
+
+.menu__version-selector .menu__version-selector__list a {
+  color: #868484;
+  display: block;
+  padding-left: 10px;
+  width: 100%;
+}
+
+.menu__version-selector .menu__version-selector__list a:hover {
+  color: #000;
+}
+
+.menu__version-selector .menu__version-selector__list a.selected-version {
+  display: none;
+}
+
+.menu__version-selector.open {
+  border: 1px solid #dfdfdf;
+}
+
+.menu__version-selector.open .menu__version-selector__toggler.opener {
+  display: none;
+}
+
+.menu__version-selector.open .menu__version-selector__toggler.closer {
+  display: inline-block;
+}
+
+.menu__version-selector.open .menu__version-selector__list {
+  display: block;
+}
+
+.menu__version-selector > li .menu-divider {
+  border-top: 1px solid #5d6876;
+  height: 1px;
+  left: 20px;
+  margin-left: 0 !important;
+  position: absolute;
+  top: 10px;
+  width: calc(100% - 20px);
+}
+
+.menu__version-selector > li > .children {
+  display: none;
+}
+
+.menu__version-selector > li.parent > .children {
+  display: flex;
+  position: relative;
+  padding-top: 60px;
+}
+
+.dd-item .highlight:hover {
+  color: #5961ff;
 }

build/components/example.py

@@ -11,17 +11,19 @@
 GO_OUTPUT = 'Output:'
 TEST_MARKER = {
     'java': '@Test',
-    'c#': '\[Fact\]'
+    'c#': '\[Fact\]|\[SkipIfRedis\(.*\)\]'
 }
 PREFIXES = {
     'python': '#',
     'node.js': '//',
     'java': '//',
     'go': '//',
     'c#': '//',
-    'redisvl': '#'
+    'redisvl': '#',
+    'php': '//'
 }
 
+
 class Example(object):
     language = None
     path = None

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/use/client-side-caching" >}}) for
+[client side caching documentation]({{< relref "/develop/connect/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/use/client-side-caching" >}}) notifications to. We set a client
+[tracking]({{< relref "/develop/connect/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-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/use/client-side-caching" >}}).
+for [server assisted client side caching]({{< relref "/develop/connect/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
@@ -85,7 +85,7 @@ when the RESP3 protocol is used) or redirected in a different connection
 available where clients participating in this protocol receive every
 notification just subscribing to given key prefixes, regardless of the
 keys that they requested. Given the complexity of the argument please
-refer to [the main client side caching documentation]({{< relref "/develop/use/client-side-caching" >}}) for the details. This manual page is only a reference for the options of this subcommand.
+refer to [the main client side caching documentation]({{< relref "/develop/reference/client-side-caching" >}}) for the details. This manual page is only a reference for the options of this subcommand.
 
 In order to enable tracking, use:
 

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/use/client-side-caching" >}}) feature.
+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.
 
 Here's the list of tracking information sections and their respective values:
 

content/commands/flushall/index.md

@@ -62,8 +62,11 @@ It is possible to use one of the following modifiers to dictate the flushing mod
 * `ASYNC`: flushes the databases asynchronously
 * `SYNC`: flushes the databases synchronously
 
-Note: an asynchronous `FLUSHALL` command only deletes keys that were present at the time the command was invoked. Keys created during an asynchronous flush will be unaffected.
+## Notes
+
+* An asynchronous `FLUSHALL` command only deletes keys that were present at the time the command was invoked. Keys created during an asynchronous flush will be unaffected.
+* This command does not delete functions.
 
 ## Behavior change history
 
-*   `>= 6.2.0`: Default flush behavior now configurable by the **lazyfree-lazy-user-flush** configuration directive. 
+*   `>= 6.2.0`: Default flush behavior now configurable by the **lazyfree-lazy-user-flush** configuration directive. 

content/commands/flushdb/index.md

@@ -62,8 +62,11 @@ It is possible to use one of the following modifiers to dictate the flushing mod
 * `ASYNC`: flushes the database asynchronously
 * `SYNC`: flushes the database synchronously
 
-Note: an asynchronous `FLUSHDB` command only deletes keys that were present at the time the command was invoked. Keys created during an asynchronous flush will be unaffected.
+## Notes
+
+* An asynchronous `FLUSHDB` command only deletes keys that were present at the time the command was invoked. Keys created during an asynchronous flush will be unaffected.
+* This command does not delete functions.
 
 ## Behavior change history
 
-*   `>= 6.2.0`: Default flush behavior now configurable by the **lazyfree-lazy-user-flush** configuration directive. 
+*   `>= 6.2.0`: Default flush behavior now configurable by the **lazyfree-lazy-user-flush** configuration directive.

content/commands/ft.config-set/index.md

@@ -35,7 +35,7 @@ Set the value of a RediSearch configuration parameter.
 
 Values set using `FT.CONFIG SET` are not persisted after server restart.
 
-RediSearch configuration parameters are detailed in [Configuration parameters]({{< relref "/develop/interact/search-and-query/administration" >}}).
+RediSearch configuration parameters are detailed in [Configuration parameters]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}).
 
 {{% alert title="Note" color="warning" %}}
 As detailed in the link above, not all RediSearch configuration parameters can be set at runtime.