diff --git a/docs/development/README.md b/docs/development/README.md index a5d4e77852d3..0728037f0424 100644 --- a/docs/development/README.md +++ b/docs/development/README.md @@ -87,7 +87,7 @@ Project maintainers have the right and responsibility to remove, edit, or reject Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. -This code of conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.0.0, available at http://contributor-covenant.org/version/1/0/0/ +This code of conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.0.0, available at [contributor-covenant.org/version/1/0/0/](https://www.contributor-covenant.org/version/1/0/0/) diff --git a/docs/development/code-review-guidelines/README.md b/docs/development/code-review-guidelines/README.md index 907e4fde1e1d..b5f339b61ded 100644 --- a/docs/development/code-review-guidelines/README.md +++ b/docs/development/code-review-guidelines/README.md @@ -62,8 +62,8 @@ The reviewer should understand the code without explanations outside the code. ## Citations -http://scientopia.org/blogs/goodmath/2011/07/06/things-everyone-should-do-code-review/ +[scientopia.org/blogs/goodmath/2011/07/06/things-everyone-should-do-code-review/](https://blog.csdn.net/zhangmike/article/details/30198411) -http://beust.com/weblog/2006/06/22/why-code-reviews-are-good-for-you/ +[beust.com/weblog/2006/06/22/why-code-reviews-are-good-for-you/](https://beust.com/weblog/2006/06/22/why-code-reviews-are-good-for-you/) -https://developer.mozilla.org/en/Code_Review_FAQ +[www-archive.mozilla.org/hacking/code-review-faq](https://www-archive.mozilla.org/hacking/code-review-faq) diff --git a/docs/development/concepts/hal-resources/README.md b/docs/development/concepts/hal-resources/README.md index 0d992dd7bdd6..076abd7a63e6 100644 --- a/docs/development/concepts/hal-resources/README.md +++ b/docs/development/concepts/hal-resources/README.md @@ -237,5 +237,5 @@ In order to turn the JSON properties from `_embedded` and `_links` into writable ## Discussions -- Due to the dynamic properties of the HAL resource, it traditionally has an index map to `any` which is the source of many typing issues and in turn, quite a number of bugs: https://github.com/opf/openproject/blob/76823ca58179a87afbb5fc0925c3453780dec381/frontend/src/app/modules/hal/resources/hal-resource.ts#L56-L60 +- Due to the dynamic properties of the HAL resource, it traditionally has an index map to `any` which is the source of many typing issues and in turn, quite a number of bugs: [hal-resource.ts](https://github.com/opf/openproject/blob/76823ca58179a87afbb5fc0925c3453780dec381/frontend/src/app/modules/hal/resources/hal-resource.ts#L56-L60) - The way HAL resources work by embedding and allowing to load \ No newline at end of file diff --git a/docs/development/concepts/inline-editing/README.md b/docs/development/concepts/inline-editing/README.md index 64a06db16eaa..99ead65fef3c 100644 --- a/docs/development/concepts/inline-editing/README.md +++ b/docs/development/concepts/inline-editing/README.md @@ -46,7 +46,7 @@ In order to understand the different modes of the inline edition functionality, The display fields handle showing read-only representation of a resource's attribute. For example, the work package table may contain very different kinds of attributes: A progress bar, bare text fields, formatted date fields and the like. -Since OpenProject can also have dynamic custom fields with varying formats, the frontend cannot know all potential attribute names and their types. Instead, the available attributes of a resource are retrieved from its associated [schema resource](../resource-schemas/). For display fields, the important part of the schema definition for an attribute is its `type` attribute. Take a look at the JSON schema response for projects at the community: https://community.openproject.com/api/v3/projects/schema. For the sake of brevity, the following JSON will only show two of the returned attributes: The name and status attribute description: +Since OpenProject can also have dynamic custom fields with varying formats, the frontend cannot know all potential attribute names and their types. Instead, the available attributes of a resource are retrieved from its associated [schema resource](../resource-schemas/). For display fields, the important part of the schema definition for an attribute is its `type` attribute. Take a look at the JSON schema response for projects at the community: [community.openproject.com/api/v3/projects/schema](https://community.openproject.com/api/v3/projects/schema). For the sake of brevity, the following JSON will only show two of the returned attributes: The name and status attribute description: ```json "name": { diff --git a/docs/development/concepts/queries/README.md b/docs/development/concepts/queries/README.md index 03bda3e6fb9c..3d755c14274b 100644 --- a/docs/development/concepts/queries/README.md +++ b/docs/development/concepts/queries/README.md @@ -112,7 +112,7 @@ These filters are also saved within the queries. If you would like to read more ### Exemplary query response -Due to the public nature of the OpenProject community, you can check out the following exemplary query response in HAL+JSON: http://community.openproject.com/api/v3/queries/2453 +Due to the public nature of the OpenProject community, you can check out the following exemplary query response in HAL+JSON: [community.openproject.com/api/v3/queries/2453](https://community.openproject.com/api/v3/queries/2453) It returns a saved query for the OpenProject 11.0 release, with a type filter `type is not [Idea, Phase, Release]` , a version filter `version = 11.0.0` and a "show all subprojects" filter with `subProject = all` . It is sorted by `type ascending`. @@ -176,7 +176,7 @@ In practice, you will likely not only access the query resource itself, but rath The `WorkPackagesListService` can also update and save existing queries passed to it. This flow will often happen in the [`PartitionedQuerySpaceComponent`](https://github.com/opf/openproject/tree/dev/frontend/src/app/modules/work_packages/routing/partitioned-query-space-page/partitioned-query-space-page.component.ts), which is the basis for the modules showing work packages as a table or grid such as the [`WorkPackageViewPageComponent`](https://github.com/opf/openproject/tree/dev/frontend/src/app/modules/work_packages/routing/wp-view-page/wp-view-page.component.ts) or the [`IfcViewerPageComponent`](https://github.com/opf/openproject/tree/dev/frontend/src/app/modules/bim/ifc_models/pages/viewer/ifc-viewer-page.component.ts). -`PartionedQuerySpaceComponent` instances will be instantiated by the router and listen to URL params to load the corresponding query object. The most prominent example of such a page is the work packages module such as https://community.openproject.com/work_packages. +`PartionedQuerySpaceComponent` instances will be instantiated by the router and listen to URL params to load the corresponding query object. The most prominent example of such a page is the work packages module such as [community.openproject.com/work_packages](https://community.openproject.com/work_packages). The partitioning comes from showing a work package table (or cards view) on one side, and a details view of a single work package on another side, splitting the page in two. The width of the split areas can be customized by the user through a drag-handle. diff --git a/docs/development/concepts/resource-schemas/README.md b/docs/development/concepts/resource-schemas/README.md index fa0362d4cfd6..4556eaa85be5 100644 --- a/docs/development/concepts/resource-schemas/README.md +++ b/docs/development/concepts/resource-schemas/README.md @@ -74,7 +74,7 @@ This section describes some of the existing schemas. **Projects** -For projects, there is a single APIv3 endpoint for their schemas: `/api/v3/projects/schema`. This schema is identical for all projects. You can simply request the OpenProject Community schema for projects here: https://community.openproject.com/api/v3/projects/schema. It contains a set of static properties (name, identifier, status, etc.), as well as all project-level custom fields. +For projects, there is a single APIv3 endpoint for their schemas: `/api/v3/projects/schema`. This schema is identical for all projects. You can simply request the OpenProject Community schema for projects [here](https://community.openproject.com/api/v3/projects/schema). It contains a set of static properties (name, identifier, status, etc.), as well as all project-level custom fields. @@ -84,7 +84,7 @@ The work package schema is more complicated, as work package types can be custom This results in work package schemas being defined per project and type combination. The URL of each schema looks like this: `/api/v3/work_packages/schemas/{project id}-{type-id}`. -An exemplary schema response on the Community for the OpenProject project (`ID=14`) and the Bug type (`ID=1`) is https://community.openproject.com/api/v3/work_packages/schemas/14-1 +An exemplary schema response on the Community for the OpenProject project (`ID=14`) and the Bug type (`ID=1`) is [community.openproject.com/api/v3/work_packages/schemas/14-1](https://community.openproject.com/api/v3/work_packages/schemas/14-1) The work package schema also contains the reference to the attribute groups from the form configuration in the `_attributeGroups` property. @@ -96,7 +96,7 @@ The OpenProject frontend usually ensure that whenever you get access to a HAL re In some cases, such as the work package `/api/v3/work_packages` or `/api/v3/queries` endpoints, the needed schemas to represent the work packages contained in the collection are embedded automatically in the `_embedded.schemas` endpoint. Services handling these loaded requests such as the [`WorkPackagesStatesIntializationService`](https://github.com/opf/openproject/blob/dev/frontend/src/app/components/wp-list/wp-states-initialization.service.ts#L97-L101) will automatically update the schema states. -If you look at the HAL+JSON response of a work package API request, you will see it has a `_links.schema.href` property which identifies the schema resource that the loaded work package is associated with. (Exemplary request: http://community.openproject.com/api/v3/work_packages/34250) +If you look at the HAL+JSON response of a work package API request, you will see it has a `_links.schema.href` property which identifies the schema resource that the loaded work package is associated with. ([Exemplary request](https://community.openproject.com/api/v3/work_packages/34250)) If you have work package resource, you can get hold of its associated schema as follows: diff --git a/docs/development/concepts/translations/README.md b/docs/development/concepts/translations/README.md index 03345ae688bc..ff295e5dcbe6 100644 --- a/docs/development/concepts/translations/README.md +++ b/docs/development/concepts/translations/README.md @@ -74,7 +74,7 @@ expect(page).to have_selector('button', text: I18n.t('work_packages.my_specific_ -The Rails guide on translations will give advanced examples on variable interpolation and the like: https://guides.rubyonrails.org/i18n.html +The Rails guide on translations will give advanced examples on variable interpolation and the like: [guides.rubyonrails.org/i18n](https://guides.rubyonrails.org/i18n.html) @@ -127,4 +127,4 @@ Then you can use them as below in your template: -For more information on formatting and other helpers of the `I18n.js` library, see https://github.com/fnando/i18n-js \ No newline at end of file +For more information on formatting and other helpers of the `I18n.js` library, see [github.com/fnando/i18n-js](https://github.com/fnando/i18n-js) diff --git a/docs/development/contribution-documentation/contribution-support/README.md b/docs/development/contribution-documentation/contribution-support/README.md index 2ae6cb08e86d..02f740fa5ad3 100644 --- a/docs/development/contribution-documentation/contribution-support/README.md +++ b/docs/development/contribution-documentation/contribution-support/README.md @@ -13,7 +13,7 @@ If you have any questions on the contribution process or encounter problems with 1. Login to or register at the [OpenProject community platform](https://community.openproject.org/login). It’s fast and free. -2. Open a new [documentation work package]( https://community.openproject.org/projects/openproject/work_packages/new?type=69). +2. Open a new [documentation work package](https://community.openproject.org/projects/openproject/work_packages/new?type=69). 3. Add a precise subject. diff --git a/docs/development/contribution-documentation/documentation-process/README.md b/docs/development/contribution-documentation/documentation-process/README.md index bf8f3aaba74b..f81347d0417d 100644 --- a/docs/development/contribution-documentation/documentation-process/README.md +++ b/docs/development/contribution-documentation/documentation-process/README.md @@ -45,7 +45,7 @@ Redirects are managed in a repository that is not accessible by the OpenProject 2. Check if there is already an existing ticket by using the search bar in the header navigation at the top. If there is one, please leave a comment or add additional information. Otherwise: -3. Open a new [documentation work package]( https://community.openproject.org/projects/openproject/work_packages/new?type=69) +3. Open a new [documentation work package](https://community.openproject.org/projects/openproject/work_packages/new?type=69) 4. Add a precise subject. diff --git a/docs/development/contribution-documentation/documentation-style-guide/README.md b/docs/development/contribution-documentation/documentation-style-guide/README.md index 2d8b65976622..1c1f9ce15386 100644 --- a/docs/development/contribution-documentation/documentation-style-guide/README.md +++ b/docs/development/contribution-documentation/documentation-style-guide/README.md @@ -37,7 +37,7 @@ Within each folder there is a sub-hierarchy of topics. E.g. in the Getting start ### Folder content -We aim to have a clear hierarchical structure with meaningful URLs like https://www.openproject.org/docs/getting-started/sign-in-registration/. With this structure you can identify straight away that this part of the documentation is about the sign in and registration process. At the same time, the website path matches our repository, making it easy to update the documentation. +We aim to have a clear hierarchical structure with meaningful URLs like `https://www.openproject.org/docs/getting-started/sign-in-registration/`. With this structure you can identify straight away that this part of the documentation is about the sign in and registration process. At the same time, the website path matches our repository, making it easy to update the documentation. Find an overview of content per folder here: diff --git a/docs/development/create-openproject-plugin/README.md b/docs/development/create-openproject-plugin/README.md index e1fa759dde2d..b8d65e021421 100644 --- a/docs/development/create-openproject-plugin/README.md +++ b/docs/development/create-openproject-plugin/README.md @@ -122,9 +122,9 @@ It is probably best to use READMEs of already released plugins as a template. - Ensure gemspec fields are complete and version number is correct - `gem build .gemspec` - `gem push -.gem`. This asks for your user/password -- Go to https://rubygems.org, log in, go to the dashboard, click on the uploaded gem, click edit. Set URLs, at least source code URL and Bug Tracker URL +- Go to [rubygems.org](https://rubygems.org), log in, go to the dashboard, click on the uploaded gem, click edit. Set URLs, at least source code URL and Bug Tracker URL - You are done . -- *Be careful when publishing a gem.Once it is published, it cannot be replaced in the same version*. It is only possible to take a version out of the index and publish a new version. +- *Be careful when publishing a gem. Once it is published, it cannot be replaced in the same version*. It is only possible to take a version out of the index and publish a new version. ### Create public visibility diff --git a/docs/development/development-environment-docker/README.md b/docs/development/development-environment-docker/README.md index d3133f6674cc..9064d90f9021 100644 --- a/docs/development/development-environment-docker/README.md +++ b/docs/development/development-environment-docker/README.md @@ -19,7 +19,7 @@ bin/compose setup bin/compose start ``` -Once the containers are done booting you can access the application under http://localhost:3000. +Once the containers are done booting you can access the application under `http://localhost:3000`. ### Tests @@ -104,7 +104,7 @@ However, these are cached in a docker volume. Meaning that from the 2nd run onwa Wait until you see `frontend_1 | : Compiled successfully.` and `backend_1 | => Rails 6.0.2.2 application starting in development http://0.0.0.0:3000` in the logs. This means both frontend and backend have come up successfully. -You can now access OpenProject under http://localhost:3000, and via the live-reloaded under http://localhost:4200. +You can now access OpenProject under `http://localhost:3000`, and via the live-reloaded under `http://localhost:4200`. Again the first request to the server can take some time too. But subsequent requests will be a lot faster. diff --git a/docs/development/development-environment-osx/README.md b/docs/development/development-environment-osx/README.md index 0cc162496bf6..8a82ba0eb8c7 100644 --- a/docs/development/development-environment-osx/README.md +++ b/docs/development/development-environment-osx/README.md @@ -95,7 +95,7 @@ $ nodenv init ### Install latest LTS node version -You can find the latest LTS version here: https://nodejs.org/en/download/ +You can find the latest LTS version here: [nodejs.org/en/download](https://nodejs.org/en/download/) At the time of writing this is v14.17.0. Install and activate it with: @@ -195,14 +195,14 @@ gem install foreman foreman start -f Procfile.dev ``` The application will be available at `http://127.0.0.1:5000`. To customize bind address and port copy the `.env.example` provided in the root of this -project as `.env` and [configure values][foreman-env] as required. +project as `.env` and [configure values](https://ddollar.github.io/foreman/#ENVIRONMENT) as required. By default a worker process will also be started. In development asynchronous execution of long-running background tasks (sending emails, copying projects, etc.) may be of limited use. To disable the worker process: echo "concurrency: web=1,assets=1,worker=0" >> .foreman -For more information refer to Foreman documentation section on [default options][foreman-defaults]. +For more information refer to Foreman documentation section on [default options](https://ddollar.github.io/foreman/#DEFAULT-OPTIONS). You can access the application with the admin-account having the following credentials: @@ -251,5 +251,3 @@ If an error occurs, it should be logged there (as well as in the output to STDOU If you have any further questions, comments, feedback, or an idea to enhance this guide, please tell us at the appropriate community.openproject.org [forum](https://community.openproject.org/projects/openproject/boards/9). [Follow OpenProject on twitter](https://twitter.com/openproject), and follow [the news](https://www.openproject.org/blog) to stay up to date. -[foreman-defaults]:http://ddollar.github.io/foreman/#DEFAULT-OPTIONS -[foreman-env]:http://ddollar.github.io/foreman/#ENVIRONMENT diff --git a/docs/development/development-environment-ubuntu/README.md b/docs/development/development-environment-ubuntu/README.md index 63e917dec4e5..a4bde91f5d32 100644 --- a/docs/development/development-environment-ubuntu/README.md +++ b/docs/development/development-environment-ubuntu/README.md @@ -137,7 +137,7 @@ git clone https://github.com/nodenv/node-build.git $(nodenv root)/plugins/node-b ### Install latest LTS node version -You can find the latest LTS version here: https://nodejs.org/en/download/ +You can find the latest LTS version here: [nodejs.org/en/download/](https://nodejs.org/en/download/) At the time of writing this is v16.13.1 Install and activate it with: @@ -176,7 +176,7 @@ npm --version In order to create a pull request to the core OpenProject repository, you will want to fork it to your own GitHub account. This allows you to create branches and push changes and finally opening a pull request for us to review. -To do that, go to https://github.com/opf/openproject and press "Fork" on the upper right corner. +To do that, go to [github.com/opf/openproject](https://github.com/opf/openproject) and press "Fork" on the upper right corner. ```bash # Download the repository @@ -246,14 +246,14 @@ gem install foreman foreman start -f Procfile.dev ``` The application will be available at `http://127.0.0.1:3000`. To customize bind address and port copy the `.env.example` provided in the root of this -project as `.env` and [configure values][foreman-env] as required. +project as `.env` and [configure values](https://ddollar.github.io/foreman/#ENVIRONMENT) as required. By default a worker process will also be started. In development asynchronous execution of long-running background tasks (sending emails, copying projects, etc.) may be of limited use. To disable the worker process: echo "concurrency: web=1,assets=1,worker=0" >> .foreman -For more information refer to Foreman documentation section on [default options][foreman-defaults]. +For more information refer to Foreman documentation section on [default options](https://ddollar.github.io/foreman/#DEFAULT-OPTIONS). You can access the application with the admin-account having the following credentials: @@ -300,6 +300,3 @@ If an error occurs, it should be logged there (as well as in the output to STDOU If you have any further questions, comments, feedback, or an idea to enhance this guide, please tell us at the appropriate community.openproject.org [forum](https://community.openproject.org/projects/openproject/boards/9). [Follow OpenProject on twitter](https://twitter.com/openproject), and follow [the news](https://www.openproject.org/blog) to stay up to date. - -[foreman-defaults]:http://ddollar.github.io/foreman/#DEFAULT-OPTIONS -[foreman-env]:http://ddollar.github.io/foreman/#ENVIRONMENT diff --git a/docs/development/git-workflow/README.md b/docs/development/git-workflow/README.md index 0c5cb7fbb3a3..c0f6ed5b926a 100644 --- a/docs/development/git-workflow/README.md +++ b/docs/development/git-workflow/README.md @@ -12,7 +12,7 @@ keywords: development workflow, gitflow, git flow This guide will introduce you to how we at OpenProject develop OpenProject with Git, and how to contribute code. For other ways on how to contribute to OpenProject, [please see the contribution guide](../#contributor-code-of-conduct). -The OpenProject core is developed fully at our GitHub repository at https://github.com/opf/openproject. In the course of this guide, we assume that you are familiar with Git. If you need a refresher on certain topics, we recommend the [free Pro Git online book](https://git-scm.com/book/en/v2) as a resource for all topics on Git. +The OpenProject core is developed fully at our [GitHub repository](https://github.com/opf/openproject). In the course of this guide, we assume that you are familiar with Git. If you need a refresher on certain topics, we recommend the [free Pro Git online book](https://git-scm.com/book/en/v2) as a resource for all topics on Git. @@ -49,7 +49,7 @@ The basic overview of how to contribute code to OpenProject is as follows. For contributing source code, please follow the git workflow below: -- Use GitHub UI to fork the [OpenProject repository](https://github.com/opf/openproject) https://github.com/opf/openproject. +- Use GitHub UI to fork the [OpenProject repository](https://github.com/opf/openproject). - Clone your fork to your development machine: ``` diff --git a/docs/development/running-tests/README.md b/docs/development/running-tests/README.md index a36a079621eb..7923605361ce 100644 --- a/docs/development/running-tests/README.md +++ b/docs/development/running-tests/README.md @@ -216,7 +216,7 @@ In case you are on Windows using WSL2 rather than Linux directly, running tests **1) Download the chrome web driver** -You can find the driver for your Chrome version here: https://chromedriver.chromium.org/downloads +You can find the driver for your Chrome version [here](https://chromedriver.chromium.org/downloads) **2) Add the driver to your `PATH`** @@ -229,7 +229,7 @@ It will be called something like "Ethernet adapter vEthernet (WSL)". **4) Download Selenium hub** -Download version 3.141.59 (at the time of writing) here: https://www.selenium.dev/downloads/ +Download version 3.141.59 (at the time of writing) [here](https://www.selenium.dev/downloads/) The download is a JAR, i.e. a Java application. You will also need to download and install a Java Runtime Environment in at least version 8 to be able to run it. @@ -360,7 +360,7 @@ RAILS_ENV=test bundle exec parallel_rspec -- modules/team_planner/spec ## Manual acceptance tests * Sometimes you want to test things manually. Always remember: If you test something more than once, write an automated test for it. -* Assuming you do not have a version of Edge already installed on your computer, you can grab a VM with preinstalled IE's directly from Microsoft: http://www.modern.ie/en-us/virtualization-tools#downloads +* Assuming you do not have a version of Edge already installed on your computer, you can grab a VM with preinstalled IE's directly from [Microsoft](https://developer.microsoft.com/en-us/microsoft-edge/tools/vms/) diff --git a/docs/development/security/README.md b/docs/development/security/README.md index d0b2663923e1..76c7965e8711 100644 --- a/docs/development/security/README.md +++ b/docs/development/security/README.md @@ -4,15 +4,15 @@ At its core, OpenProject is an open-source software that is [developed and publi Automated tests and manual code reviews ensure that these contributions are safe for the entire community of OpenProject. These tests encompass the correctness of security and access control features. We have ongoing collaborations with security professionals from to test the OpenProject code base for security exploits. -For more information on security and data privacy for OpenProject, please visit: https://www.openproject.org/security-and-privacy/. +For more information on security and data privacy for OpenProject, please visit: [www.openproject.org/security-and-privacy](https://www.openproject.org/security-and-privacy/). ## Security announcements mailing list -We provide a mailing list for security advisories on OpenProject at . Please register there to get immediate notifications as we publish them. No messages except for security advisories or security related announcements will be sent there. +We provide a mailing list for security advisories on OpenProject at [groups.google.com/g/openproject-security](https://groups.google.com/g/openproject-security). Please register there to get immediate notifications as we publish them. No messages except for security advisories or security related announcements will be sent there. -Any security related information will also be published on our blog and website at https://www.openproject.com +Any security related information will also be published on our [blog and website](https://www.openproject.com) To join this mailing list, please use the UI if you have a google account. If you don't, you can send an empty email to [openproject-security+subscribe@googlegroups.com](mailto:openproject-security+subscribe@googlegroups.com). You will get a join request, which you again have to reply with any content. diff --git a/docs/enterprise-guide/enterprise-cloud-guide/enterprise-cloud-faq/README.md b/docs/enterprise-guide/enterprise-cloud-guide/enterprise-cloud-faq/README.md index c241efd8fd72..4cb7c82223e4 100644 --- a/docs/enterprise-guide/enterprise-cloud-guide/enterprise-cloud-faq/README.md +++ b/docs/enterprise-guide/enterprise-cloud-guide/enterprise-cloud-faq/README.md @@ -11,7 +11,7 @@ keywords: Enterprise cloud FAQ, Cloud Edition, hosted by OpenProject ## How can I test the Enterprise cloud version? -Simply create a 14 days free trial on: https://start.openproject.com/. Enter your organization name in small letters, without spaces (e.g. openproject) and press the blue Start Free Trial button. +Simply create a 14 days free trial on: [start.openproject.com](https://start.openproject.com/). Enter your organization name in small letters, without spaces (e.g. openproject) and press the blue Start Free Trial button. ## How can I book additional users for the Enterprise cloud? diff --git a/docs/enterprise-guide/enterprise-cloud-guide/gdpr-compliance/README.md b/docs/enterprise-guide/enterprise-cloud-guide/gdpr-compliance/README.md index a1d903d931f8..e7fac354f212 100644 --- a/docs/enterprise-guide/enterprise-cloud-guide/gdpr-compliance/README.md +++ b/docs/enterprise-guide/enterprise-cloud-guide/gdpr-compliance/README.md @@ -60,7 +60,7 @@ OpenProject provides means to fully erase both all identifiable information of a ### Data Portability OpenProject provides means to data controllers in order to receive *all* personal data connected to the OpenProject instance. This encompasses all user and system data (in the form of an SQL dump) as well as a collection of all uploaded files. -This is now possible by controllers on their own using the backup feature of OpenProject: https://www.openproject.org/docs/enterprise-guide/enterprise-cloud-guide/backups/. +This is now possible by controllers on their own using the [backup feature of OpenProject](../backups/). ## Signing a Data Processing Agreement (DPA) for the Enterprise cloud diff --git a/docs/enterprise-guide/enterprise-cloud-guide/openproject-cloud-status/README.md b/docs/enterprise-guide/enterprise-cloud-guide/openproject-cloud-status/README.md index a73736366997..20e498bdbfe6 100644 --- a/docs/enterprise-guide/enterprise-cloud-guide/openproject-cloud-status/README.md +++ b/docs/enterprise-guide/enterprise-cloud-guide/openproject-cloud-status/README.md @@ -51,7 +51,7 @@ We are currently seeing elevated response times and degraded performance. We are ### April 20th, 2018 -(3:00 UTC) The OpenProject Cloud Edition is currently not available in Russia since the IP address is being blocked in connection with blocking Telegram ([more information](http://www.bbc.com/news/technology-43797176)). +(3:00 UTC) The OpenProject Cloud Edition is currently not available in Russia since the IP address is being blocked in connection with blocking Telegram ([more information](https://www.bbc.com/news/technology-43797176)). (3:00 UTC) The OpenProject Cloud Edition service is currently not available in Russia. diff --git a/docs/enterprise-guide/enterprise-on-premises-guide/enterprise-on-premises-faq/README.md b/docs/enterprise-guide/enterprise-on-premises-guide/enterprise-on-premises-faq/README.md index da9cd0168d60..598c2866de2a 100644 --- a/docs/enterprise-guide/enterprise-on-premises-guide/enterprise-on-premises-faq/README.md +++ b/docs/enterprise-guide/enterprise-on-premises-guide/enterprise-on-premises-faq/README.md @@ -20,7 +20,7 @@ If you do not yet have an own Community installation, the easiest way to test Op The Enterprise on-premises edition is an upgrade of the self-hosted Community Edition. When you are already using the Community Edition, you can purchase an Enterprise on-premises edition license to upgrade to the Enterprise on-premises edition. To do this, follow these steps: -1. Navigate to https://www.openproject.org/enterprise-edition/. +1. Navigate to [www.openproject.org/enterprise-edition/](https://www.openproject.org/enterprise-edition/). 2. Click on the "Book now" button. 3. Follow the steps to purchase the Enterprise on-premises edition license. You will then receive an Enterprise on-premises edition license key by email which you can use to upgrade your Community Edition to the Enterprise on-premises edition. diff --git a/docs/faq/README.md b/docs/faq/README.md index eb556431976a..603b79d3d0c6 100644 --- a/docs/faq/README.md +++ b/docs/faq/README.md @@ -142,7 +142,7 @@ The projects overview is not optimized for export via PDF, yet. Nevertheless, yo ### How can I receive the OpenProject newsletter? -Please go to https://www.openproject.org/newsletter/ and submit your data to receive our newsletter. Another option would be to agree to receive the newsletter when creating your account. +Please go to [openproject.org/newsletter/](https://www.openproject.org/newsletter/) and submit your data to receive our newsletter. Another option would be to agree to receive the newsletter when creating your account. ## FAQ regarding features diff --git a/docs/installation-and-operations/configuration/README.md b/docs/installation-and-operations/configuration/README.md index 87f51919f0b3..acd5f8f54d0a 100644 --- a/docs/installation-and-operations/configuration/README.md +++ b/docs/installation-and-operations/configuration/README.md @@ -117,7 +117,7 @@ omniauth provider if additional ones are configured. OpenProject uses gravatar images with a `404` fallback by default to render an internal, initials-based avatar. You can override this behavior by setting `gravatar_fallback_image` to a different value to always render Gravatars -For supported values, please see https://en.gravatar.com/site/implement/images/ +For supported values, please see [en.gravatar.com/site/implement/images/](https://en.gravatar.com/site/implement/images/) ### Attachments storage diff --git a/docs/installation-and-operations/configuration/repositories/README.md b/docs/installation-and-operations/configuration/repositories/README.md index 42f4be02f3e1..eef3d6a51d31 100644 --- a/docs/installation-and-operations/configuration/repositories/README.md +++ b/docs/installation-and-operations/configuration/repositories/README.md @@ -162,7 +162,7 @@ With managed repositories, OpenProject takes care of the lifetime of repositorie ## Preliminary Setup -In the remainder of this document, we assume that you run OpenProject using a separate process, which listens for requests on http://localhost:3000 that you serve over Apache using a proxy. +In the remainder of this document, we assume that you run OpenProject using a separate process, which listens for requests on `http://localhost:3000` that you serve over Apache using a proxy. We let Apache serve Subversion and git repositories (with the help of some modules) and authenticate against the OpenProject user database. diff --git a/docs/installation-and-operations/installation-faq/README.md b/docs/installation-and-operations/installation-faq/README.md index 7dc6258206b2..720343656420 100644 --- a/docs/installation-and-operations/installation-faq/README.md +++ b/docs/installation-and-operations/installation-faq/README.md @@ -74,7 +74,7 @@ Please follow these steps: 1. Make a dump of files you might have uploaded. You can refer to the [Bitnami documentation](https://docs.bitnami.com/general/apps/openproject/) to perform a full dump. 1. Copy both dumps to the server you want to install OpenProject on. 1. Install OpenProject using the packaged installation. -1. By default, this will allow you to install a PostgreSQL database, which we recommend. You can migrate your data from MySQL using https://pgloader.io +1. By default, this will allow you to install a PostgreSQL database, which we recommend. You can migrate your data from MySQL using [pgloader](https://pgloader.io) 1. Import the dump into your new database. You can get your configuration by running `sudo openproject config:get DATABASE_URL` 1. Extract the Bitnami backup, and copy your file assets into the relevant directory (e.g. in `/var/db/openproject/files` for uploaded files) 1. Restart OpenProject @@ -115,7 +115,7 @@ Set a higher number of web workers to allow more processes to be handled at the There are two different types of emails in OpenProject: One sent directly within the request to the server (this includes the test mail) and one sent asynchronously, via a background job from the backend. The majority of mail sending jobs is run asynchronously to facilitate a faster response time for server request. -Use a browser to call your domain name followed by "health_checks/all" (e.g. https://myopenproject.com/health_checks/all). There should be entries about "delayed_jobs_backed_up" and "delayed_jobs_never_ran". If PASSED is written behind it, everything is good. +Use a browser to call your domain name followed by "health_checks/all" (e.g. `https://myopenproject.com/health_checks/all`). There should be entries about "delayed_jobs_backed_up" and "delayed_jobs_never_ran". If PASSED is written behind it, everything is good. If the health check does not return satisfying results, have a look if the background worker is running by entering `ps aux | grep jobs` on the server. If it is not running, no entry is returned. If it is running an entry with "jobs:work" at the end is displayed. diff --git a/docs/installation-and-operations/installation/docker/README.md b/docs/installation-and-operations/installation/docker/README.md index 9c1f71f3e68e..fa2a790ec487 100644 --- a/docs/installation-and-operations/installation/docker/README.md +++ b/docs/installation-and-operations/installation/docker/README.md @@ -48,7 +48,7 @@ Launch the containers: docker-compose up -d ``` -After a while, OpenProject should be up and running on . The default username and password is login: `admin`, and password: `admin`. +After a while, OpenProject should be up and running on `http://localhost:8080`. The default username and password is login: `admin`, and password: `admin`. Note that the `docker-compose.yml` file present in the repository can be adjusted to your convenience. For instance you could mount specific configuration files, override environment variables, or switch off services you don't need. Please refer to the official [Docker Compose documentation](https://docs.docker.com/compose/extends/) for more details. @@ -74,7 +74,7 @@ minutes you should see a success message indicating the default administration password (login: `admin`, password: `admin`). You can then launch a browser and access your new OpenProject installation at -. Easy! +`http://localhost:8080`. Easy! To stop the container, simply hit CTRL-C. @@ -333,7 +333,7 @@ To just give it a quick try you can run this: docker run -p 8080:80 --rm -it openproject-with-slack ``` -After which you can access OpenProject under http://localhost:8080. +After which you can access OpenProject under `http://localhost:8080`. ## Offline/air-gapped installation @@ -554,7 +554,7 @@ canb3m7ilkjn openproject_web replicated 1/1 7ovn0sbu8a7w openproject_worker replicated 1/1 openproject/community:12 ``` -You can now access OpenProject under [http://0.0.0.0:8080](http://0.0.0.0:8080). +You can now access OpenProject under `http://0.0.0.0:8080`. This endpoint then can be used in a apache reverse proxy setup as shown further up, for instance. Don't worry about one of the services (openproject_seeder) having 0/1 replicas. diff --git a/docs/installation-and-operations/installation/manual/README.md b/docs/installation-and-operations/installation/manual/README.md index 641825a21d78..e37cf0237407 100644 --- a/docs/installation-and-operations/installation/manual/README.md +++ b/docs/installation-and-operations/installation/manual/README.md @@ -61,7 +61,7 @@ sudo passwd openproject #(enter desired password) ## Install and setup the database server (PostgreSQL) -OpenProject requires PostgreSQL v9.5+. If you system package is too old, you can check https://www.postgresql.org/download/ to get a newer version installed. In our case, Ubuntu 18.04 comes with a recent-enough version so we can use the system packages: +OpenProject requires PostgreSQL v9.5+. If you system package is too old, you can check [postgresql.org](https://www.postgresql.org/download/) to get a newer version installed. In our case, Ubuntu 18.04 comes with a recent-enough version so we can use the system packages: ```bash [root@host] apt-get install postgresql postgresql-contrib libpq-dev @@ -95,7 +95,7 @@ Lastly, revert to the previous system user: ## Installation of Ruby The are several possibilities to install Ruby on your machine. We will -use [rbenv](http://rbenv.org/). Please be aware that the actual installation of a specific Ruby version takes some +use [rbenv](https://github.com/rbenv/rbenv). Please be aware that the actual installation of a specific Ruby version takes some time to finish. ```bash @@ -148,7 +148,7 @@ v14.16.0 ## Installation of OpenProject We will install the OpenProject Community Edition. It contains the recommended set of plugins for use -with OpenProject. For more information, see https://github.com/opf/openproject. +with OpenProject. For more information, see [github.com/opf/openproject](https://github.com/opf/openproject). ```bash @@ -214,7 +214,7 @@ rails_cache_store: :memcache ``` __NOTE:__ You should validate your `yml` files, for example with -http://www.yamllint.com/. Both, the `database.yml` and `configuration.yml` +[yamlchecker.com](https://yamlchecker.com/). Both, the `database.yml` and `configuration.yml` file are sensitive to whitespace. It is pretty easy to write invalid `yml` files without seeing the error. Validating those files prevents you from such errors. diff --git a/docs/installation-and-operations/installation/packaged/README.md b/docs/installation-and-operations/installation/packaged/README.md index 3fdddb70c21d..7e96802d2305 100644 --- a/docs/installation-and-operations/installation/packaged/README.md +++ b/docs/installation-and-operations/installation/packaged/README.md @@ -74,7 +74,7 @@ sudo apt-get update sudo apt-get install openproject ``` -Then finish the installation by reading the [*Initial configuration*][initial-config] section. +Then finish the installation by reading the [*Initial configuration*](#initial-configuration) section. @@ -100,7 +100,7 @@ sudo apt-get update sudo apt-get install openproject ``` -Then finish the installation by reading the [*Initial configuration*][initial-config] section. +Then finish the installation by reading the [*Initial configuration*](#initial-configuration) section. ### Ubuntu 16.04 @@ -124,7 +124,7 @@ sudo apt-get update sudo apt-get install openproject ``` -Then finish the installation by reading the [*Initial configuration*][initial-config] section. +Then finish the installation by reading the [*Initial configuration*](#initial-configuration) section. ## Debian Installation @@ -150,7 +150,7 @@ sudo apt-get update sudo apt-get install openproject ``` -Then finish the installation by reading the [*Initial configuration*][initial-config] section. +Then finish the installation by reading the [*Initial configuration*](#initial-configuration) section. ### Debian 10 @@ -174,7 +174,7 @@ sudo apt-get update sudo apt-get install openproject ``` -Then finish the installation by reading the [*Initial configuration*][initial-config] section. +Then finish the installation by reading the [*Initial configuration*](#initial-configuration) section. ### Debian 9 @@ -198,7 +198,7 @@ sudo apt-get update sudo apt-get install openproject ``` -Then finish the installation by reading the [*Initial configuration*][initial-config] section. +Then finish the installation by reading the [*Initial configuration*](#initial-configuration) section. ## CentOS Installation @@ -223,7 +223,7 @@ Download the OpenProject package: sudo yum install openproject ``` -Then finish the installation by reading the [*Initial configuration*][initial-config] section. +Then finish the installation by reading the [*Initial configuration*](#initial-configuration) section. **Note:** On this distribution full-text extraction for attachments [*is not supported*](#full-text-extraction-not-supported) by default. @@ -242,7 +242,7 @@ Download the OpenProject package: sudo yum install openproject ``` -Then finish the installation by reading the [*Initial configuration*][initial-config] section. +Then finish the installation by reading the [*Initial configuration*](#initial-configuration) section. **Note:** On this distribution full-text extraction for attachments [*is not supported*](#full-text-extraction-not-supported) by default. @@ -263,12 +263,10 @@ Download the OpenProject package: sudo zypper install openproject ``` -Then finish the installation by reading the [*Initial configuration*][initial-config] section. +Then finish the installation by reading the [*Initial configuration*](#initial-configuration) section. **Note:** On SLES12 full-text extraction for attachments [*is not supported*](#full-text-extraction-not-supported) by default. -[initial-config]: #initial-configuration - # Full-text extraction not supported For some distributions we do not provide the required dependencies for full-text extraction of attachments. If you need this feature, please install the required dependencies (`catdoc unrtf poppler-utils tesseract-ocr`) manually. For more information, [please see the plaintext gem](https://github.com/planio-gmbh/plaintext). Once installed, check `Administration > Information` to see if OpenProject is able to pick up these dependencies. diff --git a/docs/installation-and-operations/installation/univention/README.md b/docs/installation-and-operations/installation/univention/README.md index 757742af8c39..e7cde5142b2f 100644 --- a/docs/installation-and-operations/installation/univention/README.md +++ b/docs/installation-and-operations/installation/univention/README.md @@ -5,7 +5,7 @@ sidebar_navigation: # OpenProject in Univention App Center -Univention App Center is the marketplace in [Univention Corporate Server (UCS)](https://www.univention.com/products/ucs/), an enterprise operating platform for infrastructure and identity management. OpenProject is available in the [App Center]( https://www.univention.com/appid/openproject/) and comes integrated with the identity management. +Univention App Center is the marketplace in [Univention Corporate Server (UCS)](https://www.univention.com/products/ucs/), an enterprise operating platform for infrastructure and identity management. OpenProject is available in the [App Center](https://www.univention.com/appid/openproject/) and comes integrated with the identity management. **App Appliance for easy deployment** diff --git a/docs/installation-and-operations/misc/docker-postgresql-migration/README.md b/docs/installation-and-operations/misc/docker-postgresql-migration/README.md index 4310d8ef7972..56a188d91b4a 100644 --- a/docs/installation-and-operations/misc/docker-postgresql-migration/README.md +++ b/docs/installation-and-operations/misc/docker-postgresql-migration/README.md @@ -20,7 +20,7 @@ In any case, you may also use the internally configured PostgreSQL instance of t If you want to set up a PostgreSQL installation database outside the container and not use the built-in database, please set up a PostgreSQL database now. These are generic apt-based installation steps, please adapt them appropriately for your distribution. -OpenProject requires at least PostgreSQL 9.5 installed. Please check if your distributed package is too old. +OpenProject requires at least PostgreSQL 9.5 installed. Please check [www.postgresql.org/download](https://www.postgresql.org/download/) if your distributed package is too old. ```bash [root@host] apt-get install postgresql postgresql-contrib libpq-dev diff --git a/docs/installation-and-operations/misc/migration-to-postgresql13/README.md b/docs/installation-and-operations/misc/migration-to-postgresql13/README.md index af8d73b0d887..b2850e1ad086 100644 --- a/docs/installation-and-operations/misc/migration-to-postgresql13/README.md +++ b/docs/installation-and-operations/misc/migration-to-postgresql13/README.md @@ -5,8 +5,10 @@ OpenProject version 12+ will default to PostgreSQL 13. If you have an existing O ## Package-based installation Please first check whether this guide applies to you at all. Only PostgreSQL installations that were installed by the OpenProject package are applicable to this guide. @@ -19,7 +21,7 @@ sudo cat /etc/openproject/installer.dat | grep postgres/autoinstall And verify that it outputs: postgres/autoinstall **install**. -If that is not the case, you are likely using a self-provisioned database or a remote database. In this case, please follow the instructions from your provider or use generic PostgreSQL upgrade guides. A guide we can recommend for Debian/Ubuntu based servers is this one: https://gorails.com/guides/upgrading-postgresql-version-on-ubuntu-server Please adapt that guide or the following steps to your distribution. +If that is not the case, you are likely using a self-provisioned database or a remote database. In this case, please follow the instructions from your provider or use generic PostgreSQL upgrade guides. A guide we can recommend for Debian/Ubuntu based servers is [this one](https://gorails.com/guides/upgrading-postgresql-version-on-ubuntu-server). Please adapt that guide or the following steps to your distribution. In the following, we assume that you initially let OpenProject setup your PostgreSQL installation, using a local database. @@ -174,29 +176,28 @@ sudo rm -rf /var/lib/pgsql/10/data sudo yum remove pgsql10 ``` -[pg_upgrade]: https://www.postgresql.org/docs/10/pgupgrade.html -[package-based-installation]: ../../installation/packaged/ - ## Compose-based docker installation You can find the upgrade instructions for your docker-compose setup in the [openproject-deploy](https://github.com/opf/openproject-deploy/blob/stable/12/compose/control/README.md#upgrade) repository. Remember that you need to have checked out that repository and work in the `compose` directory for the instructions to work. -[compose-based-installation]: ../../installation/docker/#one-container-per-process-recommended - ## All-in-one docker installation The newer version of OpenProject includes an utility to automatically perform the upgrade for you. Assuming you followed the standard installation procedure, the folder (within the docker container) containing your PostgreSQL data will be located at `/var/openproject/pgdata`. @@ -276,8 +277,3 @@ Please change the command appropriately for other installation methods. Once con ```sql ANALYZE VERBOSE; ``` - - -[all-in-one-docker-installation]: ../../installation/docker/#all-in-one-container - -[backup-guide]: ../../operation/backing-up/ diff --git a/docs/installation-and-operations/misc/migration/README.md b/docs/installation-and-operations/misc/migration/README.md index 2ce349b7c51f..7d90b755bd3b 100644 --- a/docs/installation-and-operations/misc/migration/README.md +++ b/docs/installation-and-operations/misc/migration/README.md @@ -25,7 +25,7 @@ To stop the servers from being accessed on the old installation, stop the servic ## Install new package -Follow the first step (**Installation**) of our packaged installation guides at https://www.openproject.org/download-and-installation/. +Follow the first step (**Installation**) of our [packaged installation guides](https://www.openproject.org/download-and-installation/). After this step, you should have an installed version of `openproject`. diff --git a/docs/installation-and-operations/misc/packaged-postgresql-migration/README.md b/docs/installation-and-operations/misc/packaged-postgresql-migration/README.md index d202ab4c07c3..4d86c3a4297a 100644 --- a/docs/installation-and-operations/misc/packaged-postgresql-migration/README.md +++ b/docs/installation-and-operations/misc/packaged-postgresql-migration/README.md @@ -18,7 +18,7 @@ This guide should leave you with a set of archives that you can use to restore, ## Installation of pgloader -We ship a custom version of pgloader (named `pgloader-ccl`), which embeds some memory optimizations useful when you are migrating from a large MySQL database. This also allows us to provide a unified migration experience for all installation types. This package is available for all the currently supported distributions at https://packager.io/gh/opf/pgloader-ccl. +We ship a custom version of pgloader (named `pgloader-ccl`), which embeds some memory optimizations useful when you are migrating from a large MySQL database. This also allows us to provide a unified migration experience for all installation types. This package is available for all the currently supported distributions at [https://packager.io/gh/opf/pgloader-ccl](https://packager.io/gh/opf/pgloader-ccl). ### Ubuntu 18.04 @@ -70,7 +70,7 @@ sudo zypper install pgloader-ccl If you have not yet installed and set up a PostgreSQL installation database, please set up a PostgreSQL database now. -OpenProject requires at least PostgreSQL 9.5 installed. Please check if your distributed package is too old. +OpenProject requires at least PostgreSQL 9.5 installed. Please check [www.postgresql.org/download](https://www.postgresql.org/download/) if your distributed package is too old. ```bash [root@host] apt-get install postgresql postgresql-contrib libpq-dev diff --git a/docs/release-notes/12-0-4/README.md b/docs/release-notes/12-0-4/README.md index cc476f8c4308..bcf126b86086 100644 --- a/docs/release-notes/12-0-4/README.md +++ b/docs/release-notes/12-0-4/README.md @@ -23,7 +23,7 @@ OpenProject versions >= 12.0.0 are vulnerable to a SQL injection in the budgets The vulnerability has been fixed in version 12.0.4. Versions prior to 12.0.0 are not affected. If you're upgrading from an older version, ensure you are upgrading to at least version 12.0.4. #### Workaround -If you are unable to upgrade in a timely fashion, the following patch can be applied: https://github.com/opf/openproject/pull/9983.patch +If you are unable to upgrade in a timely fashion, the following patch can be applied: [https://github.com/opf/openproject/pull/9983.patch](https://github.com/opf/openproject/pull/9983.patch) #### Credits This security issue was responsibly disclosed by [Daniel Santos](https://github.com/bananabr) (Twitter [@bananabr](https://twitter.com/bananabr)). Thank you for reaching out to us and your help in identifying this issue. If you have a security vulnerability you would like to disclose, please see our [statement on security](https://www.openproject.org/docs/development/security/). diff --git a/docs/release-notes/4-1-0/README.md b/docs/release-notes/4-1-0/README.md index a4e0053f0186..d69644bd7b5f 100644 --- a/docs/release-notes/4-1-0/README.md +++ b/docs/release-notes/4-1-0/README.md @@ -70,8 +70,7 @@ updated: ## **New design through Foundation framework** -The underlying CSS-framework is changed to “Foundation”: -. This change ensures an easier +The underlying CSS-framework is changed to [Foundation](https://get.foundation/). This change ensures an easier adaptability in the future and allows a more responsive design. As a result, the overall design of the application has been changed with OpenProject 4.1. diff --git a/docs/system-admin-guide/authentication/kerberos/README.md b/docs/system-admin-guide/authentication/kerberos/README.md index 2d24cb54d0e2..8f1ce967f76b 100644 --- a/docs/system-admin-guide/authentication/kerberos/README.md +++ b/docs/system-admin-guide/authentication/kerberos/README.md @@ -15,7 +15,7 @@ keywords: Kerberos, authentication **Note**: This documentation is valid for the OpenProject Enterprise Edition only. -[Kerberos](https://web.mit.edu/kerberos/) allows you to authenticate user requests to a service within a computer network. You can integrate it with OpenProject with the use of [Kerberos Apache module](http://modauthkerb.sourceforge.net/) (`mod_auth_kerb`) plugging into the OpenProject packaged installation using Apache web server. +[Kerberos](https://web.mit.edu/kerberos/) allows you to authenticate user requests to a service within a computer network. You can integrate it with OpenProject with the use of [Kerberos Apache module](https://github.com/S2-/mod_auth_kerb) (`mod_auth_kerb`) plugging into the OpenProject packaged installation using Apache web server. This guide will also apply for Docker-based installation, if you have an outer proxying server such as Apache2 that you can configure to use Kerberos. This guide however focuses on the packaged installation of OpenProject. diff --git a/docs/system-admin-guide/authentication/ldap-authentication/README.md b/docs/system-admin-guide/authentication/ldap-authentication/README.md index 094f8945ae8d..14961a7322b4 100644 --- a/docs/system-admin-guide/authentication/ldap-authentication/README.md +++ b/docs/system-admin-guide/authentication/ldap-authentication/README.md @@ -72,8 +72,8 @@ You can set other TLS options for the LDAP auth source connection. They are pass See the following resources for more information: -- https://github.com/ruby-ldap/ruby-net-ldap/blob/master/lib/net/ldap.rb -- https://ruby.github.io/openssl/OpenSSL/SSL/SSLContext.html +- [https://github.com/ruby-ldap/ruby-net-ldap/blob/master/lib/net/ldap.rb](https://github.com/ruby-ldap/ruby-net-ldap/blob/master/lib/net/ldap.rb) +- [https://ruby.github.io/openssl/OpenSSL/SSL/SSLContext.html](https://ruby.github.io/openssl/OpenSSL/SSL/SSLContext.html) #### LDAP system user credentials diff --git a/docs/system-admin-guide/authentication/openid-providers/README.md b/docs/system-admin-guide/authentication/openid-providers/README.md index cbca94c73feb..d665d17bb89b 100644 --- a/docs/system-admin-guide/authentication/openid-providers/README.md +++ b/docs/system-admin-guide/authentication/openid-providers/README.md @@ -44,7 +44,7 @@ You can configure the following options. 3. Create a new project and a new app or edit an existing project and an existing app, setting the following fields (shall be Internal): 1. **App name** (e.g. EXAMPLE.COM SSO) 2. **User support email** (e.g. user-support@example.com) - 3. **App domains** (at minimum, you must provide the Application home page - e.g. https://example.openproject.com) + 3. **App domains** (at minimum, you must provide the Application home page - e.g. `https://example.openproject.com`) 4. **Authorized domains** (e.g. openproject.com) 5. **Developer Contact information** (e.g. developer@example.com) 6. Click **SAVE AND CONTINUE** to proceed. diff --git a/docs/system-admin-guide/authentication/recaptcha/README.md b/docs/system-admin-guide/authentication/recaptcha/README.md index a3c27bf63234..08481f49542e 100644 --- a/docs/system-admin-guide/authentication/recaptcha/README.md +++ b/docs/system-admin-guide/authentication/recaptcha/README.md @@ -10,7 +10,7 @@ keywords: reCAPTCHA To activate and **configure reCAPTCHA** for OpenProject, navigate to -> *Administration* -> *Authentication* and choose -> reCAPTCHA. - If enabled, a captcha form will be rendered upon login for all users that have not verified a captcha yet. Please see the following link for more details on reCAPTCHA and their versions, and how to create the website and secret keys: https://www.google.com/recaptcha. + If enabled, a captcha form will be rendered upon login for all users that have not verified a captcha yet. Please see the following link for more details on reCAPTCHA and their versions, and how to create the website and secret keys: [https://www.google.com/recaptcha](https://www.google.com/recaptcha). You can configure the following options: diff --git a/docs/system-admin-guide/system-settings/display-settings/README.md b/docs/system-admin-guide/system-settings/display-settings/README.md index 1543a1758c17..2e8fbf020a55 100644 --- a/docs/system-admin-guide/system-settings/display-settings/README.md +++ b/docs/system-admin-guide/system-settings/display-settings/README.md @@ -32,7 +32,7 @@ Change time and date formats in OpenProject and configure the display of journal - For European ISO-8601 standard, set Week starts on to `Monday` and First week in year to `Thursday`. - For US and Canada, set Week starts on to `Sunday` and Day of Year to `6`. - If you leave both on `Based on user's language`, the information provided by moment.js will be used: For more information, please also see [this document from moment.js](https://momentjscom.readthedocs.io/en/latest/moment/07-customization/16-dow-doy/). - - For more information on the way the first week of the year is computed according to ISO standards, see https://en.wikipedia.org/wiki/ISO_week_date#First_week + - For more information on the way the first week of the year is computed according to ISO standards, see [wikipedia](https://en.wikipedia.org/wiki/ISO_week_date#First_week) 3. **Date format**: default is based on user's language. You can choose various formats to display dates in the system. 4. **Time format**: default is based on user's language. You can choose various formats to display time in the system. 5. **Users display format**: default is [First name] [Last name]. You can change to various different formats. diff --git a/docs/user-guide/gantt-chart/README.md b/docs/user-guide/gantt-chart/README.md index 526c67bc4d00..e131888f139a 100644 --- a/docs/user-guide/gantt-chart/README.md +++ b/docs/user-guide/gantt-chart/README.md @@ -65,7 +65,7 @@ Select the item to which you want to create a dependency. The precede and follow ![dependencies-gantt-chart](dependencies-gantt-chart-1566556144225.gif) -*OpenProject does not yet include a baseline feature to compare scheduled versions. However, we are aware of the need for it and documented it. Please check here https://community.openproject.com/projects/openproject/work_packages/26448/activity for an update.* +*OpenProject does not yet include a baseline feature to compare scheduled versions. However, we are aware of the need for it and documented it. Please check [here](https://community.openproject.com/projects/openproject/work_packages/26448/activity) for an update.* To find out about **how work packages behave**, when you move their predecessor or follower or change the date of a child work package please read our guide for the [Automatic and manual scheduling mode](scheduling). diff --git a/docs/user-guide/time-and-costs/time-tracking/toggl-integration/README.md b/docs/user-guide/time-and-costs/time-tracking/toggl-integration/README.md index 3c99cb6b5654..09fc6ae960ae 100644 --- a/docs/user-guide/time-and-costs/time-tracking/toggl-integration/README.md +++ b/docs/user-guide/time-and-costs/time-tracking/toggl-integration/README.md @@ -19,7 +19,7 @@ If this add-in is installed, a start/stop button is displayed on the work packag ![Toggl-integration](Toggl-integration.png) -This integration can be added for example for Google Chrome as Chrome Extension: https://chrome.google.com/webstore/detail/toggl-button-productivity/oejgccbfbmkkpaidnkphaiaecficdnfn. +This integration can be added for example for Google Chrome as [Chrome Extension](https://chrome.google.com/webstore/detail/toggl-button-productivity/oejgccbfbmkkpaidnkphaiaecficdnfn). You can then transfer the recorded times from Toggl to OpenProject via the API if needed. Details can be found in our [API documentation](../../../../api/). diff --git a/docs/user-guide/wiki/wiki-faq/README.md b/docs/user-guide/wiki/wiki-faq/README.md index b667a8ffddc2..88539cf925e5 100644 --- a/docs/user-guide/wiki/wiki-faq/README.md +++ b/docs/user-guide/wiki/wiki-faq/README.md @@ -37,7 +37,7 @@ Also, you have the possibility to display the wiki’s Table of Contents, which ### I activated the wiki module in the project settings but cannot see any wiki in the project menu. What happened? -You have probably unchecked the option “show as menu item in project navigation” within the wiki settings “configure menu item” (s.a.). Type in the URL of any wiki page in the browser: https://www.openproject.org/projects/“project_name”/wiki to open the wiki. Open “configure menu item” for this page and choose the way you want this wiki to be displayed in the menu bar. +You have probably unchecked the option “show as menu item in project navigation” within the wiki settings “configure menu item” (s.a.). Type in the URL of any wiki page in the browser: `https://www.openproject.org/projects/“project_name”/wiki` to open the wiki. Open “configure menu item” for this page and choose the way you want this wiki to be displayed in the menu bar. ### What is the markup language of the wiki in OpenProject?