Merge '4.0' into main

.github/ISSUE_TEMPLATE/1_Support_question.md

@@ -1,11 +1,12 @@
 ---
 name: ⛔ Support Question
 about: See https://api-platform.com/support/ for questions about using API Platform
-
 ---
 
-We use GitHub issues only to discuss about bugs and new features.
+# Support question
+
+We use GitHub issues only to discuss bugs and new features.
 For this kind of questions about using API Platform, please use
-any of the support alternatives shown in https://api-platform.com/support/
+any of the support alternatives shown in [API Platform support](https://api-platform.com/support/).
 
 Thanks!

.github/ISSUE_TEMPLATE/2_Documentation_issue.md

@@ -1,5 +1,4 @@
 ---
 name: 📄 Documentation issue
 about: Report a documentation issue
-
 ---

.github/workflows/cd.yml

@@ -1,10 +1,18 @@
+---
 name: Deploy Website
 
 on:
   push:
     branches:
       - main
-      - '*.*'
+      - "*.*"
+
+permissions:
+  contents: read
+  actions: read
+  checks: write
+  deployments: write
+  pull-requests: read
 
 jobs:
   deploy:
@@ -28,57 +36,52 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-yarn-
 
-
       - name: Setup Hugo
-        uses: peaceiris/actions-hugo@v2
+        uses: peaceiris/actions-hugo@v3
         with:
-          hugo-version: '0.134.2'
+          hugo-version: "0.134.2"
           extended: true
 
       - name: Install php
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.2'
+          php-version: "8.2"
           tools: phive
 
       - name: Auth gcloud
-        uses: google-github-actions/auth@v1
+        uses: google-github-actions/auth@v2
         with:
           credentials_json: ${{ secrets.BUCKET_CREDS }}
-        
-      - name: 'Set up Cloud SDK'
-        uses: 'google-github-actions/setup-gcloud@v1'
+
+      - name: Set up Cloud SDK
+        uses: google-github-actions/setup-gcloud@v2
 
       - name: Clone website
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           repository: api-platform/docs-website
           path: docs-website
+
       - name: Install javascript packages
         working-directory: docs-website
         run: npm install
+
       - name: Fetch API Platform docs
         working-directory: docs-website
         run: tools/get-docs.sh
+
       - name: Fetch API Platform references and guides
         working-directory: docs-website
         run: tools/get-core-docs.sh
-      - name: Build menu 
+
+      - name: Build menu
         working-directory: docs-website
         run: node tools/menu.mjs
+
       - name: Hugo
         working-directory: docs-website
         run: hugo --minify
+
       - name: Deploy
         working-directory: docs-website
         run: gsutil -q -m rsync -d -r ./public gs://api-platform-website-v3/
-      # This need to move to website
-      # env:
-      #   GITHUB_KEY: ${{ secrets.CONTRIBUTORS_GITHUB_TOKEN }}
-      #   NODE_OPTIONS: --openssl-legacy-provider
-      # - name: Deploy
-      #   uses: peaceiris/actions-gh-pages@v3
-      #   with:
-      #     github_token: ${{ secrets.GITHUB_TOKEN }}
-      #     publish_dir: ./public
-      #     cname: api-platform.com

.github/workflows/ci.yml

@@ -1,10 +1,12 @@
+---
 name: Lint
 
 on:
   push:
   pull_request:
 
-permissions: {}
+permissions:
+  contents: read
 
 jobs:
   build:
@@ -23,12 +25,12 @@ jobs:
           fetch-depth: 0
 
       - name: Lint
-        uses: github/super-linter/slim@v4
+        uses: super-linter/super-linter/slim@v7
         env:
-          VALIDATE_ALL_CODEBASE: false
           VALIDATE_EDITORCONFIG: false
           VALIDATE_JSCPD: false
-          DEFAULT_BRANCH: "4.0"
+          VALIDATE_MARKDOWN_PRETTIER: false
+          DEFAULT_BRANCH: "origin/4.0"
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - uses: actions/cache@v4

.markdownlint.yml

@@ -1,3 +1,4 @@
+---
 MD013:
   line_length: 400
 no-inline-html:

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing to the API Platform Documentation
+
+First of all, thank you for contributing, you're awesome!
+
+To have your code integrated in the API Platform documentation project, there are some rules to follow, but don't panic, it's easy!
+
+## Reporting Bugs in the documentation
+
+Before submitting your issue:
+
+- Check if the bug is not already reported!
+- A clear title to resume the issue
+- A description of the workflow needed to reproduce the bug
+
+> [!NOTE]
+> Don't hesitate giving as much information as you can.
+
+## Code of Conduct
+
+By contributing to this project, you agree to abide by our [Code of Conduct](https://github.com/api-platform/docs#coc-ov-file). We expect all contributors to foster a welcoming and inclusive environment.
+
+## How to Contribute
+
+1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs` repository page.
+
+2. Clone the forked repository to your local machine:
+   ```console
+     git clone https://github.com/your-username/repository-name.git
+   ```
+3. Create a new branch for your contribution:
+   ```console
+     git switch -c docs-your-branch-name
+   ```
+4. Commit and push your changes
+5. Submit a Pull Request. You must decide on what branch your changes will be based depending of the nature of the change.
+   See [the dedicated documentation entry](https://api-platform.com/docs/extra/releases/).
+
+> [!TIP]
+> You can also contribute to improving the documentation directly by clicking on the
+> **"You can also help us improve the documentation of this page."** link, located at the end of each documentation page.