Add spell checker (#1667)

- Add a spell checker for Markdown files.
- Fix various typos found by the linter (or change wording to "fix" them).

Resolves #1639.

.github/spellcheck.yml

@@ -0,0 +1,30 @@
+matrix:
+- name: Markdown
+  aspell:
+    ignore-case: true
+    lang: en
+  dictionary:
+    encoding: utf-8
+    wordlists:
+      - .github/wordlist.txt
+  pipeline:
+    - pyspelling.filters.url:
+    - pyspelling.filters.markdown:
+        markdown_extensions:
+          - markdown.extensions.extra
+          - pymdownx.superfences
+    - pyspelling.filters.context:
+        context_visible_first: true
+        escapes: \\[\\`~]
+        delimiters:
+        # Ignore text between inline back ticks
+        - open: '(?P<open>`+)'
+          close: '(?P=open)'
+    - pyspelling.filters.html:
+        comments: false
+        ignores:
+          - code
+          - pre
+  sources:
+    - '!CHANGELOG.md|!**/BenchmarkDotNet.Artifacts/**/*.md|!docs/community/resources.md|!docs/community/libraries-and-contributions.md|**/*.md'
+  default_encoding: utf-8

.github/wordlist.txt

@@ -0,0 +1,63 @@
+alloc
+apis
+async
+azurefunctions
+bcl
+bdd
+cancellable
+changelog
+circuitbreaker
+comparer
+contrib
+deserialization
+dotnet
+dotnetrocks
+durations
+eshoponcontainers
+extensibility
+flurl
+hangfire
+jetbrains
+jitter
+jittered
+json
+loggingpolicy
+markdownsnippets
+minver
+moq
+namespace
+natively
+ndc
+nuget
+oss
+pcl
+parallelize
+pluralsight
+pollydocs
+pre
+rabbitmq
+ratelimiting
+ratiosd
+readme
+resharper
+rethrow
+rethrows
+retryable
+reusability
+sdk
+serializers
+silverlight
+simmy
+stackexchange
+stddev
+struct
+synchronizationcontext
+telemetryeventarguments
+telemetrylistener
+testability
+timingpolicy
+ui
+uwp
+waitandretry
+wpf
+xunit

.github/workflows/gh-pages.yml

@@ -31,6 +31,11 @@ jobs:
           !CHANGELOG.md
           !**/BenchmarkDotNet.Artifacts/**/*.md
 
+    - name: Spellcheck
+      uses: rojopolis/spellcheck-github-actions@47363488bf2b5b90cf1ae9b92c11357eee961e10 # v0.34.0
+      with:
+        config_path: .github/spellcheck.yml
+
     - name: Setup .NET SDK
       uses: actions/setup-dotnet@3447fd6a9f9e57506b15f895c5b76d3b197dc7c2 # v3.2.0
 

CHANGELOG.md

@@ -17,13 +17,13 @@
 * Add docs on how to use snippets by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1604
 * [Docs] General extensibility and implementation of proactive strategies by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1602
 * Align the telemetry tags with official guidelines by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1583
-* Add antipatterns to retry strategy by [@peter-csala](https://github.com/peter-csala) in https://github.com/App-vNext/Polly/pull/1603
+* Add anti-patterns to retry strategy by [@peter-csala](https://github.com/peter-csala) in https://github.com/App-vNext/Polly/pull/1603
 * [Docs] Reactive strategies extensibility by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1606
-* Add antipatterns to fallback strategy by [@peter-csala](https://github.com/peter-csala) in https://github.com/App-vNext/Polly/pull/1607
+* Add anti-patterns to fallback strategy by [@peter-csala](https://github.com/peter-csala) in https://github.com/App-vNext/Polly/pull/1607
 * Avoid capturing where possible. by [@IEvangelist](https://github.com/IEvangelist) in https://github.com/App-vNext/Polly/pull/1609
 * Fix urls within readme extensions project by [@wahid-moh](https://github.com/wahid-moh) in https://github.com/App-vNext/Polly/pull/1616
 * [Docs] Testing by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1608
-* [Docs] Add antipatterns to circuit breaker documentation page by [@peter-csala](https://github.com/peter-csala) in https://github.com/App-vNext/Polly/pull/1621
+* [Docs] Add anti-patterns to circuit breaker documentation page by [@peter-csala](https://github.com/peter-csala) in https://github.com/App-vNext/Polly/pull/1621
 * [Docs] Performance docs improvements by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1618
 * [Docs] Polish the docs by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1619
 * Introduce `RetryStrategyOptions.MaxDelay` property by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1620
@@ -124,7 +124,7 @@
 * API Review Feedback by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1520
 * Got rid of some warnings in the Polly project by [@IgorIgorevich94](https://github.com/IgorIgorevich94) in https://github.com/App-vNext/Polly/pull/1514
 * API Review Feedback by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1521
-* Cleanup Outcome internals and drop unused hedging and fallbacks APIs by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1523
+* Cleanup Outcome internals and drop unused hedging and fallback APIs by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1523
 * Improve debugging experience for `ResilienceProperties` by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1524
 * Protect against retry delay overflows by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1522
 * Fix DelayAsync extension by [@martintmk](https://github.com/martintmk) in https://github.com/App-vNext/Polly/pull/1525
@@ -352,7 +352,7 @@ Thanks to:
 - Enhancement: Improved cache error message (issue 455)
 
 ## 6.0.1
-- Version 6 RTM, for integration to ASPNET Core 2.1 IHttpClientFactory
+- Version 6 RTM, for integration to ASP.NET Core 2.1 IHttpClientFactory
 
 ## 6.0.0-v6alpha
 - Publish as strong-named package only (discontinue non-strong-named versions)

CODE_OF_CONDUCT.md

@@ -1,7 +1,4 @@
 # Code of Conduct
 
-Polly is part of the [.NET Foundation][dnf], and we ask our contributors to abide
-by their [Code of Conduct][dnf-coc].
-
-[dnf]: https://dotnetfoundation.org/
-[dnf-coc]: https://www.dotnetfoundation.org/code-of-conduct
+Polly is part of the [.NET Foundation](https://dotnetfoundation.org/), and we ask our contributors to abide
+by their [Code of Conduct](https://www.dotnetfoundation.org/code-of-conduct).

README.md

@@ -103,12 +103,12 @@ Polly categorizes resilience strategies into two main groups:
 
 | Strategy | Reactive | Premise | AKA | How does the strategy mitigate?|
 | ------------- | --- | ------------- |:-------------: |------------- |
-|**Retry** <br/>(strategy family)<br/><sub>([quickstart](#retry)&nbsp;;&nbsp;[deep](https://www.pollydocs.org/strategies/retry))</sub> |Yes|Many faults are transient and may self-correct after a short delay.| *Maybe it's just a blip* |  Allows configuring automatic retries. |
-|**Circuit-breaker**<br/>(strategy family)<br/><sub>([quickstart](#circuit-breaker)&nbsp;;&nbsp;[deep](https://www.pollydocs.org/strategies/circuit-breaker))</sub>|Yes|When a system is seriously struggling, failing fast is better than making users/callers wait.  <br/><br/>Protecting a faulting system from overload can help it recover. | *Stop doing it if it hurts* <br/><br/>*Give that system a break* | Breaks the circuit (blocks executions) for a period, when faults exceed some pre-configured threshold. |
-|**Timeout**<br/><sub>([quickstart](#timeout)&nbsp;;&nbsp;[deep](https://www.pollydocs.org/strategies/timeout))</sub>|No|Beyond a certain wait, a success result is unlikely.| *Don't wait forever*  |Guarantees the caller won't have to wait beyond the timeout. |
-|**Rate Limiter**<br/><sub>([quickstart](#rate-limiter)&nbsp;;&nbsp;[deep](https://www.pollydocs.org/strategies/rate-limiter))</sub>|No|Limiting the rate a system handles requests is another way to control load. <br/><br/> This can apply to the way your system accepts incoming calls, and/or to the way you call downstream services. | *Slow down a bit, will you?*  |Constrains executions to not exceed a certain rate. |
-|**Fallback**<br/><sub>([quickstart](#fallback)&nbsp;;&nbsp;[deep](https://www.pollydocs.org/strategies/fallback))</sub>|Yes|Things will still fail - plan what you will do when that happens.| *Degrade gracefully*  |Defines an alternative value to be returned (or action to be executed) on failure. |
-|**Hedging**<br/><sub>([quickstart](#hedging)&nbsp;;&nbsp;[deep](https://www.pollydocs.org/strategies/hedging))</sub>|Yes|Things can be slow sometimes, plan what you will do when that happens.| *Hedge your bets*  | Executes parallel actions when things are slow and waits for the fastest one.  |
+|**Retry** <br/>(strategy family)<br/><sub>([quick-start](#retry)&nbsp;;&nbsp;[deep](https://www.pollydocs.org/strategies/retry))</sub> |Yes|Many faults are transient and may self-correct after a short delay.| *Maybe it's just a blip* |  Allows configuring automatic retries. |
+|**Circuit-breaker**<br/>(strategy family)<br/><sub>([quick-start](#circuit-breaker)&nbsp;;&nbsp;[deep](https://www.pollydocs.org/strategies/circuit-breaker))</sub>|Yes|When a system is seriously struggling, failing fast is better than making users/callers wait.  <br/><br/>Protecting a faulting system from overload can help it recover. | *Stop doing it if it hurts* <br/><br/>*Give that system a break* | Breaks the circuit (blocks executions) for a period, when faults exceed some pre-configured threshold. |
+|**Timeout**<br/><sub>([quick-start](#timeout)&nbsp;;&nbsp;[deep](https://www.pollydocs.org/strategies/timeout))</sub>|No|Beyond a certain wait, a success result is unlikely.| *Don't wait forever*  |Guarantees the caller won't have to wait beyond the timeout. |
+|**Rate Limiter**<br/><sub>([quick-start](#rate-limiter)&nbsp;;&nbsp;[deep](https://www.pollydocs.org/strategies/rate-limiter))</sub>|No|Limiting the rate a system handles requests is another way to control load. <br/><br/> This can apply to the way your system accepts incoming calls, and/or to the way you call downstream services. | *Slow down a bit, will you?*  |Constrains executions to not exceed a certain rate. |
+|**Fallback**<br/><sub>([quick-start](#fallback)&nbsp;;&nbsp;[deep](https://www.pollydocs.org/strategies/fallback))</sub>|Yes|Things will still fail - plan what you will do when that happens.| *Degrade gracefully*  |Defines an alternative value to be returned (or action to be executed) on failure. |
+|**Hedging**<br/><sub>([quick-start](#hedging)&nbsp;;&nbsp;[deep](https://www.pollydocs.org/strategies/hedging))</sub>|Yes|Things can be slow sometimes, plan what you will do when that happens.| *Hedge your bets*  | Executes parallel actions when things are slow and waits for the fastest one.  |
 
 Visit [resilience strategies](https://www.pollydocs.org/strategies) docs to explore how to configure individual resilience strategies in more detail.
 
@@ -430,7 +430,7 @@ To learn more about Polly, visit [pollydocs.org][polly-docs].
 
 - [Samples](samples/README.md): Samples in this repository that serve as an introduction to Polly.
 - [Polly-Samples](https://github.com/App-vNext/Polly-Samples): Contains practical examples for using various implementations of Polly. Please feel free to contribute to the Polly-Samples repository in order to assist others who are either learning Polly for the first time, or are seeking advanced examples and novel approaches provided by our generous community.
-- Microsoft's [eShopOnContainers project](https://github.com/dotnet-architecture/eShopOnContainers): Sample project demonstrating a .NET Microservices architecture and using Polly for resilience.
+- Microsoft's [eShopOnContainers project](https://github.com/dotnet-architecture/eShopOnContainers): Sample project demonstrating a .NET Micro-services architecture and using Polly for resilience.
 
 ## License
 

docs/advanced/simmy.md

@@ -1,6 +1,6 @@
 # Chaos engineering with Simmy
 
 [Simmy][simmy] is a major new companion project adding a chaos-engineering and fault-injection dimension to Polly, through the provision of policies to selectively inject faults or latency.
-Head over to the [Simmy][simmy] repo to find out more.
+Head over to the [Simmy][simmy] repository to find out more.
 
 [simmy]: https://github.com/Polly-Contrib/Simmy

docs/api/index.md

@@ -1,4 +1,3 @@
 # PLACEHOLDER
 
-TODO: Add .NET projects to the *src* folder and run `docfx` to
-generate **REAL** *API Documentation*!
+`docfx` automatically generates this file when GitHub Pages are built.