Merge branch 'main' into sections-pr

Author: iOvergaard

.github/lychee.toml

@@ -0,0 +1,80 @@
+# .github/lychee.toml
+
+############################# Display #############################
+# Verbose program output
+# Accepts log level: "error", "warn", "info", "debug", "trace"
+verbose = "info"
+
+# Don't show interactive progress bar while checking links.
+no_progress = true
+
+############################# Cache ###############################
+# Enable link caching. This can be helpful to avoid checking the same links on
+# multiple runs.
+cache = false
+
+############################# Runtime #############################
+# Maximum number of concurrent link checks.
+max_concurrency = 12
+
+# Maximum number of allowed redirects.
+max_redirects = 5
+
+# Maximum number of allowed retries before a link is declared dead.
+max_retries = 1
+
+############################# Requests ############################
+# Website timeout from connect to response finished.
+timeout = 10
+
+# Minimum wait time in seconds between retries of failed requests.
+retry_wait_time = 1
+
+# Accept more status codes (follow redirects automatically)
+accept = ["200..=204", "301..=308", "429"]
+
+# Avoid false fragment errors
+include_fragments = false  
+
+# Only test links with the given schemes (e.g. https).
+# Omit to check links with any other scheme.
+# At the moment, we support http, https, file, and mailto.
+scheme = ["https"]
+
+# When links are available using HTTPS, treat HTTP links as errors.
+require_https = false
+
+# Fallback extensions to apply when a URL does not specify one.
+# This is common in documentation tools that cross-reference files without extensions.
+fallback_extensions = ["md", "html"]
+
+############################# Exclusions ##########################
+# Exclude URLs and mail addresses from checking (supports regex).
+exclude = [
+  '^mailto:',
+  '^https?://localhost',
+  '^https?://127\\.0\\.0\\.1',
+  '^https://www\.linkedin\.com',
+  '^https?://issues\.umbraco\.org/',
+  '^https?://web\\.archive\\.org/web/'
+]
+
+# Exclude these filesystem paths from getting checked.
+exclude_path = [
+  '(^|/)node_modules/',
+  '(^|/)dist/',
+  '(^|/)bin/',
+  '\\.txt$',      # skip .txt extensions
+  '(^|/)test/'   # skip directories named "test"
+]
+
+# URLs to check (supports regex). Has preference over all excludes.
+include = ['gist\.github\.com.*']
+
+# Skip checking mail addresses
+include_mail = true
+
+############################# Content Checks ######################
+# Mark pages as broken if the body contains "page not found" or "404"
+[content]
+deny = ["(?i)page not found", "(?i)404"]

.github/styles/UmbracoDocs/Acronyms.yml

@@ -26,6 +26,7 @@ exceptions:
   - CDN      # Content Delivery Network
   - CI       # Continuous Integration
   - CLI      # Command Line Interface
+  - CNAME    # 
   - CMD      # Command (Windows shell)
   - CMS      # Content Management System
   - CPU      # Central Processing Unit
@@ -115,6 +116,7 @@ exceptions:
   - VAL      # 
   - VAT      # Value-Added Tax
   - VIP      # Very Important Person
+  - WAF      # Web Application Firewall
   - WYSIWYG  # What You See Is What You Get
   - XML      # Extensible Markup Language
   - XSLT     # Extensible Stylesheet Language Transformations

.github/styles/UmbracoDocs/LinkTextClarity.yml

@@ -5,5 +5,11 @@ description: >
   Descriptive link text improves accessibility and SEO by clearly indicating
   where the link leads, rather than using vague terms.
 level: warning
-raw:
-  - '(?i)\[(?:click here|here)\]\([^)]*\)'
+ignorecase: true
+scope: raw
+nonword: true
+tokens:
+  - '\[\s*here\s*\]'
+  - '\[\s*click here\s*\]'
+  - '\[\s*read more\s*\]'
+  - '\[\s*more info\s*\]'

.github/workflows/check-broken-pr-links.yml

@@ -0,0 +1,124 @@
+name: Check Links in Pull Requests
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**/*.md'
+
+jobs:
+  check-links:
+    runs-on: ubuntu-latest
+
+    steps:
+      # 1️⃣ Checkout repository
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # 2️⃣ Get changed Markdown files in the PR
+      - name: Get changed Markdown files
+        id: changed-files
+        run: |
+          CHANGED_FILES=$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep '\.md$' || true)
+          CHANGED_FILES="${CHANGED_FILES//$'\n'/ }"
+          echo "CHANGED_FILES=$CHANGED_FILES" >> $GITHUB_ENV
+          echo "Changed Markdown files: $CHANGED_FILES"
+
+      # 3️⃣ Skip if no Markdown files changed
+      - name: Skip if no Markdown files changed
+        if: env.CHANGED_FILES == ''
+        run: |
+          echo "No Markdown files changed. Skipping link check."
+          exit 0
+
+      # 4️⃣ Run Lychee on changed files
+      - name: Run Lychee
+        id: run-lychee
+        uses: lycheeverse/lychee-action@v2
+        with:
+          args: |
+            --no-progress
+            --include-fragments
+            --format detailed
+            ${{ env.CHANGED_FILES }}
+          output: lychee/out_raw.md
+          fail: false  # ✅ don't fail yet, let us capture output
+
+      # 5️⃣ Format Lychee output (user-friendly, relative paths)
+      - name: Format Lychee report
+        id: format-report
+        if: always()
+        run: |
+          mkdir -p lychee
+          : > lychee/comment.md   # start with empty file
+      
+          awk '
+            /^Errors in / {
+              file=$3
+              gsub("^/home/runner/work/UmbracoDocs/UmbracoDocs/", "", file)
+              print "\nBroken links found in:\n" file >> "lychee/comment.md"
+              next
+            }
+
+            /\[ERROR\]/ {
+              msg = $0
+              sub(/^- \[ \] /, "", msg)
+              sub(/^\[ERROR\] /, "", msg)
+              gsub("^file:///home/runner/work/UmbracoDocs/UmbracoDocs/", "", msg)
+              gsub(/\|/, "\\|", msg)   # escape Markdown pipe
+              print "\n⚓ Anchor not found → " msg "\n" >> "lychee/comment.md"
+              next
+            }
+
+            /\[404\]/ {
+              msg = $0
+              sub(/^- \[ \] /, "", msg)
+              sub(/^\[404\] /, "", msg)
+              gsub(/\|/, "\\|", msg)   # escape pipe
+              print "\n❌ 404 Not Found → " msg "\n" >> "lychee/comment.md"
+              next
+            }
+
+            /\[301\]|\[302\]/ {
+              msg = $0
+              sub(/^- \[ \] /, "", msg)
+              sub(/^\[(301|302)\] /, "", msg)
+              gsub(/\|/, "\\|", msg)   # escape pipe
+              print "\n🔀 Redirect → " msg "\n" >> "lychee/comment.md"
+              next
+            }
+
+            /Timeout/ && !/Timeouts/ {
+              msg = $0
+              sub(/^- \[ \] /, "", msg)
+              gsub(/\|/, "\\|", msg)   # escape pipe just in case
+              print "\n⏳ Timeout → " msg "\n" >> "lychee/comment.md"
+              next
+            }
+          ' lychee/out_raw.md
+      
+          # Add header only if we found content
+          if [ -s lychee/comment.md ]; then
+            sed -i '1i **The Link Checker found broken links in your PR**.\n Please review the following list:\n' lychee/comment.md
+            echo "has_content=true" >> $GITHUB_OUTPUT
+          else
+            echo "has_content=false" >> $GITHUB_OUTPUT
+          fi
+
+      # 6️⃣ Comment broken links on PR (if present)
+      - name: Comment broken links
+        if: always() && (env.CHANGED_FILES != '') && (steps.format-report.outputs.has_content == 'true')
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          path: lychee/comment.md
+          recreate: true
+
+      # 7️⃣ Fail workflow if broken links exist
+      - name: Fail workflow if broken links
+        if: steps.format-report.outputs.has_content == 'true'
+        run: |
+          echo "❌ Broken links detected. Please review the PR comment for details."
+          exit 1

.gitignore

@@ -4,3 +4,4 @@
 *.orig
 .vscode
 .idea
+.lycheecache

.lycheeignore

@@ -0,0 +1,32 @@
+# These links are ignored by lychee link checker: https://github.com/lycheeverse/lychee
+# The file allows you to list multiple regular expressions for exclusion (one pattern per line).
+# The `.lycheeignore` file is only used for excluding URLs, not paths. Use the `exclude_path` key in the `lychee.toml` file. ref: https://lychee.cli.rs/recipes/excluding-paths/
+
+# GitHub blob/tree fragment links
+^https://github\.com/umbraco/Umbraco-CMS/blob/.*/.*#L.*
+^https://github\.com/umbraco/Umbraco-CMS/tree/.*
+^https://github\.com/Shazwazza/Articulate/blob/.*/.*#L.*
+^https://github\.com/umbraco/Umbraco-CMS/blob/.*
+^https://github\.com/.*/issues/[0-9]+#issuecomment-[0-9]+
+
+# Anchor/fragment links causing false positives
+^https://apidocs\.umbraco\.com/.*/#.*
+^https://tinymce\.github\.io/.*/#.*
+^https://openid\.net/.*/#.*
+^https://docs\.microsoft\.com/.*#.*
+^https://learn\.microsoft\.com/.*#.*
+^https://developer\.mozilla\.org/.*/#.*
+^https://learning\.postman\.com/docs/.*/#.*
+^https://nginx\.org/.*/#.*
+^https://azure\.microsoft\.com/en-gb/services/media-services/.*
+^https://www\.tiny\.cloud/docs/.*
+
+# TinyMCE anchors
+^https://github\.com/tinymce/tinymce/issues/.*#.*
+
+# NIST FIPS and other static docs
+^https://csrc\.nist\.gov/publications/PubsFIPS\.html#.*
+
+# Timeout-prone Umbraco issue links
+^https://issues\.umbraco\.org/issue/.*
+^https://issues\.umbraco\.org/issues/.*

10/umbraco-cms/extending/filesystemproviders/README.md

@@ -215,7 +215,7 @@ namespace UmbracoExamples.Composition
                 var path = settings.UmbracoCssPath;
                 var rootPath = hostingEnvironment.MapPathWebRoot(path);
                 var rootUrl = hostingEnvironment.ToAbsolute(path);
-                var fileSystem = new YourFileSystemImplementaion(ioHelper, hostingEnvironment, logger, rootPath, rootUrl);
+                var fileSystem = new YourFileSystemImplementation(ioHelper, hostingEnvironment, logger, rootPath, rootUrl);
 
                 systems.SetStylesheetFilesystem(fileSystem);
             });

10/umbraco-cms/extending/filesystemproviders/azure-blob-storage.md

@@ -77,7 +77,7 @@ You can get your connection string from your Azure Portal under "Access Keys".
 
 You're almost there. The last step is to set up the required services and middleware. This may sound daunting, but thankfully there are extension methods that do all this for you. All you need to do is invoke them in the `ConfigureServices` and `Configure` methods in the `startup.cs` file.
 
-Invoke the `.AddAzureBlobMediaFileSystem()` extention method in the `ConfigureServices` method:
+Invoke the `.AddAzureBlobMediaFileSystem()` extension method in the `ConfigureServices` method:
 
 ```C#
         public void ConfigureServices(IServiceCollection services)

10/umbraco-cms/extending/health-check/README.md

@@ -37,7 +37,7 @@ Umbraco comes with the following checks by default:
   * **HTTPS Configuration (id: `EB66BB3B-1BCD-4314-9531-9DA2C1D6D9A7`)** - to determine if the current site is running on a secure connection
   * **UseHttps check** - when the site is running on HTTPS, `Umbraco.Cms.Core.Configuration.Models.GlobalSettings.UseHttps` needs to be enabled to secure the backoffice. The setting can be found under `Umbraco:CMS:Global` in the `appsettings.json` file
 * Category **Services**
-  * **SMTP Settings (id: `1B5D221B-CE99-4193-97CB-5F3261EC73DF`)** - checks that an Simple Mail Tranfer Protocol (SMTP) server is configured and is accepting requests for sending emails
+  * **SMTP Settings (id: `1B5D221B-CE99-4193-97CB-5F3261EC73DF`)** - checks that an Simple Mail Transfer Protocol (SMTP) server is configured and is accepting requests for sending emails
 
 Each check returns a message indicating whether or not the issue in question has been found on the website installation. This could be an error that should be fixed, or a warning you should be aware of.
 

10/umbraco-cms/extending/packages/good-practice-and-defaults.md

@@ -32,7 +32,7 @@ When you have a package that contains many views you might consider building a d
 
 ## License files
 
-Umbraco products store their licenses in `/umbraco/Licences`. It is recommended for third-party packages that require license files to also store their license files in this location.
+Umbraco products store their licenses in `/umbraco/Licenses`. It is recommended for third-party packages that require license files to also store their license files in this location.
 
 The default `.gitignore` for Umbraco templates will include any files in the `/Licenses` folder while ignoring most of the rest of the Umbraco folder.