Spellcheck documentation changes in PRs (#3281)

Author: schmittjoseph

Diff for: .github/workflows/spellcheck.yml

@@ -0,0 +1,23 @@
+name: 'Documentation spellcheck'
+on:
+  pull_request:
+    paths: ['**/*.md']
+
+permissions:
+  pull-requests: read
+
+jobs:
+  spellcheck:
+    name: 'Documentation spellcheck'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - uses: streetsidesoftware/cspell-action@v2
+        name: Spellcheck
+        with:
+            files: '**/*.md'
+            inline: warning
+            incremental_files_only: true

Diff for: .github/workflows/sync-branches.yml

@@ -34,6 +34,7 @@ jobs:
             ".devcontainer" \
             ".vscode" \
             "eng/actions" \
+            "cspell.json" \
             "documentation/**.md"
 
       - name: Open PR

Diff for: .vscode/settings.json

@@ -35,5 +35,11 @@
     // ms-vscode.powershell settings
     "powershell.promptToUpdatePowerShell": false,
     "powershell.integratedConsole.showOnStartup": false,
-    "powershell.startAutomatically": false
+    "powershell.startAutomatically": false,
+
+    // streetsidesoftware.code-spell-checker
+
+    // Increase the text buffer size to 1000 characters instead of the default of 500.
+    // Parts of our documentation include large text blobs, such as examples of public keys.
+    "cSpell.blockCheckingWhenTextChunkSizeGreaterThan": 1000
 }

Diff for: CONTRIBUTING.md

@@ -19,7 +19,7 @@ Good bug reports make it easier for maintainers to verify and root cause the und
 * A high-level description of the problem.
 * A _minimal reproduction_, i.e. the smallest size of code/configuration required to reproduce the wrong behavior.
 * A description of the _expected behavior_, contrasted with the _actual behavior_ observed.
-* Information on the environment: OS/distro, CPU arch, SDK version, etc.
+* Information on the environment: OS/distribution, CPU arch, SDK version, etc.
 * Additional information, e.g. is it a regression from previous versions? are there any known workarounds?
 
 ### DOs and DON'Ts
@@ -53,7 +53,7 @@ We use and recommend the following workflow:
     - Clearly state that you are going to take on implementing it, if that's the case. You can request that the issue be assigned to you. Note: The issue filer and the implementer don't have to be the same person.
 2. Create a personal fork of the repository on GitHub (if you don't already have one).
 3. In your fork, create a branch off of main (`git checkout -b mybranch`).
-    - Name the branch so that it clearly communicates your intentions, such as issue-123 or githubhandle-issue.
+    - Name the branch so that it clearly communicates your intentions, such as `issue-123` or `githubhandle-issue`.
     - Branches are useful since they isolate your changes from incoming changes from upstream. They also enable you to create multiple PRs from the same fork.
 4. Make and commit your changes to your branch.
 5. Add new tests corresponding to your change, if applicable.

Diff for: cspell.json

@@ -0,0 +1,51 @@
+{
+    "version": "0.2",
+    "words": [
+        "callstacks",
+        "CLSID",
+        "codespace",
+        "coreclr",
+        "darc",
+        "discoverability",
+        "dockerfiles",
+        "ESRP",
+        "exfiltrate",
+        "gcdump",
+        "gcdumps",
+        "globbing",
+        "globstar",
+        "JWTs",
+        "libc",
+        "livemetrics",
+        "minidump",
+        "MSRC",
+        "newtonsoft",
+        "respecifying",
+        "runtimes",
+        "speedscope",
+        "threadpool",
+        "upvoting",
+        "walkthroughs"
+    ],
+    "patterns": [
+        {
+            "name": "markdown_code_block",
+            "pattern": "/^(\\s*`{3,}).*[^```]*?^\\1/gmx"
+        },
+        {
+            "name": "markdown_inline_code",
+            "pattern": "/`[^`\\n\\r]*`/gmx"
+        }
+    ],
+    "languageSettings": [
+        {
+            "languageId": [
+                "markdown"
+            ],
+            "ignoreRegExpList": [
+                "markdown_code_block",
+                "markdown_inline_code"
+            ]
+        }
+    ]
+}

Diff for: documentation/api/definitions.md

@@ -348,7 +348,7 @@ Summary state of an operation.
 
 ## ProcessIdentifier
 
-Object with process identifying information. The properties on this object describe indentifying aspects for a found process; these values can be used in other API calls to perform operations on specific processes.
+Object with process identifying information. The properties on this object describe identifying aspects for a found process; these values can be used in other API calls to perform operations on specific processes.
 
 | Name | Type | Description |
 |---|---|---|
@@ -373,7 +373,7 @@ The `name` property may not be a unique identifier if the application was built
 
 Object with detailed information about a specific process.
 
-Some properties will have non-null values for procesess that are running on .NET 5 or newer (denoted with `.NET 5+`). These properties will be null for runtime versions prior to .NET 5.
+Some properties will have non-null values for processes that are running on .NET 5 or newer (denoted with `.NET 5+`). These properties will be null for runtime versions prior to .NET 5.
 
 | Name | Type | Description |
 |---|---|---|

Diff for: documentation/api/operations.md

@@ -3,7 +3,7 @@
 
 # Operations
 
-Operations are used to track long running operations in dotnet-monitor, specifically egressing data via egressProviders instead of directly to the client. This api is very similiar to [Azure asynchronous operations](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/async-operations#url-to-monitor-status).
+Operations are used to track long running operations in dotnet-monitor, specifically egressing data via egressProviders instead of directly to the client. This api is very similar to [Azure asynchronous operations](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/async-operations#url-to-monitor-status).
 
 | Operation | Description |
 |---|---|

Diff for: documentation/configuration.md

@@ -448,7 +448,7 @@ Optionally, a shorthand format allows you to omit the `Key` and `Value` terms an
 
 ### Examples
 
-#### Match the iisexpress process by name
+#### Match the IIS Express process by name
 
 <details>
   <summary>JSON</summary>
@@ -485,7 +485,7 @@ Optionally, a shorthand format allows you to omit the `Key` and `Value` terms an
   ```
 </details>
 
-#### Match the iisexpress process by name (Shorthand)
+#### Match the IIS Express process by name (Shorthand)
 
 <details>
   <summary>JSON</summary>
@@ -985,7 +985,7 @@ The Queue Message's payload will be the blob name (`<BlobPrefix>/<ArtifactName>`
   --from-literal=Egress__S3Storage__monitorS3Blob__secretAccessKey=mySecretPassword \
   --from-literal=Egress__S3Storage__monitorS3Blob__regionName=us-east-1 \
   --dry-run=client -o yaml | kubectl apply -f -
- ```
+  ```
 </details>
 
 ### Filesystem egress provider
@@ -1143,7 +1143,7 @@ Each collection rule can specify a set of process filters to select which proces
 
 #### Example
 
-The following example shows the `Filters` portion of a collection rule that has the rule only apply to processes named "dotnet" and whose command line contains "myapp.dll".
+The following example shows the `Filters` portion of a collection rule that has the rule only apply to processes named `dotnet` and whose command line contains `myapp.dll`.
 
 <details>
   <summary>JSON</summary>
@@ -1256,7 +1256,7 @@ A trigger that has its condition satisfied when the number of HTTP requests have
 | Name | Type | Required | Description | Default Value | Min Value | Max Value |
 |---|---|---|---|---|---|---|
 | `RequestCount` | int | true | The threshold of the number of slow requests that start within the sliding window of time. | | | |
-| `RequestDuration` | Timespan? | false | The threshold of the amount of time in which a request is considered to be slow. | `"00:00:05"` (5 seconds) | `"00:00:00"` (zero seconds) | `"01:00:00"` (1 hour) |
+| `RequestDuration` | TimeSpan? | false | The threshold of the amount of time in which a request is considered to be slow. | `"00:00:05"` (5 seconds) | `"00:00:00"` (zero seconds) | `"01:00:00"` (1 hour) |
 | `SlidingWindowDuration` | TimeSpan? | false | The sliding time window in which the the number of slow requests are counted. | `"00:01:00"` (one minute) | `"00:00:01"` (one second) | `"1.00:00:00"` (1 day) |
 | `IncludePaths` | string[] | false | The list of request path patterns to monitor. If not specified, all request paths are considered. If specified, only request paths matching one of the patterns in this list will be considered. Request paths matching a pattern in the `ExcludePaths` list will be ignored. | `null` | | |
 | `ExcludePaths` | string[] | false | The list of request path patterns to ignore. Request paths matching a pattern in this list will be ignored. | `null` | | |
@@ -1430,7 +1430,7 @@ These [trigger shortcuts](collectionrules/triggershortcuts.md) simplify configur
 
 #### ASP.NET Request Path Wildcards and Globbing
 
-The `IncludePaths` and `ExcludePaths` properties of the ASP.NET triggers allow for wildcards and globbing so that every included or excluded path does not necessarily need to be explicitly specified. For these triggers, a match with an `ExcludePaths` pattern will supercede a match with an `IncludePaths` pattern.
+The `IncludePaths` and `ExcludePaths` properties of the ASP.NET triggers allow for wildcards and globbing so that every included or excluded path does not necessarily need to be explicitly specified. For these triggers, a match with an `ExcludePaths` pattern will supersede a match with an `IncludePaths` pattern.
 
 The globstar `**/` will match zero or more path segments including the forward slash `/` character at the end of the segment.
 
@@ -1780,7 +1780,7 @@ An action that executes an executable found in the file system. Non-zero exit co
 
 ##### Example
 
-Usage that executes a .NET executable named "myapp.dll" using `dotnet`.
+Usage that executes a .NET executable named `myapp.dll` using `dotnet`.
 
 <details>
   <summary>JSON</summary>
@@ -1843,7 +1843,7 @@ No outputs
 
 ##### Example
 
-Usage that loads one of the sample profilers from [`dotnet/runtime`: src/tests/profiler/native/gcallocateprofiler/gcallocateprofiler.cpp](https://github.com/dotnet/runtime/blob/9ddd58a58d14a7bec5ed6eb777c6703c48aca15d/src/tests/profiler/native/gcallocateprofiler/gcallocateprofiler.cpp).
+Usage that loads one of the sample profilers from [`dotnet/runtime: src/tests/profiler/native/gcallocateprofiler/gcallocateprofiler.cpp`](https://github.com/dotnet/runtime/blob/9ddd58a58d14a7bec5ed6eb777c6703c48aca15d/src/tests/profiler/native/gcallocateprofiler/gcallocateprofiler.cpp).
 
 <details>
   <summary>JSON</summary>

Diff for: documentation/release-process.md

@@ -105,8 +105,8 @@ The remainder of the release will automatically push NuGet packages to nuget.org
 
 ## Release to Storage Accounts
 
-1. Approximately 3 days before Docker image release, execute a dry-run of the [dotnet-monitor-release](https://dev.azure.com/dnceng/internal/_build?definitionId=1103) pipeline (`Branch` should be set to `main`; `IsDryRun` should be checked; uncheck `IsTestRun`; under `Resources`, select the `dotnet monitor` build from which assets will be published). This will validate that the nupkg files can be published to the `dotnetcli` storage account and checksums can be published to the `dotnetclichecksums` storage account.
-1. The day before Docker image release, execute run of the [dotnet-monitor-release](https://dev.azure.com/dnceng/internal/_build?definitionId=1103) pipeline (`Branch` should be set to `main`; uncheck `IsDryRun`; uncheck `IsTestRun`; under `Resources`, select the `dotnet monitor` build from which assets will be published). This will publish the nupkg files to the `dotnetcli` storage account and the checksums to the `dotnetclichecksums` storage account.
+1. Approximately 3 days before Docker image release, execute a dry-run of the [dotnet-monitor-release](https://dev.azure.com/dnceng/internal/_build?definitionId=1103) pipeline (`Branch` should be set to `main`; `IsDryRun` should be checked; uncheck `IsTestRun`; under `Resources`, select the `dotnet monitor` build from which assets will be published). This will validate that the `.nupkg` files can be published to the `dotnetcli` storage account and checksums can be published to the `dotnetclichecksums` storage account.
+1. The day before Docker image release, execute run of the [dotnet-monitor-release](https://dev.azure.com/dnceng/internal/_build?definitionId=1103) pipeline (`Branch` should be set to `main`; uncheck `IsDryRun`; uncheck `IsTestRun`; under `Resources`, select the `dotnet monitor` build from which assets will be published). This will publish the `.nupkg` files to the `dotnetcli` storage account and the checksums to the `dotnetclichecksums` storage account.
 
 ## Release Docker Images
 

Diff for: documentation/releaseNotes/README.md

@@ -2,7 +2,7 @@
 This folder contains the release notes that appear here: [https://github.com/dotnet/dotnet-monitor/releases](https://github.com/dotnet/dotnet-monitor/releases).
 
 ## Creation
-Release notes can be created by running the [Generate release notes](https://github.com/dotnet/dotnet-monitor/actions/workflows/generate-release-notes.yml) workflow. This workflow will generate release notes for a given branch, corretly name it according to the format described in [File Naming](#file-naming), and open a PR with the new file.
+Release notes can be created by running the [Generate release notes](https://github.com/dotnet/dotnet-monitor/actions/workflows/generate-release-notes.yml) workflow. This workflow will generate release notes for a given branch, correctly name it according to the format described in [File Naming](#file-naming), and open a PR with the new file.
 
 ## File Naming
 Release notes are named in the format `releaseNotes.v[fullVersionNumber].md` for a released version. This is set to archive release notes from a version that has been released. `fullVersionNumber` should be the version assigned on the github release page, for example `releaseNotes.v5.0.0-preview.6.21370.3.md` would be the name of the 5.0 Preview 6 release notes (if they were archived).

Diff for: documentation/releaseNotes/releaseNotes.v6.0.0-preview.8.21503.3.md

@@ -5,7 +5,7 @@ Today we are releasing the next official preview of the `dotnet-monitor` tool. T
 - Updated process detection to cancel waiting on unresponsive processes.
 - Documented recommended container limits. See [Running in Kubernetes](https://github.com/dotnet/dotnet-monitor/blob/v6.0.0-preview.8.21503.3/documentation/kubernetes.md) for more details.
 - ⚠️ Upgraded runtime framework dependency from .NET Core 3.1 to .NET 6
-- ⚠️ Reversioned from 5.0.0 to 6.0.0
+- ⚠️ Re-versioned from 5.0.0 to 6.0.0
 - ⚠️ Fix all counter intervals to single global option (#923)
 
 \*⚠️ **_indicates a breaking change_**

Diff for: documentation/releaseNotes/releaseNotes.v6.0.2.md

@@ -2,6 +2,6 @@ Today we are releasing the 6.0.2 build of the `dotnet-monitor` tool. This releas
 
 - Ensure dump folder exists before capturing dump (#1216)
 - Ensure `config show` command completely writes end of configuration (#1112)
-- Allow command line parameters to be overriden by file-based configuration (#1102)
-- Allow command line parameters to be overriden by environment variables (#1398)
+- Allow command line parameters to be overridden by file-based configuration (#1102)
+- Allow command line parameters to be overridden by environment variables (#1398)
 - Fix `generatekey` command `output` parameter description (#1119)

Diff for: dotnet-monitor.yml

@@ -14,6 +14,7 @@ pr:
     - .github
     - .vscode
     - .gitignore
+    - cspell.json
     - eng/actions
     - '**.md'