Merge branch 'main' into heiskr-patch-1

Author: heiskr

.github/workflows/60-days-stale-check.yml

@@ -1,4 +1,9 @@
 name: 60 Days Stale Check
+
+# **What it does**: Pull requests older than 60 days will be flagged as stale.
+# **Why we have it**: We want to manage our queue of issues and pull requests.
+# **Who does it impact**: Everyone that works on docs or docs-internal.
+
 on:
   schedule:
     - cron: '40 16 * * *' # Run each day at 16:40 UTC / 8:40 PST

.github/workflows/auto-label-prs.yml

@@ -1,5 +1,9 @@
 name: Auto label Pull Requests
 
+# **What it does**: Automatically adds the engineering label when specific files change.
+# **Why we have it**: Other automation applies specifically to engineering label issues and pull requests.
+# **Who does it impact**: Automation that relies on the engineering label.
+
 on:
   pull_request:
 

.github/workflows/automerge-dependencies.yml

@@ -1,5 +1,9 @@
 name: Auto Merge Dependency Updates
 
+# **What it does**: Automatically merge pull requests from dependabot.
+# **Why we have it**: To keep our dependencies up-to-date, to avoid security issues.
+# **Who does it impact**: It helps docs engineering focus on higher value work.
+
 on:
   pull_request:
     paths:

.github/workflows/automerge.yml

@@ -1,4 +1,9 @@
 name: automerge
+
+# **What it does**: Pull requests with label "automerge" or "autosquash" will automatically merge.
+# **Why we have it**: While now this is a feature built into GitHub, we still use it as part of other automation.
+# **Who does it impact**: Any workflows that depend on automerge or autosquash labels.
+
 on:
   pull_request:
     types:

.github/workflows/autoupdate-branch.yml

@@ -1,5 +1,9 @@
 name: autoupdate branch
 
+# **What it does**: Any pull requests with "autoupdate" label will get main branch updates.
+# **Why we have it**: Our repo-sync automation relies on it.
+# **Who does it impact**: Our ability to support the open-source repository.
+
 #
 # This workflow checks all open PRs targeting `main` as their base branch and
 # will attempt to update them if they have the `autoupdate` label applied.

.github/workflows/browser-test.yml

@@ -1,5 +1,9 @@
 name: Browser Tests
 
+# **What it does**: This runs our browser tests on pull requests.
+# **Why we have it**: This is the only way we currently test our browser JavaScript.
+# **Who does it impact**: Docs engineering, open-source engineering contributors.
+
 on:
   workflow_dispatch:
   push:

.github/workflows/build-docker-image.yml

@@ -1,7 +1,9 @@
-# Make sure the Docker container still builds
-
 name: Build Docker image
 
+# **What it does**: This builds our Docker container.
+# **Why we have it**: We don't use the Docker container internally, but other teams depend on our Docker container.
+# **Who does it impact**: Enterprise customers.
+
 on:
   push:
     branches:

.github/workflows/check-all-english-links.yml

@@ -1,5 +1,9 @@
 name: Check all English links
 
+# **What it does**: This script once a day checks all English links and reports in issues.
+# **Why we have it**: We want to know if any links break.
+# **Who does it impact**: Docs content.
+
 on:
   workflow_dispatch:
   schedule:

.github/workflows/check-for-spammy-issues.yml

@@ -1,4 +1,9 @@
 name: Check for Spammy Issues
+
+# **What it does**: This action closes low value pull requests in the open-source repository.
+# **Why we have it**: We get lots of spam in the open-source repository.
+# **Who does it impact**: Open-source contributors.
+
 on:
   issues:
     types: [opened]
@@ -32,7 +37,7 @@ jobs:
               return
             } catch(err) {
               // An error will be thrown if the user is not a GitHub employee
-              // If a user is not a GitHub employee, we should check to see if title has at least the minimum required number of words in it and if it does, we can exit the workflow 
+              // If a user is not a GitHub employee, we should check to see if title has at least the minimum required number of words in it and if it does, we can exit the workflow
 
               if(titleWordCount > titleWordCountMin) {
                 return
@@ -42,7 +47,7 @@ jobs:
             //
             // Assuming the user is not a GitHub employee and the issue title
             // has the minimum number of words required, proceed.
-            // 
+            //
 
             // Close the issue and add the invalid label
             await github.issues.update({

.github/workflows/close-external-repo-sync-prs.yml

@@ -1,5 +1,9 @@
 name: Check for External Repo Sync PR
 
+# **What it does**: If someone made a repo sync pull request other than Octomerger, close it.
+# **Why we have it**: Another form of spam in the open-source repository.
+# **Who does it impact**: Open-source contributors.
+
 on:
   pull_request:
     types: