Merging main

Author: dwdougherty

.github/workflows/k8s_apis_sync.yaml

@@ -90,30 +90,30 @@ jobs:
           EOL
           }
 
-          formatYamlSnippet admission-service.yaml content/embeds/admission-service.md
-          formatYamlSnippet admission/webhook.yaml content/embeds/admission_webhook.md
-          formatYamlSnippet examples/v1/rec.yaml content/embeds/rec.md
-          formatYamlSnippet examples/v1alpha1/reaadb.yaml content/embeds/reaadb.md
-          formatYamlSnippet examples/v1alpha1/redb.yaml content/embeds/redb.md
-          formatYamlSnippet examples/v1alpha1/rerc.yaml content/embeds/rerc.md
-          formatYamlSnippet log_collector/log_collector_role_all_mode.yaml content/embeds/log_collector_role_all_mode.md
-          formatYamlSnippet log_collector/log_collector_role_restricted_mode.yaml content/embeds/log_collector_role_restricted_mode.md
-          formatYamlSnippet multi-namespace-redb/operator_cluster_role_binding.yaml content/embeds/multi-ns_operator_cluster_role_binding.md
-          formatYamlSnippet multi-namespace-redb/operator_cluster_role.yaml content/embeds/multi-ns_operator_cluster_role.md
-          formatYamlSnippet multi-namespace-redb/role_binding.yaml content/embeds/multi-ns_role_binding.md
-          formatYamlSnippet multi-namespace-redb/role.yaml content/embeds/multi-ns_role.md
-          formatYamlSnippet openshift/admission-service.yaml content/embeds/openshift_admission-service.md
-          formatYamlSnippet openshift/rec_rhel.yaml content/embeds/openshift_rec.md
-          formatYamlSnippet openshift/role_binding.yaml content/embeds/openshift_role_binding.md
-          formatYamlSnippet openshift/role.yaml content/embeds/openshift_role.md
-          formatYamlSnippet openshift/scc.yaml content/embeds/openshift_scc.md
-          formatYamlSnippet openshift/service_account.yaml content/embeds/openshift_service_account.md
-          formatYamlSnippet rack_awareness/rack_aware_cluster_role_binding.yaml content/embeds/rack_aware_cluster_role_binding.md
-          formatYamlSnippet rack_awareness/rack_aware_cluster_role.yaml content/embeds/rack_aware_cluster_role.md
-          formatYamlSnippet rack_awareness/rack_aware_rec.yaml content/embeds/rack_aware_rec.md
-          formatYamlSnippet role_binding.yaml content/embeds/role_binding.md
-          formatYamlSnippet role.yaml content/embeds/role.md
-          formatYamlSnippet service_account.yaml content/embeds/service_account.md
+          formatYamlSnippet admission-service.yaml content/embeds/k8s/admission-service.md
+          formatYamlSnippet admission/webhook.yaml content/embeds/k8s/admission_webhook.md
+          formatYamlSnippet examples/v1/rec.yaml content/embeds/k8s/rec.md
+          formatYamlSnippet examples/v1alpha1/reaadb.yaml content/embeds/k8s/reaadb.md
+          formatYamlSnippet examples/v1alpha1/redb.yaml content/embeds/k8s/redb.md
+          formatYamlSnippet examples/v1alpha1/rerc.yaml content/embeds/k8s/rerc.md
+          formatYamlSnippet log_collector/log_collector_role_all_mode.yaml content/embeds/k8s/log_collector_role_all_mode.md
+          formatYamlSnippet log_collector/log_collector_role_restricted_mode.yaml content/embeds/k8s/log_collector_role_restricted_mode.md
+          formatYamlSnippet multi-namespace-redb/operator_cluster_role_binding.yaml content/embeds/k8s/multi-ns_operator_cluster_role_binding.md
+          formatYamlSnippet multi-namespace-redb/operator_cluster_role.yaml content/embeds/k8s/multi-ns_operator_cluster_role.md
+          formatYamlSnippet multi-namespace-redb/role_binding.yaml content/embeds/k8s/multi-ns_role_binding.md
+          formatYamlSnippet multi-namespace-redb/role.yaml content/embeds/k8s/multi-ns_role.md
+          formatYamlSnippet openshift/admission-service.yaml content/embeds/k8s/openshift_admission-service.md
+          formatYamlSnippet openshift/rec_rhel.yaml content/embeds/k8s/openshift_rec.md
+          formatYamlSnippet openshift/role_binding.yaml content/embeds/k8s/openshift_role_binding.md
+          formatYamlSnippet openshift/role.yaml content/embeds/k8s/openshift_role.md
+          formatYamlSnippet openshift/scc.yaml content/embeds/k8s/openshift_scc.md
+          formatYamlSnippet openshift/service_account.yaml content/embeds/k8s/openshift_service_account.md
+          formatYamlSnippet rack_awareness/rack_aware_cluster_role_binding.yaml content/embeds/k8s/rack_aware_cluster_role_binding.md
+          formatYamlSnippet rack_awareness/rack_aware_cluster_role.yaml content/embeds/k8s/rack_aware_cluster_role.md
+          formatYamlSnippet rack_awareness/rack_aware_rec.yaml content/embeds/k8s/rack_aware_rec.md
+          formatYamlSnippet role_binding.yaml content/embeds/k8s/role_binding.md
+          formatYamlSnippet role.yaml content/embeds/k8s/role.md
+          formatYamlSnippet service_account.yaml content/embeds/k8s/service_account.md
 
       - name: 'Send pull request'
         env:
@@ -136,7 +136,7 @@ jobs:
           git apply content/operate/kubernetes/reference/kubernetes-api-reference-frontmatter.patch
 
           git add content/operate/kubernetes/reference/
-          git add content/embeds/
+          git add content/embeds/k8s/
 
           git commit -m "k8s api docs ${RELEASE}"
           git push origin "${BRANCH}"

.github/workflows/main-staging.yml

@@ -7,7 +7,7 @@ jobs:
     name: Build the staging documentation site
     runs-on: ubuntu-latest
     env:
-      HUGO_VERSION: 0.111.2
+      HUGO_VERSION: 0.143.1
       GCLOUD_VERSION: 458.0.1-linux-x86_64
       BUCKET: docs-staging-learn-redis-com
       BUCKET_SERVICE_ACCOUNT: ${{ secrets.BUCKET_DOCUMENTATION_SA_STAGING }}

.github/workflows/main.yml

@@ -7,7 +7,7 @@ jobs:
     name: Build the production documentation site
     runs-on: ubuntu-latest
     env:
-      HUGO_VERSION: 0.111.2
+      HUGO_VERSION: 0.143.1
       GCLOUD_VERSION: 458.0.1-linux-x86_64
       BUCKET: docs-prod-learn-redis-com
       BUCKET_SERVICE_ACCOUNT: ${{ secrets.BUCKET_DOCUMENTATION_SA_PROD }}

LICENSE

@@ -1,5 +1,8 @@
 The Redis Website and Documentation by Redis Ltd. is licensed under the 
-Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
+Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License, or,
+certain portions that were previously available at <https://github.com/redis/redis-doc?tab=readme-ov-file#readme>,
+are available under the Creative Commons Attribution-ShareAlike 4.0 International Public License
+at <https://github.com/redis/redis-doc?tab=License-1-ov-file#readme>.
 
 You should have received a copy of the license along with this
 work. If not, see <http://creativecommons.org/licenses/by-nc-sa/4.0/>.

Makefile

@@ -1,5 +1,5 @@
 HUGO_CONTENT=./content
-HUGO_DEBUG=--debug --log
+HUGO_DEBUG=--logLevel debug
 HUGO_BUILD=--gc
 
 all: clean deps components hugo

README.md

@@ -35,7 +35,7 @@ You will need the following tools to build the site locally:
 
 - `python3`: Python >= 3.8.
 - `node` and `npm`: Node.js >= 19.7.0, and the Node.js package manager >= 9.5.0.
-- `hugo`: Hugo site generator, v0.111.2; the extended edition.
+- `hugo`: Hugo site generator, v0.143.0; the extended edition.
 - `make`: To run the makefile.
 - `git`: To manage the source code of this repo.
 

config.toml

@@ -55,6 +55,7 @@ rdi_redis_gears_version = "1.2.6"
 rdi_debezium_server_version = "2.3.0.Final"
 rdi_db_types = "cassandra|mysql|oracle|postgresql|sqlserver"
 rdi_cli_latest = "latest"
+rdi_current_version = "v1.6.0"
 
 [params.clientsConfig]
 "Python"={quickstartSlug="redis-py"}

content/commands/ft.aggregate/index.md

@@ -143,6 +143,14 @@ arguments:
   name: params
   optional: true
   type: block
+- name: scorer
+  optional: true
+  token: SCORER
+  type: string
+- name: addscores
+  optional: true
+  token: ADDSCORES
+  type: pure-token
 - name: dialect
   optional: true
   since: 2.4.3
@@ -177,7 +185,8 @@ syntax: "FT.AGGREGATE index query \n  [VERBATIM] \n  [LOAD count field [field ..
   \ ...]] ...]] \n  [ SORTBY nargs [ property ASC | DESC [ property ASC | DESC ...]]\
   \ [MAX num] [WITHCOUNT] \n  [ APPLY expression AS name [ APPLY expression AS name\
   \ ...]] \n  [ LIMIT offset num] \n  [FILTER filter] \n  [ WITHCURSOR [COUNT read_size]\
-  \ [MAXIDLE idle_time]] \n  [ PARAMS nargs name value [ name value ...]] \n  [ADDSCORES] \n  [DIALECT\
+  \ [MAXIDLE idle_time]] \n  [ PARAMS nargs name value [ name value ...]] \n  [SCORER scorer]\n
+  \ [ADDSCORES] \n  [DIALECT\
   \ dialect]\n"
 syntax_fmt: "FT.AGGREGATE index query [VERBATIM] [LOAD\_count field [field ...]]\n\
   \  [TIMEOUT\_timeout] [LOAD *] [GROUPBY\_nargs property [property ...]\n  [REDUCE\_\
@@ -187,15 +196,15 @@ syntax_fmt: "FT.AGGREGATE index query [VERBATIM] [LOAD\_count field [field ...]]
   name] ...]] ...]]\n  [SORTBY\_nargs [property <ASC | DESC> [property <ASC | DESC>\
   \ ...]]\n  [MAX\_num]] [APPLY\_expression AS\_name [APPLY\_expression AS\_name\n\
   \  ...]] [LIMIT offset num] [FILTER\_filter] [WITHCURSOR\n  [COUNT\_read_size] [MAXIDLE\_\
-  idle_time]] [PARAMS nargs name value\n  [name value ...]]\n  [ADDSCORES]\n  [DIALECT\_dialect]"
+  idle_time]] [PARAMS nargs name value\n  [name value ...]]\n  [SCORER scorer]\n [ADDSCORES]\n  [DIALECT\_dialect]"
 syntax_str: "query [VERBATIM] [LOAD\_count field [field ...]] [TIMEOUT\_timeout] [LOAD\
   \ *] [GROUPBY\_nargs property [property ...] [REDUCE\_function nargs arg [arg ...]\
   \ [AS\_name] [REDUCE\_function nargs arg [arg ...] [AS\_name] ...]] [GROUPBY\_nargs\
   \ property [property ...] [REDUCE\_function nargs arg [arg ...] [AS\_name] [REDUCE\_\
   function nargs arg [arg ...] [AS\_name] ...]] ...]] [SORTBY\_nargs [property <ASC\
   \ | DESC> [property <ASC | DESC> ...]] [MAX\_num]] [APPLY\_expression AS\_name [APPLY\_\
   expression AS\_name ...]] [LIMIT offset num] [FILTER\_filter] [WITHCURSOR [COUNT\_\
-  read_size] [MAXIDLE\_idle_time]] [PARAMS nargs name value [name value ...]] [ADDSCORES] [DIALECT\_\
+  read_size] [MAXIDLE\_idle_time]] [PARAMS nargs name value [name value ...]] [SCORER scorer] [ADDSCORES] [DIALECT\_\
   dialect]"
 title: FT.AGGREGATE
 ---
@@ -324,6 +333,12 @@ defines one or more value parameters. Each parameter has a name and a value.
 You can reference parameters in the `query` by a `$`, followed by the parameter name, for example, `$user`. Each such reference in the search query to a parameter name is substituted by the corresponding parameter value. For example, with parameter definition `PARAMS 4 lon 29.69465 lat 34.95126`, the expression `@loc:[$lon $lat 10 km]` is evaluated to `@loc:[29.69465 34.95126 10 km]`. You cannot reference parameters in the query string where concrete values are not allowed, such as in field names, for example, `@loc`. To use `PARAMS`, set `DIALECT` to `2` or greater than `2`.
 </details>
 
+<details open>
+<summary><code>SCORER {scorer}</code></summary>
+
+uses a [built-in]({{< relref "/develop/interact/search-and-query/advanced-concepts/scoring" >}}) or a [user-provided]({{< relref "/develop/interact/search-and-query/administration/extensions" >}}) scoring function.
+</details>
+
 <details open>
 <summary><code>ADDSCORES</code></summary>
 

content/commands/incr/index.md

@@ -177,8 +177,8 @@ value greater than 10, otherwise it will expire and start again from 0.
 If for some reason the client performs the `INCR` command but does not perform
 the [`EXPIRE`]({{< relref "/commands/expire" >}}) the key will be leaked until we'll see the same IP address again.
 
-This can be fixed easily turning the `INCR` with optional [`EXPIRE`]({{< relref "/commands/expire" >}}) into a Lua
-script that is send using the [`EVAL`]({{< relref "/commands/eval" >}}) command (only available since Redis version
+This can be easily fixed by turning the `INCR` with optional [`EXPIRE`]({{< relref "/commands/expire" >}}) into a Lua
+script that is then sent using the [`EVAL`]({{< relref "/commands/eval" >}}) command (only available since Redis version
 2.6).
 
 ```