Merge branch '3.3' of github.com:api-platform/docs into 3.3

Author: dunglas

.github/workflows/cd.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the website
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: api-platform/website
           ref: main
@@ -20,7 +20,7 @@ jobs:
         id: yarn-cache-dir-path
         run: echo "dir=$(yarn cache dir)" >> "$GITHUB_OUTPUT"
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         id: yarn-cache
         with:
           path: ${{ steps.yarn-cache-dir-path.outputs.dir }}

.github/workflows/ci.yml

@@ -4,25 +4,34 @@ on:
   push:
   pull_request:
 
+permissions: {}
+
 jobs:
   build:
     name: Lint
     runs-on: ubuntu-latest
 
+    permissions:
+      contents: read
+      packages: read
+      statuses: write
+
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Lint
         uses: github/super-linter/slim@v4
         env:
           VALIDATE_ALL_CODEBASE: false
           VALIDATE_EDITORCONFIG: false
           VALIDATE_JSCPD: false
-          DEFAULT_BRANCH: main
+          DEFAULT_BRANCH: "3.3"
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}

core/filters.md

@@ -34,8 +34,8 @@ class Book {}
 Note that `property` is used to document the Hydra view. You can also specify an [OpenAPI Parameter](https://api-platform.com/docs/references/OpenApi/Model/Parameter/) if needed.
 A Parameter can be linked to a filter, there are two types of filters:
 
-    - metadata filters, most common are serializer filters (PropertyFilter and GroupFilter) that alter the normalization context
-    - query filters that alter the results of your database queries (Doctrine, Eloquent, Elasticsearch etc.)
+- metadata filters, most common are serializer filters (PropertyFilter and GroupFilter) that alter the normalization context
+- query filters that alter the results of your database queries (Doctrine, Eloquent, Elasticsearch etc.)
 
 ### Alter the Operation via a parameter
 

deployment/kubernetes.md

@@ -33,14 +33,13 @@ If you do not have gcloud yet, install it with these command.
 curl https://sdk.cloud.google.com | bash
 ```
 
-#### 1. Build the PHP and Caddy Docker images and tag them
+#### 1. Build the PHP and PWA Docker images and tag them
 
 Versioning: The 0.1.0 is the version. This value should be the same as the attribute `appVersion` in `Chart.yaml`.
 Infos for [Google Container pulling and pushing](https://cloud.google.com/container-registry/docs/pushing-and-pulling)
 
 ```console
-docker build -t gcr.io/test-api-platform/php:0.1.0 -t gcr.io/test-api-platform/php:latest api --target php_prod
-docker build -t gcr.io/test-api-platform/caddy:0.1.0 -t gcr.io/test-api-platform/caddy:latest api --target caddy_prod
+docker build -t gcr.io/test-api-platform/php:0.1.0 -t gcr.io/test-api-platform/php:latest api --target frankenphp_prod
 docker build -t gcr.io/test-api-platform/pwa:0.1.0 -t gcr.io/test-api-platform/pwa:latest pwa --target prod
 ```
 
@@ -55,22 +54,19 @@ docker build -t gcr.io/test-api-platform/pwa:0.1.0 -t gcr.io/test-api-platform/p
 ```console
 gcloud auth configure-docker
 docker push gcr.io/test-api-platform/php
-docker push gcr.io/test-api-platform/caddy
 docker push gcr.io/test-api-platform/pwa
 ```
 
 Optional: push the version images:
 
 ```console
 docker push gcr.io/test-api-platform/php:0.1.0
-docker push gcr.io/test-api-platform/caddy:0.1.0
 docker push gcr.io/test-api-platform/pwa:0.1.0
 ```
 
 The result should look similar to these images.
 
 ![Example of Google Images - Overview](images/google-image-overview.png)
-![Example of Google Caddy Image - Details](images/google-image-caddy-details.png)
 
 ## Deploying with Helm 3
 
@@ -104,8 +100,6 @@ helm upgrade main ./helm/api-platform --namespace=default --create-namespace --w
     --install \
     --set "php.image.repository=gcr.io/test-api-platform/php" \
     --set php.image.tag=latest \
-    --set "caddy.image.repository=gcr.io/test-api-platform/caddy" \
-    --set caddy.image.tag=latest \
     --set "pwa.image.repository=gcr.io/test-api-platform/pwa" \
     --set pwa.image.tag=latest \
     --set php.appSecret='!ChangeMe!' \
@@ -180,16 +174,13 @@ kubectl --namespace=bar exec -it $PHP_POD -- bin/console doctrine:schema:create
 helm upgrade api-platform ./helm/api-platform --namespace=default \
     --set "php.image.repository=gcr.io/test-api-platform/php" \
     --set php.image.tag=latest \
-    --set "caddy.image.repository=gcr.io/test-api-platform/caddy" \
-    --set caddy.image.tag=latest \
     --set "pwa.image.repository=gcr.io/test-api-platform/pwa" \
     --set pwa.image.tag=latest \
     --set php.appSecret='!ChangeMe!' \
     --set postgresql.postgresqlPassword='!ChangeMe!' \
     --set postgresql.persistence.enabled=true \
     --set "corsAllowOrigin=^https?://[a-z\]*\.mywebsite.com$" \
     --set php.image.pullPolicy=Always \
-    --set caddy.image.pullPolicy=Always \
     --set pwa.image.pullPolicy=Always
 ```