Merge branch 'main' into intro-page-overview

.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 orbs:
-  architect: giantswarm/[email protected].5
+  architect: giantswarm/[email protected].6
 
 jobs:
   test:

.github/workflows/merge-autogenerated-content.yml

@@ -32,11 +32,12 @@ jobs:
         do
           # Get the title of the current pull request
           CURRENT_PR_TITLE=$(gh pr view $PR -R ${{ github.repository }} --json title -q '.title')
-
+          echo "PR TITLE -> $CURRENT_PR_TITLE"
+          
           if [ "$CURRENT_PR_TITLE" = "$PR_TITLE" ]
           then
             # Merge the pull request
-            gh pr merge $PR -R ${{ github.repository }} --merge
+            gh pr merge $PR -R ${{ github.repository }} --merge --admin
             echo "Merged pull request #$PR"
             break
           fi

.github/workflows/update-changes.yml

@@ -1,4 +1,4 @@
-# This workflow, when done, is supposed to automatically update all
+# This workflow, when done, is supposed to update automatically
 # generated content in these sections:
 # - Changes and releases
 # - CRDs (Management API)
@@ -9,8 +9,8 @@ name: Update generated content
 # Trigger by cronjob
 on:
   schedule:
-    # Every hour from 7:13 to 18:13 on Monday to Friday
-    - cron: "13 7-18 * * MON-FRI"
+    # It runs at 7:00 every weekday
+    - cron: "0 7 * * MON-FRI"
   workflow_dispatch: {} # Allow manual triggering
 
 jobs:
@@ -45,6 +45,8 @@ jobs:
         with:
           title: Semi-automatic update of generated content
           branch: "automatic-update-of-generated-content"
+          assignees: taylorbot
+          reviewers: pipo02mix
           body: |
             This PR has been created automatically by the 'Update generated content' Github workflow
             to keep
@@ -56,7 +58,5 @@ jobs:
 
             up-to-date.
 
-            If you see relevant additions in the 'Files' tab, feel free to **Approve** this PR.
-
-            If not, leave the PR open. It will be updated periodically as new entries arrive in the
-            Changes and releases section or as CRD page sections are updated.
+            This PR is opened every Monday morning and merged on Friday automatically 
+            if it has not been manually merged.

.github/workflows/validate-prose.yaml

@@ -0,0 +1,33 @@
+name: Vale
+on:
+  - pull_request
+
+jobs:
+  vale:
+    name: vale
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # v4.1.3
+
+      - name: Execute Vale
+        run: |
+          wget -q https://github.com/errata-ai/vale/releases/download/v3.4.1/vale_3.4.1_Linux_64-bit.tar.gz
+          mkdir bin && tar -xvzf vale_3.4.1_Linux_64-bit.tar.gz -C bin
+          ls -la bin
+          bin/vale --config=./.vale.ini \
+            --glob '!{src/content/vintage/**,src/content/changes/**}' \
+            --no-exit \
+            --output ./.vale/styles/rdjsonl.tmpl \
+            src/content > out.jsonl
+
+      - name: Install reviewdog
+        uses: reviewdog/action-setup@3f401fe1d58fe77e10d665ab713057375e39b887 # v1.3.0
+        with:
+          reviewdog_version: latest
+
+      - name: Create annotations on touched files
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          reviewdog -f=rdjsonl -name=Vale -reporter=github-pr-annotations -fail-on-error=true -filter-mode=added -level=info < out.jsonl

.vale.ini

@@ -0,0 +1,12 @@
+StylesPath = .vale/styles
+
+Vocab = docs
+
+Packages = Hugo, Microsoft
+
+[*.md]
+MinAlertLevel = suggestion
+BasedOnStyles = Vale, Microsoft
+
+# Microsoft.We disallows the use of "we" or "us". We are using this in many places for now.
+Microsoft.We = NO

.vale/styles/.vale-config/0-Hugo.ini

@@ -0,0 +1,10 @@
+[*.md]
+# Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}})
+TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \
+(\[.+\]\({{< .+ >}}\)), \
+[^\S\r\n]({{[%<] \w+ .+ [%>]}})\s, \
+[^\S\r\n]({{[%<](?:/\*) .* (?:\*/)[%>]}})\s
+
+# Exclude `{{<  myshortcode `This is some <b>HTML</b>, ... >}}`
+BlockIgnores = (?sm)^({{[%<] \w+ [^{]*?\s[%>]}})\n$, \
+(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}})

.vale/styles/Microsoft/AMPM.yml

@@ -0,0 +1,9 @@
+extends: existence
+message: Use 'AM' or 'PM' (preceded by a space).
+link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms
+level: error
+nonword: true
+tokens:
+  - '\d{1,2}[AP]M'
+  - '\d{1,2} ?[ap]m'
+  - '\d{1,2} ?[aApP]\.[mM]\.'

.vale/styles/Microsoft/Accessibility.yml

@@ -0,0 +1,30 @@
+extends: existence
+message: "Don't use language (such as '%s') that defines people by their disability."
+link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms
+level: suggestion
+ignorecase: true
+tokens:
+  - a victim of
+  - able-bodied
+  - an epileptic
+  - birth defect
+  - crippled
+  - differently abled
+  - disabled
+  - dumb
+  - handicapped
+  - handicaps
+  - healthy person
+  - hearing-impaired
+  - lame
+  - maimed
+  - mentally handicapped
+  - missing a limb
+  - mute
+  - non-verbal
+  - normal person
+  - sight-impaired
+  - slow learner
+  - stricken with
+  - suffers from
+  - vision-impaired

.vale/styles/Microsoft/Acronyms.yml

@@ -0,0 +1,64 @@
+extends: conditional
+message: "'%s' has no definition."
+link: https://docs.microsoft.com/en-us/style-guide/acronyms
+level: suggestion
+ignorecase: false
+# Ensures that the existence of 'first' implies the existence of 'second'.
+first: '\b([A-Z]{3,5})\b'
+second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
+# ... with the exception of these:
+exceptions:
+  - API
+  - ASP
+  - CLI
+  - CPU
+  - CSS
+  - CSV
+  - DEBUG
+  - DOM
+  - DPI
+  - FAQ
+  - GCC
+  - GDB
+  - GET
+  - GPU
+  - GTK
+  - GUI
+  - HTML
+  - HTTP
+  - HTTPS
+  - IDE
+  - JAR
+  - JSON
+  - JSX
+  - LESS
+  - LLDB
+  - NET
+  - NOTE
+  - NVDA
+  - OSS
+  - PATH
+  - PDF
+  - PHP
+  - POST
+  - RAM
+  - REPL
+  - RSA
+  - SCM
+  - SCSS
+  - SDK
+  - SQL
+  - SSH
+  - SSL
+  - SVG
+  - TBD
+  - TCP
+  - TODO
+  - URI
+  - URL
+  - USB
+  - UTF
+  - XML
+  - XSS
+  - YAML
+  - ZIP