Merge pull request #462 from yarikoptic/enh-codespell

Cassie205 · web-flow · commit 901310eca542 · 2024-01-10T16:59:12.000+01:00
Add codespell: config, workflow (to alert when new typos added) and get typos fixed
diff --git a/.codespellrc b/.codespellrc
@@ -0,0 +1,6 @@
+[codespell]
+skip = .git,*.pdf,*.svg,go.sum,*.css,.codespellrc
+check-hidden = true
+# Some German and custom names and regexes
+ignore-regex = .*\b(ist ein|SAV for Mac)\b|.*ü.*|\bTe\*|\b_static/Ressources\b
+# ignore-words-list =
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -0,0 +1,22 @@
+---
+name: Codespell
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2
diff --git a/Formatting_Cheat-Sheet.md b/Formatting_Cheat-Sheet.md
@@ -57,7 +57,7 @@ test
 [Formatting Cheat Sheet](Formatting_Cheat-Sheet)
 
 ```
-{download}`Titel<Download_Link>`
+{download}`Title<Download_Link>`
 ```
 
 ---
diff --git a/cli/index.md b/cli/index.md
@@ -224,7 +224,7 @@ duck --username <Access Key ID> --list s3:/<bucketname>/
 
 #### `--retry`
 
-Retry requests with I/O failures once per default. Useful on connnection timeout or latency issues.
+Retry requests with I/O failures once per default. Useful on connection timeout or latency issues.
 
 #### `--verbose`
 
diff --git a/cyberduck/browser.md b/cyberduck/browser.md
@@ -20,7 +20,7 @@ Navigate into a folder with a double-click *(`⌘↓`)* or one level up by using
 ````
 ````{group-tab} Windows
 
-You can expand and collaps folders using the right and left arrow keys in the outline view.
+You can expand and collapse folders using the right and left arrow keys in the outline view.
 
 Navigate into a folder with a doubl-click *(`Ctrl+Down`)* or one level up by using the ▲ button next to the path-field *(`Ctrl+Up`)*.
 
@@ -183,7 +183,7 @@ Use the *File → Print* option where you can open a PDF from the browser listin
 
 ### Folder Icon Badges
 
-Folder icons are badged for paticular access permissions.
+Folder icons are badged for particular access permissions.
 
 ```{image} _images/privatefolderbadge.png
 :alt: Private Folder Badge
diff --git a/cyberduck/connection.md b/cyberduck/connection.md
@@ -191,7 +191,7 @@ Choose *Cyberduck → Preferences → Connection → Use system proxy settings*.
 
 ### Additional Settings
 
-#### Prefer IPv6 Adresses of DNS Lookups
+#### Prefer IPv6 Addresses of DNS Lookups
 
 A [hidden configuration option](preferences.md#hidden-configuration-options).
 
@@ -203,7 +203,7 @@ A [hidden configuration option](preferences.md#hidden-configuration-options).
 
     defaults write ch.sudo.cyberduck rendezvous.enable false
 
-#### Disable Bonjour Notifications in Notification Center and Sytem Tray
+#### Disable Bonjour Notifications in Notification Center and System Tray
 
 A [hidden configuration option](preferences.md#hidden-configuration-options). By default, the limit is set to allow not more than `30` notifications per minute.
 
diff --git a/cyberduck/edit.md b/cyberduck/edit.md
@@ -4,7 +4,7 @@ Edit Files
 You can edit a file just as a local file in an external editor by clicking the Edit toolbar button or by choosing *File → Edit With*. The file will be downloaded to a temporary directory and opened with the preferred editor. The file will be uploaded to the server every time you choose *File → Save* in the Editor application. The file is not changed on the server if you just close the document without saving it or if the content has not changed.
 
 ## Default Editor
-The default editor opened for a file is selected depeding on the file type. If no application is found to handle the file type the default eidtor chosen in *Preferences* is used instead.
+The default editor opened for a file is selected depending on the file type. If no application is found to handle the file type the default eidtor chosen in *Preferences* is used instead.
 
 ```{image} _images/Edit_With_Application.png
 :alt: Edit with Application
diff --git a/cyberduck/faq.md b/cyberduck/faq.md
@@ -14,7 +14,7 @@ Cyberduck is an open-source server and cloud storage browser for Mac and Windows
 
 ### Is Cyberduck Free?
 
-Cyberduck is free software. Free software is a matter of the users' freedom to run, copy, distribute, study, change, and improve the software. If you find this programm useful, please consider making a [donation](http://cyberduck.ch/donate). A donation would not only demonstrate your appreciation of this software but also help to advance development in the future. You receive a registration key and it will help to make Cyberduck even better!
+Cyberduck is free software. Free software is a matter of the users' freedom to run, copy, distribute, study, change, and improve the software. If you find this program useful, please consider making a [donation](http://cyberduck.ch/donate). A donation would not only demonstrate your appreciation of this software but also help to advance development in the future. You receive a registration key and it will help to make Cyberduck even better!
 
 ```{image} _images/Donation_Prompt.png
 :alt: Donation Prompt
diff --git a/cyberduck/sync.md b/cyberduck/sync.md
@@ -54,5 +54,5 @@ No files are downloaded.
 
 You have to manually restart the synchronization in the transfer window. If you want to automate things you will be better off with either
 
-- [Cyberduck CLI](https://duck.sh/) which allows you to write a script and schedule ot with your preferred method such as `cron`.
-- [Mountain Duck](https://mountainduck.io/) which allows you to mount the remote volume and synchronise files with any of your preferred tools such as `rsync`.
+- [Cyberduck CLI](https://duck.sh/) which allows you to write a script and schedule it with your preferred method such as `cron`.
+- [Mountain Duck](https://mountainduck.io/) which allows you to mount the remote volume and synchronise files with any of your preferred tools such as `rsync`.
diff --git a/cyberduck/transfer.md b/cyberduck/transfer.md
@@ -220,7 +220,7 @@ Enabling change of modification date slows down the transfer rate when uploading
 
 A [hidden configuration option](preferences.md#hidden-configuration-options). Edit the available options (in bytes).
 
-    defaults write ch.sudo.cyberduck queue.bandwith.options 102400,1073741824
+    defaults write ch.sudo.cyberduck queue.bandwidth.options 102400,1073741824
 
 ### Badge Dock Icon
 
diff --git a/cyberduck/upload.md b/cyberduck/upload.md
@@ -89,4 +89,4 @@ An option to upload with a temporary name and rename the file after the transfer
 
     defaults write ch.sudo.cyberduck queue.upload.file.temporary.format "'{0}-{1}'"
 
-where `{0}` is the original filename and `{1}` is a random UUID. The default setting uses a temprary filename of `filename-uuid`.
+where `{0}` is the original filename and `{1}` is a random UUID. The default setting uses a temporary filename of `filename-uuid`.
diff --git a/mountainduck/installation/index.md b/mountainduck/installation/index.md
@@ -22,7 +22,7 @@ No admin privileges for installation is required.
 Mountain Duck is installed through the Mac App Store in `/Applications`. You can always reinstall Mountain Duck on any Mac you own from the Mac App Store in *→ App Store... → Purchased*.
 
 **Login Item**<br/>
-You can choose to open Mountain Duck when you log into your computer. Tha application will appear in *Login Items* of the *User & Groups* system preferences panel.
+You can choose to open Mountain Duck when you log into your computer. The application will appear in *Login Items* of the *User & Groups* system preferences panel.
 
 ![Login Item](_images/Login_Item.png)
 
@@ -51,7 +51,7 @@ For **macOS Ventura and later**, the setting can be found in *System Settings 
 [Download](https://mountainduck.io/changelog/) MSI Installer for corporate environments. Requires prior installation of *Microsoft .NET Framework 4.5.2*.
 
 ```{note}
-Using the MSI Installer, you'll have to install the *MSI Package Shell Extension for 32bit applications* **and** *MSI Package Shell Extension for 64bit applications* separatly. Both packages are needed to enable the explorer extension.
+Using the MSI Installer, you'll have to install the *MSI Package Shell Extension for 32bit applications* **and** *MSI Package Shell Extension for 64bit applications* separately. Both packages are needed to enable the explorer extension.
 ```
 
 ````
diff --git a/mountainduck/interface.md b/mountainduck/interface.md
@@ -140,7 +140,7 @@ Use
 
 ````{group-tab} Windows
 
-Enter the commmand `<path to Mountainduck.exe> %AppData%/Cyberduck/Bookmarks/<Bookmarkfile>` in *cmd.exe*.
+Enter the command `<path to Mountainduck.exe> %AppData%/Cyberduck/Bookmarks/<Bookmarkfile>` in *cmd.exe*.
 
 ````
 `````
@@ -178,7 +178,7 @@ You can unmount volumes using your command-line interface (CLI). Use `umount <bo
 In *File Explorer* in "This PC" view or the sidebar on the left of the *File Explorer* window, open the context menu for your mounted drive and select *Disconnect*.
 
 **Disconnect using command line**<br/>
-You can unmount volumes using your commmand-line interface (CLI). Use `net use <drive letter>: /delete` in *cmd.exe*
+You can unmount volumes using your command-line interface (CLI). Use `net use <drive letter>: /delete` in *cmd.exe*
 
 ````
 
diff --git a/mountainduck/issues/index.md b/mountainduck/issues/index.md
@@ -37,7 +37,7 @@ Choose *File Explorer → Folder Options*.
 `````
 
 ## Temporary Files
-When opening files with status _Online only_ or when connected with _Online_ connect mode, it may be required to temporarily cache contents depending on the read pattern of the application opening the file. Data ist stored in the temporary file location of the operating system and allows for faster access when repeatedly reading the file. Temporary files are deleted as soon as the application closes the file after reading, unless the option _Enable buffering_ checked in _Preferences → Sync_. 
+When opening files with status _Online only_ or when connected with _Online_ connect mode, it may be required to temporarily cache contents depending on the read pattern of the application opening the file. Data is stored in the temporary file location of the operating system and allows for faster access when repeatedly reading the file. Temporary files are deleted as soon as the application closes the file after reading, unless the option _Enable buffering_ checked in _Preferences → Sync_. 
 
 ```{tip}
 When enabled _Preferences → Sync → Enable buffering_ is enabled:
@@ -68,7 +68,7 @@ Files matching the following naming pattern are excluded from folder listings an
 - `\` (backslash)
 - `|` (vertical bar or pipe)
 - `?` (question mark)
-- `*` (asterik)
+- `*` (asterisk)
 
 ````
 `````
@@ -241,7 +241,7 @@ The Spotlight search does not work on remote volumes.
 **Spotlight indexer**<br/>
 To prevent the indexing through Spotlight the default mount location has been changed to `Volumes.noindex`. In case you **do** want the mount location to be indexed by Spotlight, use the *Terminal.app* command `mdutil -i on <mount location>`. Additionally, [mount location](../preferences.md#mount-location) to a directory without the extension `.noindex`.
 ```{attention}
-Enabling Spotlight can cause high CPU and bandwith usage while indexing folders. 
+Enabling Spotlight can cause high CPU and bandwidth usage while indexing folders. 
 ```
 
 
@@ -254,7 +254,7 @@ It may be that Finder closes the connection because Mountain Duck hasn't answere
 This is an issue within the operating system that can occur to any network drive.
 
 <del> **Additional `._*` Files Saved on Remote Volumes** </del> <br/>
-<del> The `._*` files contain metadata about the files some applications write in additional to the file content. On macOS, this metadata can be stored alongside the file on the filesystem, but on remote volumes, with no metadata suppport, an auxiliary file is created to contain this information. You can delete metadata on files using `xattr -d <filename>`. </del>
+<del> The `._*` files contain metadata about the files some applications write in additional to the file content. On macOS, this metadata can be stored alongside the file on the filesystem, but on remote volumes, with no metadata support, an auxiliary file is created to contain this information. You can delete metadata on files using `xattr -d <filename>`. </del>
 
 As of version [2.1](https://mountainduck.io/changelog/), extended attributes are only saved in a temporary location and not stored on the mounted remote volume. If you want to revert to saving extended attributes to the server, enter in a *Terminal.app* window:
 
@@ -273,7 +273,7 @@ If you get this error message you most likely haven't restarted your system afte
 **Missing Files in Windows Explorer**<br/>
 Windows has a limitation on the maximum path length. It might happen that Mountain Duck exceeds this maximum for long file names when trying to create placeholders in the local cache. If Mountain Duck is unable to create a placeholder file for a remote file it will not appear in the Windows Explorer listing.
 
-To work around this Windows limitaion you can enable long path support in Windows 10 as of version 1607.
+To work around this Windows limitation you can enable long path support in Windows 10 as of version 1607.
 
 1. Open the *Local Group Policy editor* (search for *Edit Group Policy*)
 2. Navigate to *Local Computer Policy → Computer Configuration → Administrative Templates → System → Filesystem*
diff --git a/mountainduck/preferences.md b/mountainduck/preferences.md
@@ -87,7 +87,7 @@ Files selected to always keep offline are never automatically removed from the c
 By default, files are kept in cache for 30 days and the cache is limited to a maximum size of 5GiB.
 
 ```{attention}
-The settings apply separately for each bookmark. The synchronization cache gets cleared based on the choosen cache limit after Mountain Duck is started and every 24h as long as Mountain Duck is running.
+The settings apply separately for each bookmark. The synchronization cache gets cleared based on the chosen cache limit after Mountain Duck is started and every 24h as long as Mountain Duck is running.
 ```
 
 ## Notifications
@@ -125,7 +125,7 @@ The connection profiles for [default protocols](../protocols/index.md) are alway
 Reconnect after restarting the computer. If you choose *Enable Login Item* and *Save Workspace* in *Preferences → General* and do not manually eject the volume prior to reboot it will reconnect after login.
 
 ## Cryptomator
-Choose wheather or not your [Cryptomator vaults](../cryptomator/index.md) should be auto detected and unlocked while browsing the parent folder or not by using the *Auto detect and open vault in browser* option.
+Choose whether or not your [Cryptomator vaults](../cryptomator/index.md) should be auto detected and unlocked while browsing the parent folder or not by using the *Auto detect and open vault in browser* option.
 
 ```{note}
 Without saving the vaults passwords using keychain, you will receive passwords prompts for the vaults after reconnecting to the server or cloud storage.
diff --git a/protocols/box.md b/protocols/box.md
@@ -14,7 +14,7 @@ Download [Mountain Duck](https://mountainduck.io/) as an alternative to *Box Dri
 
 ## Connecting
 
-Use the default *Box* connection profile to connect to your server using the Box API. This allows to have Multi-Factor Authentication enabled for your accout.
+Use the default *Box* connection profile to connect to your server using the Box API. This allows to have Multi-Factor Authentication enabled for your account.
 
 ### Alternate Connection Options
 
diff --git a/protocols/dracoon.md b/protocols/dracoon.md
@@ -27,7 +27,7 @@ The DRACOON (OAuth) connection profile is bundled by default with Cyberduck.
 
 ### Authentication with username and password 
 
-To authenticate with your username and password, use the _DRACOON (OAuth Password Flow)_ profile. Instead of retrieving an authentication code by logging in using a web browser, the profile uses the OAuth password flow to authenticate. This is most usefull when working with [Cyberduck CLI](https://duck.sh/).
+To authenticate with your username and password, use the _DRACOON (OAuth Password Flow)_ profile. Instead of retrieving an authentication code by logging in using a web browser, the profile uses the OAuth password flow to authenticate. This is most useful when working with [Cyberduck CLI](https://duck.sh/).
 
 ## Client-Side Encryption
 
diff --git a/protocols/irods.md b/protocols/irods.md
@@ -38,7 +38,7 @@ To authenticate with PAM, prefix the username with PAM:or set it in the [connect
     <key>Authorization</key>
     <string>PAM</string>
 
-### Ressource Server
+### Resource Server
 
 You can specify a non-default resource server in the Region key of the [connection profile](index.md#connection-profiles) using a colon-separated syntax (Issue [#8721](https://github.com/iterate-ch/cyberduck/issues/8721)) such as
 
diff --git a/protocols/openstack/index.md b/protocols/openstack/index.md
@@ -41,7 +41,7 @@ All connection profiles are available through the *Preferences → Profiles* tab
 
 ### Authentication Context Path
 
-#### Authetication with `devauth` for Context `/v1.0`
+#### Authentication with `devauth` for Context `/v1.0`
 
 Legacy authentication option.
 
diff --git a/protocols/openstack/infomaniak.md b/protocols/openstack/infomaniak.md
@@ -28,7 +28,7 @@ Log in to your *Infomaniak OpenStack Swift space* via this preconfigured connect
 
 Enter the following information in the [bookmark](../../cyberduck/bookmarks.md):
 
-- Project:Domain:Username: `Informations available in your Infomaniak manager. Example: PCP-XXXXXX:Default:PCU-XXXXXX`
+- Project:Domain:Username: `Information available in your Infomaniak manager. Example: PCP-XXXXXX:Default:PCU-XXXXXX`
 - Password: `password is the same as the one you use for the OpenStack dashboard`
 
 ### References
diff --git a/protocols/s3/index.md b/protocols/s3/index.md
@@ -82,7 +82,7 @@ The default port is `80`.
 
 **HTTPS**</br>
 
-The defaut port is `443`.
+The default port is `443`.
 
 - {download}`Download<https://profiles.cyberduck.io/S3%20(HTTPS).cyberduckprofile>` the *S3 (HTTPS) profile* for preconfigured settings.
 ````
@@ -97,13 +97,13 @@ An incomplete list of known providers that require the use of AWS2
 
 **HTTP**</br>
 
-The defaut port is `80`.
+The default port is `80`.
 
 - {download}`Download<https://profiles.cyberduck.io/S3%20AWS2%20Signature%20Version%20(HTTP).cyberduckprofile>` the S3 AWS2 Signature Version (HTTP) profile for preconfigured settings.
 
 **HTTPS**</br>
 
-The defaut port is `443`.
+The default port is `443`.
 
 - {download}`Download<https://profiles.cyberduck.io/S3%20AWS2%20Signature%20Version%20(HTTPS).cyberduckprofile>` the S3 AWS2 Signature Version (HTTPS) profile for preconfigured settings.
 ````
@@ -477,7 +477,7 @@ Sets the time, in days, between when an object is uploaded to the bucket and whe
 
 ### Restored Glacier files in Mountain Duck
 
-Temporarly restored files from *Glacier* won't change the storage class and therefor won't be listed by Mountain Duck. To make restored Glacier files available in Mountain Duck make sure to change the file's storage class in the S3 tab of the [Cyberduck Info window](../../cyberduck/info.md#provider-panel).
+Temporarily restored files from *Glacier* won't change the storage class and therefore won't be listed by Mountain Duck. To make restored Glacier files available in Mountain Duck make sure to change the file's storage class in the S3 tab of the [Cyberduck Info window](../../cyberduck/info.md#provider-panel).
 
 ## Access Control (ACL)
 
@@ -571,7 +571,7 @@ Share links cannot be created when failing to update the ACLs on a file because
 
 * Bucket has "Object Ownership" set to "Bucket owner enforced" ([ACLs disabled](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html?icmpid=docs_amazons3_console)). 
 Error message: `This bucket does not allow ACLs`
-* ["Block public acccess"](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html?icmpid=docs_amazons3_console) is enabled on bucket. Error message: `Access denied` 
+* ["Block public access"](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html?icmpid=docs_amazons3_console) is enabled on bucket. Error message: `Access denied` 
 
 ## Metadata
 
diff --git a/protocols/s3/ionos.md b/protocols/s3/ionos.md
@@ -17,7 +17,7 @@ All connection profiles are available through the *Preferences → Profiles* tab
 
 ### Object storage keys
 
-1. Sign into your **IONOS Data Center Designer** and navigate to the **User Manager** via the menu bar **Ressource Manager** section.
+1. Sign into your **IONOS Data Center Designer** and navigate to the **User Manager** via the menu bar **Resource Manager** section.
 2. Select a user and click on the **Object Storage Keys** tab on the right.
 3. Choose **Generate Key** and confirm the action with **OK**.
 The object storage key will be generated automatically.
diff --git a/protocols/s3/polycloud.md b/protocols/s3/polycloud.md
@@ -10,7 +10,7 @@ Polycloud
 Double-click on the downloaded file to activate the connection profile. Enter the following authentication credentials to the bookmark:
 - Server: `polycloud.crowdapis.com`
 - Access Key ID: Access Key Credentials
-- Secret Acces Key: Access Key Credentials
+- Secret Access Key: Access Key Credentials
 
 ### How to Create Application Keys
 
diff --git a/protocols/sftp/index.md b/protocols/sftp/index.md
diff --git a/protocols/webdav/index.md b/protocols/webdav/index.md
