feat: hello codespell

Signed-off-by: Daniel Kesselberg <[email protected]>

Author: kesselb

.codespellignore

@@ -0,0 +1,3 @@
+SME
+te
+jus

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+skip = ./build/*,**/_build/*,*.pot,conf.py,./static/*,./admin_manual/configuration_server/config_sample_php_parameters.rst,./_shared_assets/*,./COPYING
+ignore-words = .codespellignore
+check-filenames = true

.github/workflows/codespell.yml

@@ -0,0 +1,17 @@
+name: 'Codespell'
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  codespell:
+    name: Check spelling
+    runs-on: self-hosted
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Check spelling
+        uses: codespell-project/actions-codespell@v2

README.rst

@@ -170,7 +170,7 @@ Using the VSCode DevContainer
 This repository contains a full-featured `VSCode DevContainer <https://code.visualstudio.com/docs/devcontainers/containers>`_.
 You can use it in your local development environment or via `GitHub Codespaces <https://github.com/features/codespaces>`_.
 Just open the container an use one of the commands from above to build the project. For example ``make`` to build the full
-documentaion, ``make html`` to build the HTML documentaion or ``make pdf`` to build the PDF documentation. You can also use
+documentation, ``make html`` to build the HTML documentation or ``make pdf`` to build the PDF documentation. You can also use
 ``make SPHINXBUILD=sphinx-autobuild html`` in combination with `port forwarding <https://code.visualstudio.com/docs/devcontainers/containers#_forwarding-or-publishing-a-port>`_
 to  watch file changes and automatically reload the html preview.
 

admin_manual/ai/app_llm2.rst

@@ -107,6 +107,6 @@ Known Limitations
 * Language models can be bad at reasoning tasks
 * Language models are likely to generate false information and should thus only be used in situations that are not critical. It's recommended to only use AI at the beginning of a creation process and not at the end, so that outputs of AI serve as a draft for example and not as final product. Always check the output of language models before using it.
 * Make sure to test the language model you are using it for whether it meets the use-case's quality requirements
-* Language models notoriously have a high energy consumption, if you want to reduce load on your server you can choose smaller models or quantized models in excahnge for lower accuracy
+* Language models notoriously have a high energy consumption, if you want to reduce load on your server you can choose smaller models or quantized models in exchange for lower accuracy
 * Customer support is available upon request, however we can't solve false or problematic output, most performance issues, or other problems caused by the underlying model. Support is thus limited only to bugs directly caused by the implementation of the app (connectors, API, front-end, AppAPI)
 * Due to technical limitations that we are in the process of mitigating, each task currently incurs a time cost of between 0 and 5 minutes in addition to the actual processing time

admin_manual/ai/app_stt_whisper2.rst

@@ -68,6 +68,6 @@ Known Limitations
 * The whisper models perform unevenly across languages, and may show lower accuracy on low-resource and/or low-discoverability languages or languages where there was less training data available. The models also exhibit disparate performance on different accents and dialects of particular languages, which may include higher word error rate across speakers of different genders, races, ages, or other demographic criteria.
 * Language models are likely to generate false information and should thus only be used in situations that are not critical. It's recommended to only use AI at the beginning of a creation process and not at the end, so that outputs of AI serve as a draft for example and not as final product. Always check the output of language models before using it.
 * Make sure to test the language model you are using it for whether it meets the use-case's quality requirements
-* Language models notoriously have a high energy consumption, if you want to reduce load on your server you can choose smaller models or quantized models in excahnge for lower accuracy
+* Language models notoriously have a high energy consumption, if you want to reduce load on your server you can choose smaller models or quantized models in exchange for lower accuracy
 * Customer support is available upon request, however we can't solve false or problematic output, most performance issues, or other problems caused by the underlying model. Support is thus limited only to bugs directly caused by the implementation of the app (connectors, API, front-end, AppAPI)
 * Due to technical limitations that we are in the process of mitigating, each task currently incurs a time cost of between 0 and 5 minutes in addition to the actual processing time

admin_manual/configuration_database/db_conversion.rst

@@ -37,7 +37,7 @@ The ``occ db:convert-type`` command handles all the tasks of the conversion. The
   php occ db:convert-type [options] type username hostname database
 
 ``type`` should be the target database type. The same values are available here as for the ``config.php`` ``dbtype`` parameter. It should be one of: ``mysql`` for MariaDB/MySQL, 
-``pgsql`` for PostgresSQL, or ``oci`` for Oracle.
+``pgsql`` for PostgreSQL, or ``oci`` for Oracle.
 
 The options:
 

admin_manual/configuration_database/linux_database_configuration.rst

@@ -18,7 +18,7 @@ Requirements
 
 * Decide whether you wish to use MySQL / MariaDB, PostgreSQL, or Oracle as your database
 * Pick a recommendeded version of your database by checking the Nextcloud :doc:`System Requirements <../installation/system_requirements>`
-* Install and set up the chosen database server software (and preferrred version) before deploying Nextcloud Server
+* Install and set up the chosen database server software (and preferred version) before deploying Nextcloud Server
 
 .. note:: The steps for configuring a third party database are beyond the
   scope of this document.  Please refer to the documentation for your specific
@@ -208,7 +208,7 @@ like this:
   extension=pdo_pgsql.so
   extension=pgsql.so
 
-  [PostgresSQL]
+  [PostgreSQL]
   pgsql.allow_persistent = On
   pgsql.auto_reset_persistent = Off
   pgsql.max_persistent = -1

admin_manual/configuration_files/encryption_details.rst

@@ -347,7 +347,7 @@ Sources
 
 - `nextcloud-tools repository on GitHub <https://github.com/syseleven/nextcloud-tools>`_
 - `Nextcloud Encryption Configuration documentation <https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/encryption_configuration.html>`_
-- `Nextcloud Help response concering the usage of version information <https://help.nextcloud.com/t/allow-file-decryption-with-only-the-files-keys-and-passwords/436/12>`_
+- `Nextcloud Help response concerning the usage of version information <https://help.nextcloud.com/t/allow-file-decryption-with-only-the-files-keys-and-passwords/436/12>`_
 - `Sourcecode: Creation of the Message Authentication Code <https://github.com/nextcloud/server/blob/a374d8837d6de459500e619cf608e0721ea14574/apps/encryption/lib/Crypto/Crypt.php#L504>`_
 - `Sourcecode: Derivation of the Encryption Key <https://github.com/nextcloud/server/blob/a374d8837d6de459500e619cf608e0721ea14574/apps/encryption/lib/Crypto/Crypt.php#L346>`_
 - `Sourcecode: Encryption of the File <https://github.com/nextcloud/server/blob/a374d8837d6de459500e619cf608e0721ea14574/apps/encryption/lib/Crypto/Crypt.php#L234>`_

admin_manual/configuration_files/external_storage_configuration_gui.rst

@@ -93,7 +93,7 @@ individually with the following options:
 * Previews
 * Enable Sharing
 * Filesystem check frequency (Never, Once per direct access)
-* Mac NFD Compatability
+* Mac NFD Compatibility
 * Read Only
 
 The **Encryption** checkbox is visible only when the Encryption app is enabled. Note that server-side

admin_manual/configuration_server/caching_configuration.rst

@@ -206,7 +206,7 @@ The following options are available to configure when using a redis cluster (all
       'dbindex'         => 0,
    ],
       
-.. note:: The port is required as part of the server URL. However, it is not necesarry to list all servers: for example, if all servers are load balanced via the same DNS name, only that server name is required.
+.. note:: The port is required as part of the server URL. However, it is not necessary to list all servers: for example, if all servers are load balanced via the same DNS name, only that server name is required.
 
 Connecting to single Redis server over TCP
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

admin_manual/configuration_server/occ_command.rst

@@ -179,7 +179,7 @@ Enabling autocompletion
 -----------------------
 
 .. note:: Command autocompletion currently only works if the user you use to execute the occ commands has a profile.
-  ``www-data`` in most cases is ``nologon`` and therefor **cannot** use this feature.
+  ``www-data`` in most cases is ``nologon`` and therefore **cannot** use this feature.
 
 Autocompletion is available for bash (and bash based consoles).
 To enable it, you have to run **one** of the following commands::
@@ -1168,7 +1168,7 @@ mimetype, run ``maintenance:mimetype:update-db --repair-filecache`` to apply the
 change to existing files.
 
 Run the ``maintenance:theme:update`` command if the icons of your custom theme are not
-updated correctly. This updates the mimetypelist.js and cleares the image cache.
+updated correctly. This updates the mimetypelist.js and clears the image cache.
 
 .. _security_commands_label:
 
@@ -1748,7 +1748,7 @@ check for that user via the occ command::
 
 .. note:: This is not supported by all providers.
 
-To re-enable two-factor auth again use the following commmand::
+To re-enable two-factor auth again use the following command::
 
  sudo -u www-data php occ twofactorauth:enable <uid> <provider_id>
 

admin_manual/configuration_server/security_setup_warnings.rst

@@ -123,10 +123,10 @@ Some files have not passed the integrity check
 
 Please refer to the :ref:`code_signing_fix_warning_label` documentation how to debug this issue.
 
-Your database does not run with "READ COMMITED" transaction isolation level
+Your database does not run with "READ COMMITTED" transaction isolation level
 ---------------------------------------------------------------------------
 
-"Your database does not run with "READ COMMITED" transaction isolation level.
+"Your database does not run with "READ COMMITTED" transaction isolation level.
 This can cause problems when multiple actions are executed in parallel."
 
 Please refer to :ref:`db-transaction-label` how to configure your database for this requirement.

admin_manual/configuration_user/user_auth_ldap.rst

@@ -709,7 +709,7 @@ Example usage::
 
 It is also possible to set the admin group mapping using
 ``occ ldap:set-config $configId ldapAdminGroup $groupId``, but as the Nextcloud
-group ID might not be known (yet) it is recommended (especially for automatized
+group ID might not be known (yet) it is recommended (especially for automated
 setups) to use the `promote-group` command, that would also pull in the group
 and determine the group ID.
 

admin_manual/file_workflows/access_control.rst

@@ -43,7 +43,7 @@ assigned.
 
 So you just need to assign the tag to the folder or file, and then block the
 tag with a rule group. The check is independent of the user's permissions for
-the tag. Therefor restricted and invisible tags are recommended, otherwise a
+the tag. Therefore restricted and invisible tags are recommended, otherwise a
 user could remove and reassign the tag.
 
 This example blocks access to any folder with the tag ``Confidential``.
@@ -75,7 +75,7 @@ Blocking user groups
 When trying to deny access to a group of users, make sure that sharing does not
 allow them to create a way back in. When users are able to create a public link,
 the users can log themselves out and visit their own public link to access the
-files. Since at this point they are no user and therefor no member of the
+files. Since at this point they are no user and therefore no member of the
 blocked group, they will be able to read and change the file.
 
 The recommended work around is to create the same rule again, and deny access
@@ -87,7 +87,7 @@ External storage
 
 While access to files in external storages is not possible via Nextcloud, users
 that have direct access to the external storage, can of course change files
-there directly. Therefor it is recommended to disable the ``Allow users to mount
+there directly. Therefore it is recommended to disable the ``Allow users to mount
 external storage`` option, when trying to to completely lock out users.
 
 .. _available-rules-label:

admin_manual/file_workflows/automated_tagging.rst

@@ -27,7 +27,7 @@ navigate to the configuration and locate the Workflow settings.
 In the example you can see a simple rule with only one condition.
 It will tag all files with the restricted tag ``Protected file`` that are
 uploaded into a folder that is tagged with ``Protect content``. No user can
-remove the tag ``Protected file`` and therefor access control and retention
+remove the tag ``Protected file`` and therefore access control and retention
 both work fine without users being able to work around them.
 
 In this case folder will be also tagged with tag ``Protected file``, to avoid

admin_manual/groupware/calendar.rst

@@ -34,7 +34,7 @@ Reminder notifications
 ----------------------
 Nextcloud handles sending notifications for events.
 
-Nextcloud currently handles two types of reminder notifications: Build-in Nextcloud notifications and
+Nextcloud currently handles two types of reminder notifications: Built-in Nextcloud notifications and
 email notifications. For the emails to be send, you'll need a configured email server.
 See :doc:`../configuration_server/email_configuration`.
 

admin_manual/groupware/contacts.rst

@@ -20,7 +20,7 @@ You can disable access to the system address book by using the app config value
 
 Run ``occ config:app:set dav system_addressbook_exposed --value="no"`` to disable access to the system address book for all users. Please note that this does not influence :ref:`Federated sharing<label-direct-share-link>`.
 
-.. warning:: If clients have already connected to the CalDAV endpoint, the clients might experience sync issues after system address book access was disabled. This can often be remedied by chosing a different default address book on the client and forcing a resync.
+.. warning:: If clients have already connected to the CalDAV endpoint, the clients might experience sync issues after system address book access was disabled. This can often be remedied by choosing a different default address book on the client and forcing a resync.
 
 Privacy and User Property Scopes
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

admin_manual/installation/example_centos.rst

@@ -91,7 +91,7 @@ You have to enable the module stream for 8.2:
 Installing PHP and the required modules
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Next, install the PHP modules needed for this install. Remember, because this is a limited basic install, we only install the neccessary modules, not all of them. If you are making a more complete install, please refer to PHP module list in the source installation documentation, :doc:`../installation/source_installation`::
+Next, install the PHP modules needed for this install. Remember, because this is a limited basic install, we only install the necessary modules, not all of them. If you are making a more complete install, please refer to PHP module list in the source installation documentation, :doc:`../installation/source_installation`::
 
     dnf install -y php php-cli php-gd php-mbstring php-intl php-pecl-apcu\
          php-mysqlnd php-opcache php-json php-zip

admin_manual/installation/example_openbsd.rst

@@ -208,7 +208,7 @@ Since in OpenBSD httpd(8) works with a chroot(8) by default, we need to be sure
 Nextcloud final steps
 ---------------------
 
-Now that we have all in place, you should go to your browser with your URL (I am asuming you have an SSL already installed)::
+Now that we have all in place, you should go to your browser with your URL (I am assuming you have an SSL already installed)::
 
   https://domain.tld
   

admin_manual/installation/harden_server.rst

@@ -236,7 +236,7 @@ security headers are shipped.
 Connections to remote servers
 -----------------------------
 
-Some functionalites require the Nextcloud server to be able to connect remote systems via https/443.
+Some functionalities require the Nextcloud server to be able to connect remote systems via https/443.
 This pragraph also includes the data which is being transmitted to the Nextcloud GmbH.
 Depending on your server setup, these are the possible connections:
 

admin_manual/installation/server_tuning.rst

@@ -39,7 +39,7 @@ Debug Mode
 
 Verify that ``debug`` is ``false`` in your ``config.php``. The default is ``false`` in new 
 installations (or when not specified). While similar to the DEBUG logging level, this option
-also disables various optimizations (to faciliate easier debugging) and generates additional 
+also disables various optimizations (to facilitate easier debugging) and generates additional 
 debug output both at the browser level and server-side. It should not be enabled in production 
 environments outside of isolated troubleshooting situations.
 

admin_manual/installation/source_installation.rst

@@ -259,7 +259,7 @@ value is often ``5``. This greatly limits simultaneously connections to your
 Nextcloud instance and, unless you are severely resource constraints, will 
 underutilize your hardware. Check the :doc:`../installation/server_tuning` 
 chapter for some guidance and resources for coming up with appropriate values,
-as well as other related paramaters.
+as well as other related parameters.
 
 System environment variables
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -268,7 +268,7 @@ When you are using ``php-fpm``, system environment variables like
 PATH, TMP or others are not automatically populated in the same way as
 when using ``php-cli``. A PHP call like ``getenv('PATH');`` can therefore
 return an empty result. So you may need to manually configure environment
-variables in the appropropriate ``php-fpm`` ini/config file.
+variables in the appropriate ``php-fpm`` ini/config file.
 
 Here are some example root paths for these ini/config files:
 

admin_manual/maintenance/manual_upgrade.rst

@@ -19,7 +19,7 @@ like a lot, but detailed instructions are below.
 .. important::
    Before upgrading, especially between major versions (e.g. v27.y.z -> v28.y.z) please review
    :ref:`critical changes<critical-changes>` first. These are highlights of changes that may be required
-   in your environment to accomodate changes in Nextcloud Server. These notes are periodically revised as
+   in your environment to accommodate changes in Nextcloud Server. These notes are periodically revised as
    needed so it is a good idea to revisit them even when proceeding with minor and maintenance upgrades just
    in case.
 

admin_manual/maintenance/restore.rst

@@ -82,7 +82,7 @@ PostgreSQL
 Synchronising with clients after data recovery
 ----------------------------------------------
 
-By default the Nextcloud server is considered the authorative source for the data.
+By default the Nextcloud server is considered the authoritative source for the data.
 If the data on the server and the client differs
 clients will default to fetching the data from the server.
 

admin_manual/maintenance/update.rst

@@ -174,7 +174,7 @@ The steps are basically the same as for the web based updater:
     a new update available. Go to the admin settings page and scroll to the
     section "Version". This section has a button to open the updater. This
     section as well as the update notification is only available if the update
-    notication app is enabled in the apps management.
+    notification app is enabled in the apps management.
 
 .. image:: images/updater-1-update-available.png
 
@@ -224,7 +224,7 @@ It is possible to run the command line based updater in a non-interactive mode.
 The updater then doesn't ask any interactive questions. It is assumed that if
 an update is available it should be installed and the ``occ upgrade`` command
 is executed as well. After finishing the maintenance mode will be turned off
-except an error occured during the ``occ upgrade`` or the replacement of the
+except an error occurred during the ``occ upgrade`` or the replacement of the
 code.
 
 To execute this, run the command with the ``--no-interaction`` option. (i.e.