Merge branch 'main' into sep-routes

platformsh · Feb 12, 2024 · 7afea80 · 7afea80
2 parents 4465ffb + b69abe9
commit 7afea80
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 13 deletions.
diff --git a/.github/workflows/linting.yaml b/.github/workflows/linting.yaml
@@ -47,7 +47,7 @@ jobs:
       - name: Vale
         uses: errata-ai/vale-action@reviewdog
         with:
-          version: 2.30.0
+          version: 3.0.7
           fail_on_error: true
           reporter: github-check
           files: sites/platform/src

diff --git a/...ributing/styles/Vocab/Platform/accept.txt → ...s/config/vocabularies/Platform/accept.txt b/...ributing/styles/Vocab/Platform/accept.txt → ...s/config/vocabularies/Platform/accept.txt
@@ -69,8 +69,7 @@ IPs?
 JVM
 imagetragick
 jpegoptim
-Kafka
-kafka
+[Kk]afka
 Lando
 Laravel
 Loggly
@@ -155,8 +154,7 @@ scp
 seccomp
 serverless
 Servlet
-sftp
-SFTP
+[Ss][Ff][Tt][Pp]
 shard
 shortcode
 Slowloris
@@ -168,8 +166,7 @@ Strapi
 [Ss]ubprocessor
 subuser
 Swoole
-Symfony
-symfony
+[Ss]ymfony
 [Ss]yslog
 systemd
 Thorntail

diff --git a/...ributing/styles/Vocab/Platform/reject.txt → ...s/config/vocabularies/Platform/reject.txt b/...ributing/styles/Vocab/Platform/reject.txt → ...s/config/vocabularies/Platform/reject.txt
diff --git a/shared/scripts/gen-cli-docs.sh b/shared/scripts/gen-cli-docs.sh
@@ -3,13 +3,15 @@
 cp shared/pages/commands.md $1
 
 VERSION=$($2 version)
+
+printf "\n<!-- vale off -->\n" >> $1
+
 printf "\n# $VERSION\n" >> $1
 
 printf "\n- [Installation](/administration/cli#1-install)" >> $1
 printf "\n- [Open an issue](https://github.com/platformsh/cli/issues)\n" >> $1
 
 printf "\n## All commands\n" >> $1
-printf "\n<!-- vale off -->\n" >> $1
 
 $2 list --format=md | tail -n +2 >> $1
 

diff --git a/sites/friday/src/administration/cli/reference.md b/sites/friday/src/administration/cli/reference.md
@@ -11,7 +11,9 @@ showTitle: false
     }
 </style>
 
-# Upsun CLI 5.0.8
+<!-- vale off -->
+
+# Upsun CLI 5.0.9
 
 - [Installation](/administration/cli#1-install)
 - [Open an issue](https://github.com/platformsh/cli/issues)
@@ -8469,3 +8471,5 @@ upsun workers [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVI
   Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: UPSUN_CLI_NO_INTERACTION=1
 
 
+
+<!-- vale on -->
diff --git a/sites/platform/src/add-services/redis.md b/sites/platform/src/add-services/redis.md
@@ -104,6 +104,23 @@ restoring it if the container restarts.
 To switch from persistent to ephemeral Redis,
 set up a new service with a different name.
 
+{{% note theme="warning" title="Warning" %}}
+
+{{% vendor/name %}} sets the maximum amount of memory (`maxmemory`) Redis can use for the data set,
+and it cannot be amended.
+It is defined by comparing the following values and keeping the lower of the two:
+
+- Disk size/6 (based on a [recommendation from Redis](https://docs.redis.com/latest/rs/installing-upgrading/install/plan-deployment/hardware-requirements/#productionenvironment))
+- The amount of memory allocated to the service container
+
+For instance, if your Redis container has 3072 MB of disk space and 1024 MB of memory,
+only 512 MB of RAM are actually available to the service (3072/6 = 512).
+
+But if your Redis container has 3072 MB of disk space and 256 MB of memory,
+only 256 MB of RAM are actually available to the service (as per the container limit).
+
+{{% /note %}}
+
 ### Usage example
 
 #### 1. Configure the service
@@ -648,7 +665,7 @@ The format of the relationship is identical whether your Redis service is [ephem
 
 ## Eviction policy
 
-When [ephemeral Redis](#ephemeral-redis) reaches its memory limit,
+When Redis reaches its memory limit,
 it triggers a cache cleanup.
 To customize those cache cleanups, set up an eviction policy such as the following:
 

diff --git a/sites/platform/src/administration/cli/reference.md b/sites/platform/src/administration/cli/reference.md
@@ -11,7 +11,9 @@ showTitle: false
     }
 </style>
 
-# Platform.sh CLI 5.0.8
+<!-- vale off -->
+
+# Platform.sh CLI 5.0.9
 
 - [Installation](/administration/cli#1-install)
 - [Open an issue](https://github.com/platformsh/cli/issues)
@@ -8421,3 +8423,5 @@ platform workers [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment E
   Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: PLATFORMSH_CLI_NO_INTERACTION=1
 
 
+
+<!-- vale on -->
diff --git a/sites/platform/src/create-apps/app-reference.md b/sites/platform/src/create-apps/app-reference.md
@@ -179,8 +179,8 @@ The total resources allocated across all apps and services can't exceed what's i
 
 Containers in preview environments don't follow the `size` specification.
 Application containers are set based on the plan's setting for **Environments application size**.
-The default is **{{< partial "plans/default-dev-env-size" >}}**, but you can increase it by editing your plan.
-(Service containers in preview environments are always set to {{< partial "plans/default-dev-env-size" >}} size.)
+The default is size **S**, but you can increase it by editing your plan.
+(Service containers in preview environments are always set to size **S**.)
 
 <--->
 ## Resources