Merge branch 'main' into 3803-update-premium-service-pages

Author: fabpot

.github/actions/redirection-verification/package-lock.json

@@ -18,7 +18,7 @@ jobs:
     if: github.event.label.name == 'build-fork' || contains(github.event.pull_request.labels.*.name, 'build-fork')
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
           token: ${{ secrets.WORKFLOW_TOKEN }}

.github/workflows/build-from-fork.yaml

@@ -27,7 +27,7 @@ jobs:
     if: github.event.action == 'opened' || github.event.action == 'reopened'
     steps:
       - name: Get repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
       - name: Verify label exists

.github/workflows/check-labels.yaml

@@ -12,6 +12,7 @@ on:
 jobs:
   comment:
     runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
       - uses: actions/checkout@v2
 

.github/workflows/comment-on-pr.yaml

@@ -19,10 +19,10 @@ jobs:
         site: ['platform', 'upsun']
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set up Node.js
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: 16
         cache: 'npm'

.github/workflows/linting.yaml

@@ -24,7 +24,7 @@ jobs:
       github.event.pull_request.head.repo.id == 21975579
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Set up workflow environment to use the Platform.sh CLI
       - name: Set up Platform.sh CLI
@@ -60,7 +60,7 @@ jobs:
       github.event.pull_request.head.repo.id == 21975579
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Set up workflow environment to use the Platform.sh CLI
       - name: Set up Platform.sh CLI
@@ -79,7 +79,7 @@ jobs:
       contains(github.event.pull_request.labels.*.name, 'build-fork')
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Check if Git branch exists
         id: branch_exists

.github/workflows/manage-environment.yaml

@@ -0,0 +1,58 @@
+name: Optimize Images in PR
+on:
+  pull_request:
+    branches: [main]
+    types: [opened, reopened, synchronize]
+    paths:
+      - '**/*.png'
+      - '**/*.jpg'
+
+jobs:
+  optimize-images:
+    name: Optimize Images
+    runs-on: ubuntu-latest
+    # Run only for PRs from default repo and approved PRs from forks
+    if: github.event.pull_request.head.repo.id == 21975579 || contains(github.event.pull_request.labels.*.name, 'build-fork')
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+
+      - name: Set up environment
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y optipng jpegoptim
+
+      - name: Find changed image files
+        id: changed-files
+        uses: tj-actions/changed-files@v41
+        with:
+          files: |
+            sites/**/*.png
+            sites/**/*.jpg
+
+      - name: Run image optimization
+        if: steps.changed-files.outputs.any_changed == 'true'
+        env:
+          ALL_CHANGED_IMGS: ${{ steps.changed-files.outputs.all_changed_files }}
+        run: |
+          for file in ${ALL_CHANGED_IMGS}; do
+            if [[ "$file" == *.png ]]; then
+              optipng "$file"
+            elif [[ "$file" == *.jpg || "$file" == *.jpeg ]]; then
+              jpegoptim "$file"
+            fi
+          done
+
+      - name: Commit optimized images
+        if: steps.changed-files.outputs.any_changed == 'true'
+        env:
+          ALL_CHANGED_IMGS: ${{ steps.changed-files.outputs.all_changed_files }}
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          git add ${ALL_CHANGED_IMGS}
+          git diff --quiet && git diff --staged --quiet || git commit -m "Optimize images" -m "Automatically optimized images using optipng and jpegoptim via GitHub Actions"
+          git push 

.github/workflows/optimize-images.yaml

@@ -15,10 +15,10 @@ jobs:
     # Run only for PRs from default repo and approved PRs from forks
     if: github.event.pull_request.head.repo.id == 21975579 || contains(github.event.pull_request.labels.*.name, 'build-fork')
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 18
           cache: npm

.github/workflows/pr-check-links.yaml

@@ -124,7 +124,7 @@ jobs:
         env:
           ARTIFACT: ${{ env.artifact }}
           DOMAIN: ${{ steps.get-domain-name.outputs.domain }}
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           script: |
             const { ARTIFACT, DOMAIN } = process.env

.github/workflows/scheduled-check-links.yaml

@@ -11,3 +11,4 @@ sites/bin
 bin
 cypress/e2e/1-getting-started
 cypress/e2e/2-advanced-examples
+venv/*

.gitignore

@@ -18,7 +18,6 @@
 
     relationships:
         search: "search:http"
-        database: "db:mysql"
 
     # The hooks that will be triggered when the package is deployed.
     hooks:
@@ -40,7 +39,7 @@
     # The configuration of the application when it is exposed to the web.
     web:
         commands:
-        # Run (404) error and feedback handler
+        # Run (404) error
             start: cd $SITE_DIR && node index.js
         locations:
             '/':
@@ -54,7 +53,9 @@
                 rules:
                     \.(css|js|gif|jpe?g|png|ttf|eot|woff2?|otf|cast|mp4|json|yaml|ico|svg?|cast|mp4|json|yaml|svg?|ttf)$:
                         expires: 4w
-
+                    \.md$:
+                      headers:
+                        Content-Type: text/markdown
     disk: 1024
 
     mounts:
@@ -84,7 +85,6 @@
 
     relationships:
         search: "search:http"
-        database: "db:mysql"
 
     # The hooks that will be triggered when the package is deployed.
     hooks:
@@ -104,7 +104,7 @@
     # The configuration of the application when it is exposed to the web.
     web:
         commands:
-        # Run (404) error and feedback handler
+        # Run (404) error
             start: cd $SITE_DIR && node index.js
         locations:
             '/':

.platform/applications.yaml

@@ -1,4 +0,0 @@
-db:
-  type: mariadb:10.5
-  disk: 256
-  size: S

.platform/services.yaml

@@ -0,0 +1,3 @@
+optimize-images:
+	find sites -iname '*.png' -exec optipng {} \;
+	find sites -iname '*.jpg' -exec jpegoptim {} \;

Makefile

@@ -86,7 +86,7 @@ describe("Searches",()=>{
 
     it("Searches for something that should ONLY match on platformsh, but not on Upsun", () => {
       const searchDetails = {
-        search: '24.55',
+        search: 'DG3',
         header: 'No results',
         body: 'No documentation matched'
       }

cypress/e2e/search.cy.js

@@ -28,18 +28,46 @@ summaryLength: 3
 outputs:
     home:
       - HTML
+      - markdown
       - JSON
       - RSS
       - devcenter
+      - llms
+      - llms-full
     section:
       - HTML
+      - markdown
       - RSS
+    page:
+      - HTML
+      - markdown
 
 outputFormats:
   devcenter:
     mediaType: "application/json"
     baseName: "json/devcenter"
     isPlainText: true
+  llms:
+    mediaType: "text/plain"
+    baseName: "llms"
+    isPlainText: true
+    permalinkable: true
+  llms-full:
+    mediaType: "text/plain"
+    baseName: "llms-full"
+    isPlainText: true
+    permalinkable: true
+  markdown:
+    mediaType: "text/markdown"
+    isPlainText: true
+    permalinkable: true
+    baseName: index
+
+mediaTypes:
+  text/plain:
+    suffixes: ["txt"]
+  text/markdown:
+    suffixes: ["md"]
 
 # Math typesetting as per 0.125.0 - https://gohugo.io/content-management/mathematics/
 markup:

sites/platform/config/_default/config.yaml

@@ -107,14 +107,14 @@ nonDocsSections:
 # Metadata
 meta:
   sitename: "Platform.sh User Documentation"
-  description: Platform.sh is a second-generation Platform-as-a-Service built especially for continuous deployment. It allows you to host web applications on the cloud while making your development and testing workflows more productive.
+  description: Platform.sh is a Cloud Application Platform built especially for continuous deployment. It allows you to host web applications on the cloud while making your development and testing workflows more productive.
   image: "https://docs.platform.sh/images/logos/docs_social_2021.jpg"
   url: "https://docs.platform.sh"
   twittercard:
     card: "summary_large_image"
     site: "@platformsh"
     title: "Platform.sh User Documentation"
-    description: "Platform.sh is a second-generation Platform-as-a-Service built especially for continuous deployment. It allows you to host web applications on the cloud while making your development and testing workflows more productive."
+    description: "Platform.sh is a Cloud Application Platform built especially for continuous deployment. It allows you to host web applications on the cloud while making your development and testing workflows more productive."
     creator: "@platformsh"
     image: "https://docs.platform.sh/images/logos/docs_social_2021.jpg"
   keywords: