k8s api docs 7.8.2-2

.github/workflows/main.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 }}."

.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/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/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
 
@@ -45,13 +45,13 @@ Redis Cloud is a fully managed Database as a Service offering and the fastest wa
 
 - [Redis Cloud REST API introduction]({{< relref "/operate/rc/api/" >}})
 - [Redis Cloud REST API examples]({{< relref "/operate/rc/api/examples/" >}})
-- [Redis Cloud REST API reference]({{< relref "/operate/rs/references/rest-api/" >}})
+- [Redis Cloud REST API reference](https://api.redislabs.com/v1/swagger-ui.html)
 
 
 ### Redis Enterprise Software API
 If you have installed Redis Enterprise Software, you can automate operations with the Redis Enterprise REST API.
 
-- [Redis Enterprise Software REST API introduction]({{< relref "/operate/rc/api/" >}})
+- [Redis Enterprise Software REST API introduction]({{< relref "/operate/rs/references/rest-api/" >}})
 - [Redis Enterprise Software REST API requests]({{< relref "/operate/rs/references/rest-api/requests/" >}})
 - [Redis Enterprise Software REST API objects]({{< relref "/operate/rs/references/rest-api/objects/" >}})
 

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-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:
 

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.

content/commands/ft.create/index.md

@@ -431,10 +431,6 @@ author_id TAG SORTABLE author_ids TAG title TEXT name TEXT
 {{< / highlight >}}
 
 In this example, keys for author data use the key pattern `author:details:<id>` while keys for book data use the pattern `book:details:<id>`.
-</details>
-
-<details open>
-<summary><b>Index a JSON document using a JSON Path expression</b></summary>
 
 Index authors whose names start with G.
 
@@ -451,10 +447,14 @@ Index only books that have a subtitle.
 Index books that have a "categories" attribute where each category is separated by a `;` character.
 
 {{< highlight bash >}}
-127.0.0.1:6379> FT.CREATE books-idx ON HASH PREFIX 1 book:details FILTER SCHEMA title TEXT categories TAG SEPARATOR ";"
+127.0.0.1:6379> FT.CREATE books-idx ON HASH PREFIX 1 book:details SCHEMA title TEXT categories TAG SEPARATOR ";"
 {{< / highlight >}}
+</details>
+
+<details open>
+<summary><b>Index a JSON document using a JSON Path expression</b></summary>
 
-Index a JSON document using a JSON Path expression.
+The following example uses data similar to the hash examples above but uses JSON instead.
 
 {{< highlight bash >}}
 127.0.0.1:6379> FT.CREATE idx ON JSON SCHEMA $.title AS title TEXT $.categories AS categories TAG