Merge pull request #14647 from opf/documentation/spelling

Documentation consistent spelling and typo fixes

docs/api/README.md

@@ -20,7 +20,7 @@ We try to keep stable releases of OpenProject with changes to this API backwards
 
 The API v3 is a general purpose API supporting multiple use cases.
 
-While by no means complete, a whole lot of different scenarios can be automatised which otherwise would have to be carried out by hand via the UI. 
+While by no means complete, a whole lot of different scenarios can be automatized which otherwise would have to be carried out by hand via the UI. 
 Examples for this include managing work packages, projects and users.
 
 ➔ [Go to OpenProject API](./introduction/)

docs/api/apiv3/example/README.md

@@ -25,7 +25,7 @@ Please notice that no headers and no credentials need to be provided. Because th
 ## Authentication
 
 In a default OpenProject installation however, credentials are necessary to even access the instance, so this guide will assume this
-default behaviour to apply further on. Only in very limited use cases should an unauthenticated access ever be allowed.
+default behavior to apply further on. Only in very limited use cases should an unauthenticated access ever be allowed.
 
 Without authentication, a client will be informed of the missing credentials as demonstrated below when issuing a  request
 identical to the one above against a locally run installation:

docs/bim-guide/bim-issue-management/README.md

@@ -45,7 +45,7 @@ Then, navigate to the BCF module in the project navigation.
 
 To create new BIM Issues, you have to open the Model - Viewer first and create the view you want to save within the BIM Issue (e.g. zoom, [rotate](../ifc-viewer/#how-to-rotate-the-building-model), [slice](../ifc-viewer/#how-to-slice-the-building-model), [select](../ifc-viewer/#how-to-select-elements), [hide](../ifc-viewer/#show-or-hide-models-or-elements-via-model-tree), … ). 
 
-Click on the **+ Create new work package** and select the type of workpackage you want. 
+Click on the **+ Create new work package** and select the type of work package you want. 
 
 ![Create a new BIM Issue](create-a-new-BIM-issue.png)
 
@@ -76,7 +76,7 @@ Open the **BCF-Module** to see the building model.
 
 Make sure the "Model Viewer & Maps" - View or "Model Viewer & Table" - View is selected within the **OpenProject-Toolbar**.
 
-![Model and workpackage view](model_maps_view.png)
+![Model and work package view](model_maps_view.png)
 
 
 
@@ -187,9 +187,9 @@ You are able to filter BIM Issues by using the filter button in the **OpenProjec
 
 
 
-## BIM issues in workpackage module
+## BIM issues in work package module
 
-BIM Issues are also listed in the workpackage module. This supports you to manage your building project in the best way and get an overview of all issues. To separate work packages and BIM Issues we created a new filter which enables you to filter BIM Issues.
+BIM Issues are also listed in the work package module. This supports you to manage your building project in the best way and get an overview of all issues. To separate work packages and BIM Issues we created a new filter which enables you to filter BIM Issues.
 
 ![BIM Issues and work packages](bim-issues-and-work-packages.png)
 

docs/bim-guide/revit-add-in/README.md

@@ -133,7 +133,7 @@ To work with BIM Issues, please open our AddIn and navigate to our BCF Module.
 
 
 
-Within this module all existing work packages are displayed. Within this demo project no work package exist yet. To create a new one, click on the "add new workpackage"-Button.  
+Within this module all existing work packages are displayed. Within this demo project no work package exist yet. To create a new one, click on the "add new work package"-Button.  
 
 ![OpenProject BIM - Create BCF](OpenProject_BIM_Create_BCF.png)
 

docs/development/accessibility-checklist/README.md

@@ -32,7 +32,7 @@ To help development teams prioritize accessibility implementation and remediatio
 
 ### 2.1. Keyboard usability
 * All page functionality is available using the keyboard, unless the functionality cannot be accomplished in any known way using a keyboard (e.g., free hand drawing).
-* Page-specified shortcut keys and accesskeys (accesskey should typically be avoided) do not conflict with existing browser and screen reader shortcuts.
+* Page-specified shortcut keys and access keys (access key should typically be avoided) do not conflict with existing browser and screen reader shortcuts.
 * Keyboard focus is never locked or trapped at one particular page element. The user can navigate to and from all navigable page elements using only a keyboard.
 * All page functionality is available using the keyboard.
 

docs/development/application-architecture/README.md

@@ -133,7 +133,7 @@ See the [Roadmap](https://community.openproject.org/projects/openproject/roadmap
 
 ## Versioning
 
-OpenProject follows [Semantic Versioning](https://semver.org/). Therefore, the version is a composition of three digits in the format of e.g. 0.1.1 and can be summarised as followed:
+OpenProject follows [Semantic Versioning](https://semver.org/). Therefore, the version is a composition of three digits in the format of e.g. 0.1.1 and can be summarized as followed:
 
 - MAJOR version when you make incompatible API changes,
 - MINOR version when you add functionality in a backwards-compatible manner, and

docs/development/concepts/secure-coding/README.md

@@ -217,7 +217,7 @@ As OpenProject may handle and distribute sensitive user data, attack vectors suc
   - Whitelist for uploads can be provided by MIME type, rejecting any non-matching files
   - OpenProject currently does not provide a built-in virus scanner. However, using [webhooks](https://www.openproject.org/docs/system-admin-guide/api-and-webhooks/#webhooks) and the [attachments API](https://www.openproject.org/docs/api/endpoints/attachments/), users can plug existing virus scanning tools and scrub any uploaded files.
 - *Malware in software*:
-  - OpenProject uses statical code analysis on every change provided to the application as well as code scanners on the artefacts generated from the source code (such as Snyk vulnerability scanner for Docker images).
+  - OpenProject uses statical code analysis on every change provided to the application as well as code scanners on the artifacts generated from the source code (such as Snyk vulnerability scanner for Docker images).
   - We recommend users to perform their own 
 
 
@@ -251,7 +251,7 @@ Inconsiderate use of error handling, logging, and monitoring mechanisms of a web
 - Exception handlers catch all StandardErrors whenever your controller inherits from ApplicationController
 - Exception responses are disconnected from the actual errors and provide user-friendly messages without error details
 - Database transaction wrapping for any actions is wrapped in the [BaseContracted services](https://github.com/opf/openproject/blob/dev/app/services/base_services/base_contracted.rb#L54). Transactions are automatically rolled back in [Rails when exceptions occur](https://api.rubyonrails.org/v5.0.1/classes/ActiveRecord/Transactions/ClassMethods.html).
-- OpenProject uses a LogRage formatter for flexible, yet easily parseable formats
+- OpenProject uses a LogRage formatter for flexible, yet easily parsable formats
 
 
 
@@ -296,7 +296,7 @@ https://cheatsheetseries.owasp.org/cheatsheets/Vulnerable_Dependency_Management_
 
 ## Packaging and containerization
 
-Packaging and containerization are critical artefacts in the delivery pipeline of OpenProject. They encapsulate the application and its environment, ensuring consistent operation across different systems and infrastructures. These artefacts need to provide a secure and stable default for maintaining and upgrading OpenProject.
+Packaging and containerization are critical artifacts in the delivery pipeline of OpenProject. They encapsulate the application and its environment, ensuring consistent operation across different systems and infrastructures. These artifacts need to provide a secure and stable default for maintaining and upgrading OpenProject.
 
 Properly managed packaging and containerization pipelines ensure smooth installations, upgrades, and scaling, enhancing the deployment process and - as a result - the overall user experience. This section highlights risks connected to improper containerization or packaging as well as our main objectives and  best practices to provide a secure, efficient, and reliable software delivery process.
 

docs/development/concepts/state-management/README.md

@@ -161,4 +161,4 @@ This might then look like the following, with green color for added objects, and
 ## Discussions
 
 - In contrast to a `Store` concept of redux, the States and state groups do not have any concept of data immutability. As a caller you will need to ensure that. In OpenProject, many of the states are in fact mutable due to historic reasons and the fact that complex class instances are passed around that cannot be easily shallow copied. This will need to be refactored in the future.
-- As the reactivestates library was primarily developed for us, we may need to take over its code or move to a different state management concept altogether. The recent developments in `ngxs` look very promising.
+- As the `reactivestates` library was primarily developed for us, we may need to take over its code or move to a different state management concept altogether. The recent developments in `ngxs` look very promising.

docs/development/contribution-documentation/documentation-process/README.md

@@ -52,7 +52,7 @@ After authenticating your account, you are ready to manage and contribute to pro
 
 ## Step 5: Fork the OpenProject repository 
 
-If you are an external contributor you don't have write permissions on the repository [https://github.com/opf/openproject](https://github.com/opf/openproject). In this case you first need to fork the repository by clicking the button **[Fork](https://github.com/opf/openproject/fork)**. This basically means that you have your own copy of the repository on GitHub.com. Since it is your own repository you have write privileges here.
+If you are an external contributor you don't have write permissions on the repository [https://github.com/opf/openproject](https://github.com/opf/openproject). In this case you first need to fork the repository by clicking the button [Fork](https://github.com/opf/openproject/fork). This basically means that you have your own copy of the repository on GitHub.com. Since it is your own repository you have write privileges here.
 
 ![fork openproject](fork-openproject.png)
 

docs/development/development-environment-docker/README.md

@@ -15,7 +15,7 @@ The quickest way to get started developing OpenProject is to use the docker setu
 
 And nothing else!
 
-## Quickstart
+## Quick start
 
 To get right into it and just start the application you can just do the following:
 

docs/development/product-development-handbook/README.md

@@ -340,7 +340,7 @@ The metrics defined in the Opportunity Canvas are referenced to evaluate this.
 
 The entire team documents possible improvements for the next release.
 
-## 4. Artefacts
+## 4. Artifacts
 
 ### 4.1 Version/Release
 

docs/development/style-guide/frontend/README.md

@@ -121,7 +121,7 @@ means that the respective collections and entities have to be refreshed from the
 2. Changing the type of a work package in the split view changes the collection that is shown in the table, since the
    work package will be filtered out.
 
-For this usecase, we have implemented a global actions service. You can dispatch actions here, and other parts of the
+For this use-case, we have implemented a global actions service. You can dispatch actions here, and other parts of the
 application can listen to these actions. Think of it like a global event bus. These actions are typed.
 
 To reduce server requests, side effects **should be** be calculated in the frontend. If this is impossible, the updating store **must** send out a global event to notify other parts that the specific event occurred.

docs/enterprise-guide/enterprise-cloud-guide/create-cloud-trial/README.md

@@ -24,7 +24,7 @@ Click the Start Free Trial button.
 
 ![create OpenProject trial](image-20191202165638244.png)
 
-You will then be asked to [**create an OpenProject account**](../../../getting-started/sign-in-registration/#create-a-new-account).
+You will then be asked to [create an OpenProject account](../../../getting-started/sign-in-registration/#create-a-new-account).
 
 1. Enter your first and last **name**. 
 2. Enter your **e-mail address**.

docs/getting-started/work-packages-introduction/README.md

@@ -29,9 +29,9 @@ A work package in OpenProject can basically be everything you need to keep track
 
 To get started, create a new work package in your project, [open the project](../projects/#open-an-existing-project) with the project drop-down menu, navigate to the **module work packages** in the project menu.
 
-Within the work packages module, click the green + Create button to create a new work package. In the drop down menu, choose which type of work package you want to create, e.g. a task or a milestone. To create a new work package, you can also select the blue printed + Create a new workpackage writing.
+Within the work packages module, click the green + Create button to create a new work package. In the drop down menu, choose which type of work package you want to create, e.g. a task or a milestone. To create a new work package, you can also select the blue printed + Create a new work package writing.
 
-![create-a-new-workpackage](create-a-new-workpackage.png)
+![create a new work package](create-a-new-workpackage.png)
 
 A split screen view is opened with the new work package form on the right and the table listing already existing work packages on the left.
 

docs/glossary/README.md

@@ -110,7 +110,7 @@ A custom action in OpenProject is defined as customizable buttons which trigger
 
 - [Watch a short video how custom actions work](https://www.openproject.org/docs/system-admin-guide/manage-work-packages/custom-actions/#automated-workflows-with-custom-actions-enterprise-add-on)
 - [Read this guide on how to create custom actions](https://www.openproject.org/docs/system-admin-guide/manage-work-packages/custom-actions/#create-custom-actions)
-- [Read this blog article on how to create an intelligent workflow with custom action - explained with an example](https://www.openproject.org/blog/customise-workflows/)
+- [Read this blog article on how to create an intelligent workflow with custom action - explained with an example](https://www.openproject.org/blog/customize-workflows/)
 
 ### Custom field
 

docs/installation-and-operations/README.md

@@ -19,7 +19,7 @@ This page summarizes the options for getting OpenProject, some hosted and some o
 
 * **Univention App Center** - Download the free Community edition as a pre-installed virtual environment and upgrade to the Enterprise edition with Enterprise add-ons and support. See the [documentation](installation/univention/) for details.
 
-All editions can be enhanced by adding **[the BIM module](../bim-guide/)**, including features for construction project management, i.e. 3D model viewer, BCF management. See how to [switch to that edition](bim-edition/) in the documentation or how to start a [BIM Enterprise cloud edition](https://start.openproject.com/trial/bim).
+All editions can be enhanced by adding [the BIM module](../bim-guide/), including features for construction project management, i.e. 3D model viewer, BCF management. See how to [switch to that edition](bim-edition/) in the documentation or how to start a [BIM Enterprise cloud edition](https://start.openproject.com/trial/bim).
 
 Compare the features of these versions [on the website](https://www.openproject.org/pricing/#features). 
 

docs/installation-and-operations/configuration/README.md

@@ -196,7 +196,7 @@ OpenProject allows you to create and maintain an LDAP connection with optional s
 
 **Note:** These variables are applied whenever `db:seed` rake task is being executed. This happens on every packaged `configure` call or when the seeder container job is being run, so be aware that these changes might happen repeatedly.
 
-The connection can be set with the following options. Please note that "EXAMPLE" stands for an arbitrary name (expressable in ENV keys)  which will become the name of the connection. In this case, "example" and "examplefilter" for the synchronized filter.
+The connection can be set with the following options. Please note that "EXAMPLE" stands for an arbitrary name (expressible in ENV keys)  which will become the name of the connection. In this case, "example" and "examplefilter" for the synchronized filter.
 
 The name of the LDAP connection is derived from the ENV key behind `SEED_LDAP_`, so you need to take care to use only valid characters. If you need to place an underscore, use a double underscore to encode it e.g., `my__ldap`.
 
@@ -624,7 +624,7 @@ Remote git repositories will be checked out here.
 note: to be verified, maybe option was removed, not in environement variables list
 ```
 
-## apiv3 enable basic auth
+## APIv3 enable basic auth
 
 You can control basic auth access to the APIv3 with the following configuration option: