Merge pull request #14617 from opf/documentation/markdown-fixes

Documentation: markdown, urls & typo fixes

docs/api/apiv3/example/README.md

@@ -10,9 +10,9 @@ of choice.
 
 While being limited to the work package resource, the same principles apply throughout the API.
 
-## Fetching work packages from community.openproject.com
+## Fetching work packages from community.openproject.org
 
-Because it is readily at hand, we will first fetch a list of work packages from [community.openproject.com](https://community.openproject.com).
+Because it is readily at hand, we will first fetch a list of work packages from [community.openproject.org](https://community.openproject.org).
 
 In its simplest form, fetching work packages looks like this:
 
@@ -239,7 +239,7 @@ Adapting the request we issued against the community installation, the client ca
 ![get all work packages](./get-work-packages-all.png)
 
 This however will return all work packages the authenticated user employing the client is eligible to see, which might potentially be thousands of work packages.
-The server will always limit the amount of work packages actually returned (and will indicate the total amount by the `total` attribute that is part of the `WorkPackageColletion` resource) but using this method to find an individual work packages is laborious.
+The server will always limit the amount of work packages actually returned (and will indicate the total amount by the `total` attribute that is part of the `WorkPackageCollection` resource) but using this method to find an individual work packages is laborious.
 
 That is why the [API supports filters](../filters). The filter that is applied most easily, is the filter for the project. This filter can be applied requesting via a project scoped url:
 

docs/api/apiv3/openapi-spec.yml

@@ -73,7 +73,7 @@ info:
 
     ```shell
     API_KEY=2519132cdf62dcf5a66fd96394672079f9e9cad1
-    curl -u apikey:$API_KEY https://community.openproject.com/api/v3/users/42
+    curl -u apikey:$API_KEY https://community.openproject.org/api/v3/users/42
     ```
 
     ### OAuth2.0 authentication

docs/api/apiv3/tags/filters.yml

@@ -35,7 +35,7 @@ description: |-
   With the above JSON stringified and URL-encoded, this can be added to the `/api/v3/work_packages` endpoint using the `filter` parameter to form the URL:
 
   ```
-  https://community.openproject.com/api/v3/work_packages?filters=%5B%7B%22subjectOrId%22:%7B%22operator%22:%22**%22,%22values%22:%5B%2212%22%5D%7D%7D,%7B%22status%22:%7B%22operator%22:%22=%22,%22values%22:%5B%225%22%5D%7D%7D%5D
+  https://community.openproject.org/api/v3/work_packages?filters=%5B%7B%22subjectOrId%22:%7B%22operator%22:%22**%22,%22values%22:%5B%2212%22%5D%7D%7D,%7B%22status%22:%7B%22operator%22:%22=%22,%22values%22:%5B%225%22%5D%7D%7D%5D
   ```
 
   ## Compression
@@ -48,13 +48,13 @@ description: |-
   Instead of the request
 
   ```
-  https://community.openproject.com/api/v3/work_packages?filters=[%7B%22subjectOrId%22:%7B%22operator%22:%22**%22,%22values%22:[%2212%22]%7D%7D,%7B%22status%22:%7B%22operator%22:%22=%22,%22values%22:[%225%22]%7D%7D]&pageSize=10&sortBy=[[%22id%22,%20%22asc%22]]
+  https://community.openproject.org/api/v3/work_packages?filters=[%7B%22subjectOrId%22:%7B%22operator%22:%22**%22,%22values%22:[%2212%22]%7D%7D,%7B%22status%22:%7B%22operator%22:%22=%22,%22values%22:[%225%22]%7D%7D]&pageSize=10&sortBy=[[%22id%22,%20%22asc%22]]
   ```
 
   Which in a non URL encoded style would be
 
   ```
-  https://community.openproject.com/api/v3/work_packages?filters=[{"subjectOrId":{"operator":"**","values":["12"]}},{"status":{"operator":"=","values":["5"]}}]&pageSize=10&sortBy=[["id", "asc"]]
+  https://community.openproject.org/api/v3/work_packages?filters=[{"subjectOrId":{"operator":"**","values":["12"]}},{"status":{"operator":"=","values":["5"]}}]&pageSize=10&sortBy=[["id", "asc"]]
   ```
 
   All of the props can be put inside a json object
@@ -72,12 +72,12 @@ description: |-
   That json object can then be compressed and encoded and the result sent over as the combined `eprops` parameter:
 
   ```
-  https://community.openproject.com/api/v3/work_packages?eprops=eJxtjTELwjAUhP%2FLjSWDFVwCLt2cHBz7OsT2VSKFlLwXQUv%2Bu0lXHe%2B7%2B7gN%0As1%2BUo8Ci3wiS7k8e9RovE8EWEFaOTkMsidA0BEN4uSWxFNIT2iNhyNlUV50m%0A%2BaOdf6zTLg0wkBC1e9f3gv20L52Mpa%2Ft6h588x%2BGbQ%2F5C12YN%2BM%3D%0A
+  https://community.openproject.org/api/v3/work_packages?eprops=eJxtjTELwjAUhP%2FLjSWDFVwCLt2cHBz7OsT2VSKFlLwXQUv%2Bu0lXHe%2B7%2B7gN%0As1%2BUo8Ci3wiS7k8e9RovE8EWEFaOTkMsidA0BEN4uSWxFNIT2iNhyNlUV50m%0A%2BaOdf6zTLg0wkBC1e9f3gv20L52Mpa%2Ft6h588x%2BGbQ%2F5C12YN%2BM%3D%0A
   ```
 
   ## Available filters
 
-  The availability of filters depend on the endpoint you're querying and will be listed in each endpoint definition. For work packages, you can also [start using filters in the work packages module](https://community.openproject.com/projects/openproject/work_packages) to build your query and then simply copy the URL from your browser to get the resulting filter values and their operators.
+  The availability of filters depend on the endpoint you're querying and will be listed in each endpoint definition. For work packages, you can also [start using filters in the work packages module](https://community.openproject.org/projects/openproject/work_packages) to build your query and then simply copy the URL from your browser to get the resulting filter values and their operators.
 
   ## Available operators
 

docs/bim-guide/README.md

@@ -41,7 +41,7 @@ Details: [BIM Issue Management](bim-issue-management)
 
 ## Revit add-in
 
-Stay always connected to OpenProject in realtime, show and create tasks while you're working in the Revit, using the Revit Addin.
+Stay always connected to OpenProject in realtime, show and create tasks while you're working in the Revit, using the Revit Add-in.
 
 Details: [Revit Add-in](revit-add-in)
 
@@ -61,7 +61,7 @@ The BCF Module and the included IFC viewer can be enabled for every single proje
 
 ## Reporting bugs
 
-You found a bug? Please [report it](../development/report-a-bug) to our [OpenProject community](https://community.openproject.com/projects/revit-add-in). Thank you!
+You found a bug? Please [report it](../development/report-a-bug) to our [OpenProject community](https://community.openproject.org/projects/revit-add-in). Thank you!
 
 
 
@@ -85,13 +85,13 @@ In our [Installation & Upgrade Guide](../installation-and-operations/bim-edition
 
 ### Is OpenProject BIM compatible to other BIM software?
 
-Yes of course. We are of the opinion that the full potential of the BIM method only works through collaboration and the exchange of information (openBIM). For this reason we support the open BCF XML Standard. You are able to import and export all created BCF and stay interoparable with any other BCF software.
+Yes of course. We are of the opinion that the full potential of the BIM method only works through collaboration and the exchange of information (openBIM). For this reason we support the open BCF XML Standard. You are able to import and export all created BCF and stay interoperable with any other BCF software.
 
 
 
 ### Why do I need a Revit add-in?
 
-You don't need it, but it makes your BIM Issue Management much easier. The *OpenProject Revit Add-In* allows you to use the open source project management software *OpenProject BIM* directly within your Autodesk Revit environment. It lets you create, inspect and manage issues right in the moment when you can also solve them - when you have your Revit application fired up and the relevant BIM models open. Issues get stored as BIM Issues centrally and are available to every team member in real time - thanks to our browser based IFC viewer even to those team members without expensive Revit licenses. No BCF XML import/export is needed. However, you still can import and export BCF XML as you like and stay interoparable with any other BCF software.
+You don't need it, but it makes your BIM Issue Management much easier. The *OpenProject Revit Add-In* allows you to use the open source project management software *OpenProject BIM* directly within your Autodesk Revit environment. It lets you create, inspect and manage issues right in the moment when you can also solve them - when you have your Revit application fired up and the relevant BIM models open. Issues get stored as BIM Issues centrally and are available to every team member in real time - thanks to our browser based IFC viewer even to those team members without expensive Revit licenses. No BCF XML import/export is needed. However, you still can import and export BCF XML as you like and stay interoperable with any other BCF software.
 
 
 
@@ -103,7 +103,7 @@ The OpenProject Revit Add-In does not have any special system requirements. Only
 
 ### Which versions of Revit are supported?
 
-The OpenProject BIM Addin for Revit supports the following versions:
+The OpenProject BIM Add-in for Revit supports the following versions:
 
 - REVIT 2019 
 - REVIT 2020 
@@ -113,13 +113,13 @@ The OpenProject BIM Addin for Revit supports the following versions:
 
 ### Is it possible to use OpenProject BIM without Revit?
 
-Yes! The Revit Add-In is just additional to the OpenProject BIM core functionality. It's still possible to import and export BCF XML as you like and stay interoparable with any other Software for BIM Issue Management.
+Yes! The Revit Add-In is just additional to the OpenProject BIM core functionality. It's still possible to import and export BCF XML as you like and stay interoperable with any other Software for BIM Issue Management.
 
 
 
 ### Are integrations with other BIM software planned?
 
-Yes, we want to develop some other integrations to stay interoparable with other BIM software and make BIM Issue Management with OpenProject BIM much easier.
+Yes, we want to develop some other integrations to stay interoperable with other BIM software and make BIM Issue Management with OpenProject BIM much easier.
 
 
 

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

@@ -125,7 +125,7 @@ To create BIM Issues you don't have to configure additional work package types.
 
 You can switch between different View modes within the OpenProject toolbar. Just open the dropdown menu and select the view which fits best to your situation.
 
- ![Swicht_View_Mode](Swicht_View_Mode.gif)
+ ![Switch View Mode](Swicht_View_Mode.gif)
 
 
 
@@ -233,7 +233,7 @@ If attributes of the imported BCF Issue can't be matched automatically (because
 
 After a successful matching of the attributes the topics will be displayed in OpenProject. 
 
-![Successfull BCF Import](successfull-bcf-import.png) 
+![Successful BCF Import](successfull-bcf-import.png) 
 
 
 

docs/bim-guide/ifc-viewer/README.md

@@ -44,7 +44,7 @@ To upload your first IFC model click on the green "+ IFC Model" - Button. A new
 
 
 
-Select the file you want and confirm your upload. You also the choice to set the new model as "Default model". All default models (multiple models can be set as default) are initially shown if you relaod the BCF module. You are able to change this setting later as well.
+Select the file you want and confirm your upload. You also the choice to set the new model as "Default model". All default models (multiple models can be set as default) are initially shown if you reload the BCF module. You are able to change this setting later as well.
 
 ![Set Model as Default](set-model-as-default.png)
 
@@ -99,7 +99,7 @@ If your building model (or objects within the model) is rotated, zoomed or cut a
 
 ![2D View](2-d-view.png)
 
-If your building model can easily be shown in 2D or 3D. This function is very popular to have a deeper look into the building (e.g. to see the floorplan). To use this function in the best way, you are able to combine the 2D view with hiding elements (like it is shown below).
+If your building model can easily be shown in 2D or 3D. This function is very popular to have a deeper look into the building (e.g. to see the floor plan). To use this function in the best way, you are able to combine the 2D view with hiding elements (like it is shown below).
 
 ![2D_3D](2D_3D.gif)
 
@@ -109,7 +109,7 @@ If your building model can easily be shown in 2D or 3D. This function is very po
 
 ![Orthographic Button](orthographic-button.png)
 
-The default behavior of the OpenProject BIM Model Viewer is a perspective view. The perspective camera gives you more information about depth. Distant objects are smaller than nerby ones. This function changes from perspective view to orthographic view.  The orthographic view is widely used in engineering. All objects appear at the same scale and parallel lines remain parallel. Also a unit length appears the same length anywhere on the screen. This makes it easier to assess the relative sizes. 
+The default behavior of the OpenProject BIM Model Viewer is a perspective view. The perspective camera gives you more information about depth. Distant objects are smaller than nearby ones. This function changes from perspective view to orthographic view.  The orthographic view is widely used in engineering. All objects appear at the same scale and parallel lines remain parallel. Also a unit length appears the same length anywhere on the screen. This makes it easier to assess the relative sizes. 
 
 ![Orthographic View](orthographic-view.png)
 
@@ -127,7 +127,7 @@ This function allows you to reset the current zoom level and the position of the
 
 ![First Person Button](first-person-button.png)
 
-The first person perspective changes the way you ineract with the building model. The user no longer rotates the entire building model around an axis. Now he has the option of changing their own perspective. After activating the first person perspective, the viewer behaves similar to the real world and the camera moves in a manner comparable to a head movement.
+The first person perspective changes the way you interact with the building model. The user no longer rotates the entire building model around an axis. Now he has the option of changing their own perspective. After activating the first person perspective, the viewer behaves similar to the real world and the camera moves in a manner comparable to a head movement.
 
 ![First_Person_Perspective](First_Person_Perspective.gif)
 
@@ -173,7 +173,7 @@ To select elements within the building model, you have to activate the selection
 
 ## Show properties
 
-You are able to see the basic properties of each element (e.g. the UUID) within OpenProject BIM. After using the "information" buttion a new tab named "Properties" will appear. 
+You are able to see the basic properties of each element (e.g. the UUID) within OpenProject BIM. After using the "information" button a new tab named "Properties" will appear. 
 
 ![Show Properties Button](show-properties-button.png)
 

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

@@ -8,7 +8,7 @@ keywords: BIM, BCF, IFC, Viewer
 
 # Revit add-in (BIM feature)
 
-The *OpenProject Revit Add-In* allows you to use the open source project management software *OpenProject BIM* directly within your Autodesk Revit environment. It lets you create, inspect and manage issues right in the moment when you can also solve them - when you have your Revit application fired up and the relevant BIM models open. Issues get stored as BIM Issues centrally and are available to every team member in real time - thanks to our browser based IFC viewer even to those team members without expensive Revit licenses. No BCF XML import/export is needed. However, you still can import and export BCF XML as you like and stay interoparable with any other software for BIM Issue Management.
+The *OpenProject Revit Add-In* allows you to use the open source project management software *OpenProject BIM* directly within your Autodesk Revit environment. It lets you create, inspect and manage issues right in the moment when you can also solve them - when you have your Revit application fired up and the relevant BIM models open. Issues get stored as BIM Issues centrally and are available to every team member in real time - thanks to our browser based IFC viewer even to those team members without expensive Revit licenses. No BCF XML import/export is needed. However, you still can import and export BCF XML as you like and stay interoperable with any other software for BIM Issue Management.
 
 To download the latest version (v2.2.3) of our OpenProject Revit AddIn click here: [DOWNLOAD](https://github.com/opf/openproject-revit-add-in/releases/download/v2.3.3/OpenProject.Revit.exe)
 
@@ -22,10 +22,10 @@ To download the latest version (v2.2.3) of our OpenProject Revit AddIn click her
 Please check the following steps before using the OpenProject BIM edition.
 
 1. Does OpenProject BIM support your [Version of Revit](#system-requirements)?
-2. Did you already install the latest Version of our OpenProject BIM Addin?
+2. Did you already install the latest Version of our OpenProject BIM Add-in?
 3. Is the latest IFC Model uploaded to your Project in OpenProject BIM?
 
-If you can answer all questions with "yes" you are ready to start using our Revit Addin.
+If you can answer all questions with "yes" you are ready to start using our Revit Add-in.
 
 
 
@@ -115,7 +115,7 @@ The settings will appear in a new tab. Within this tab you have to insert your o
 
 After connecting your OpenProject BIM instance you are able to start working with your BCF Tasks within Revit. Firstly you have to open the **OpenProject Tab** in the taskbar and start the application. 
 
-![Start OpenProject BIM Addin](OpenProject_BIM_Start.png)
+![Start OpenProject BIM Add-in](OpenProject_BIM_Start.png)
 
 
 
@@ -213,4 +213,4 @@ To proceed with the installation, click on *Run Anyway* and the installation wil
 
 ## Reporting bugs
 
-You found a bug? Please [report it](../../development/report-a-bug) to our [OpenProject community](https://community.openproject.com/projects/revit-add-in). Thank you!
+You found a bug? Please [report it](../../development/report-a-bug) to our [OpenProject community](https://community.openproject.org/projects/revit-add-in). Thank you!

docs/development/README.md

@@ -10,7 +10,7 @@ We are pleased that you are thinking about contributing to OpenProject! This gui
 
 ## Get in touch
 
-Please get in touch with us using our [development forum](https://community.openproject.com/projects/openproject/forums/7) or send us an email to [email protected].
+Please get in touch with us using our [development forum](https://community.openproject.org/projects/openproject/forums/7) or send us an email to [email protected].
 
 
 
@@ -22,7 +22,7 @@ We eat our own ice cream so we use OpenProject for roadmap planning and team col
 
 - [Wish list](https://community.openproject.org/projects/openproject/work_packages?query_id=180)
 
-- [Bug backlog](https://community.openproject.com/projects/openproject/work_packages?query_id=491)
+- [Bug backlog](https://community.openproject.org/projects/openproject/work_packages?query_id=491)
 
 - [Reporting a bug](report-a-bug)