diff --git a/docs/README.md b/docs/README.md index e7dff7774c1..d2f8d974f72 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,7 +7,8 @@ keywords: help, documentation --- # OpenProject Documentation -> **Note**: To better read our OpenProject Documentation, please go to [www.openproject.org/docs/](https://www.openproject.org/docs/). +> [!NOTE] +> For enhanced usability, access the OpenProject documentation at [www.openproject.org/docs/](https://www.openproject.org/docs). ## Installation diff --git a/docs/contributions-guide/contribution-documentation/README.md b/docs/contributions-guide/contribution-documentation/README.md index 09d481aaa12..3e7d6275f5d 100644 --- a/docs/contributions-guide/contribution-documentation/README.md +++ b/docs/contributions-guide/contribution-documentation/README.md @@ -33,7 +33,7 @@ With this guide for contributing to the OpenProject documentation we followed an ## OpenProject documentation overview -The OpenProject documentation provides comprehensive resources, including user guides, system administration, installation and operation instructions, API references, development guides, and release notes. It is available online at [OpenProject Documentation](https://www.openproject.org/docs/), and can also be accessed directly from your OpenProject application via the **Help** menu (question mark icon in the top-right corner). +The OpenProject documentation provides comprehensive resources, including user guides, system administration, installation and operation instructions, API references, development guides, and release notes. It is available online at [OpenProject Documentation](https://www.openproject.org/docs), and can also be accessed directly from your OpenProject application via the **Help** menu (question mark icon in the top-right corner). The documentation supports current and future users by offering step-by-step instructions for setup, configuration, and integration of OpenProject. It also provides detailed use cases, feature guides, and instructions for using OpenProject alongside other applications. diff --git a/docs/contributions-guide/contribution-documentation/documentation-style-guide/README.md b/docs/contributions-guide/contribution-documentation/documentation-style-guide/README.md index a1d6eccacd7..d80267e60d4 100644 --- a/docs/contributions-guide/contribution-documentation/documentation-style-guide/README.md +++ b/docs/contributions-guide/contribution-documentation/documentation-style-guide/README.md @@ -30,7 +30,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 `/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/installation-and-operations/misc/migration-to-postgresql17/README.md b/docs/installation-and-operations/misc/migration-to-postgresql17/README.md index 5b894eeeef4..d64e2ab8249 100644 --- a/docs/installation-and-operations/misc/migration-to-postgresql17/README.md +++ b/docs/installation-and-operations/misc/migration-to-postgresql17/README.md @@ -238,7 +238,7 @@ And then restart OpenProject. ## Helm Chart installation -> Please follow this section only if you have installed OpenProject using [this procedure](https://www.openproject.org/docs/installation-and-operations/installation/helm-chart/). +> Please follow this section only if you have installed OpenProject using [this procedure](../../installation/helm-chart/). > Before attempting the upgrade, please ensure you have performed a backup of your installation by following the [backup guide](../../operation/backing-up/). 1. Stop your frontend or scale it down to 0 to prevent frontend changes. diff --git a/docs/release-notes/10/10-3-0/README.md b/docs/release-notes/10/10-3-0/README.md index 78a0c174036..5adc6b78be1 100644 --- a/docs/release-notes/10/10-3-0/README.md +++ b/docs/release-notes/10/10-3-0/README.md @@ -55,7 +55,7 @@ You can use those custom fields to properly display text with a right-to-left or ## Support -You can find useful information in the [OpenProject help section](https://www.openproject.org/docs/) or you can post your questions in the [OpenProject Forum](https://community.openproject.org/projects/openproject/boards). +You can find useful information in the [OpenProject FAQ](../../../faq/) or you can post your questions in the [OpenProject Forum](https://community.openproject.org/projects/openproject/boards). ### Upgrading your installation to OpenProject 10.3 diff --git a/docs/release-notes/11/11-3-0/README.md b/docs/release-notes/11/11-3-0/README.md index f482a8cecf8..3fda8706a5a 100644 --- a/docs/release-notes/11/11-3-0/README.md +++ b/docs/release-notes/11/11-3-0/README.md @@ -213,7 +213,7 @@ We update hosted OpenProject environments (Enterprise cloud) automatically. ## Support -You will find useful information in the OpenProject [Documentation](https://www.openproject.org/docs/) or you can post your questions in the [Forum](https://community.openproject.org/projects/openproject/boards). +You will find useful information in the [OpenProject FAQ](../../../faq/) or you can post your questions in the [Forum](https://community.openproject.org/projects/openproject/boards). ## Credits diff --git a/docs/system-admin-guide/integrations/nextcloud/README.md b/docs/system-admin-guide/integrations/nextcloud/README.md index 8e0f8bc845a..30077c6fb08 100644 --- a/docs/system-admin-guide/integrations/nextcloud/README.md +++ b/docs/system-admin-guide/integrations/nextcloud/README.md @@ -13,8 +13,7 @@ keywords: Nextcloud file storage integration > [!IMPORTANT] > > The integration between OpenProject and Nextcloud is part of the open source and free of charge **Community edition**, including all file management functionalities. -> -> However, please note that setting up the Single Sign-on via OpenID Connect Identity Provider is an Enterprise Add-on and can only be used with [Enterprise cloud](https://www.openproject.org/docs/enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](https://www.openproject.org/docs/enterprise-guide/enterprise-on-premises-guide). This Add-On is available for all installations under the [Enterprise Corporate plan](https://www.openproject.org/pricing/). +> However, please note that setting up the Single Sign-on via OpenID Connect Identity Provider is an Enterprise Add-on and can only be used with [Enterprise cloud](../../../enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](../../../enterprise-guide/enterprise-on-premises-guide). This Add-On is available for all installations under the [Enterprise Corporate plan](https://www.openproject.org/pricing/). | Topic | Description | |---------------------------------------------------------------------|:---------------------------------------------------------------------| @@ -107,7 +106,7 @@ The next part of the setup will vary depending on your chosen authentication met > [!NOTE] > -> This advanced feature is is an Enterprise add-on and can only be used with [Enterprise cloud](https://www.openproject.org/docs/enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](https://www.openproject.org/docs/enterprise-guide/enterprise-on-premises-guide). It is available for all installations under the Enterprise Corporate plan. An upgrade from the free community edition is easy and helps support OpenProject. +> This advanced feature is an Enterprise add-on and can only be used with [Enterprise cloud](../../../enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](../../../enterprise-guide/enterprise-on-premises-guide). It is available for all installations under the Enterprise Corporate plan. An upgrade from the free community edition is easy and helps support OpenProject. Instructions for both authentication methods can be found on the following pages: diff --git a/docs/system-admin-guide/integrations/nextcloud/oidc-sso/README.md b/docs/system-admin-guide/integrations/nextcloud/oidc-sso/README.md index be14d4e341f..0d56d2f8e0c 100644 --- a/docs/system-admin-guide/integrations/nextcloud/oidc-sso/README.md +++ b/docs/system-admin-guide/integrations/nextcloud/oidc-sso/README.md @@ -9,7 +9,7 @@ keywords: Nextcloud file storage integration # Set up Single Sign-On through OpenID Connect Identity Provider (Enterprise add-on) > [!NOTE] -> This advanced feature is is an Enterprise add-on and can only be used with [Enterprise cloud](https://www.openproject.org/docs/enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](https://www.openproject.org/docs/enterprise-guide/enterprise-on-premises-guide). It is available for all installations under the Enterprise Corporate plan. An upgrade from the free community edition is easy and helps support OpenProject. +> This advanced feature is an Enterprise add-on and can only be used with [Enterprise cloud](../../../../enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](../../../../enterprise-guide/enterprise-on-premises-guide). It is available for all installations under the Enterprise Corporate plan. An upgrade from the free community edition is easy and helps support OpenProject. This authentication mode will use access tokens provided by an identity provider shared among Nextcloud and OpenProject to authenticate requests performed in the name of users. diff --git a/docs/system-admin-guide/time-and-costs/README.md b/docs/system-admin-guide/time-and-costs/README.md index 35bcbf5e73a..6b33965c666 100644 --- a/docs/system-admin-guide/time-and-costs/README.md +++ b/docs/system-admin-guide/time-and-costs/README.md @@ -16,7 +16,7 @@ To define default settings for logging time and costs navigate to *Administratio ### Define default time settings (Enterprise add-on) > [!NOTE] -> Enforcing exact time entries for time logging is an Enterprise add-on and can only be used with [Enterprise cloud](https://www.openproject.org/docs/enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](https://www.openproject.org/docs/enterprise-guide/enterprise-on-premises-guide). An upgrade from the free Community edition is easily possible. +> Enforcing exact time entries for time logging is an Enterprise add-on and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide). An upgrade from the free Community edition is easily possible. Under the *Time* tab you can define which fields are required to be fill out when logging time across all projects. diff --git a/docs/user-guide/file-management/file-management-faq/README.md b/docs/user-guide/file-management/file-management-faq/README.md index a7c50e8bf42..a4a2be88ac2 100644 --- a/docs/user-guide/file-management/file-management-faq/README.md +++ b/docs/user-guide/file-management/file-management-faq/README.md @@ -36,4 +36,4 @@ Yes, there is a virus scanner for attachments in OpenProject. At the moment it i The integration between OpenProject and Nextcloud is part of the open source and free of charge **Community edition**, including all file management functionalities. -However, please note that setting up the Single Sign-on via OpenID Connect Identity Provider is an Enterprise Add-on and can only be used with [Enterprise cloud](https://www.openproject.org/docs/enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](https://www.openproject.org/docs/enterprise-guide/enterprise-on-premises-guide). This Add-On is available for all installations under the [Enterprise Corporate plan](https://www.openproject.org/pricing/). \ No newline at end of file +However, please note that setting up the Single Sign-on via OpenID Connect Identity Provider is an Enterprise Add-on and can only be used with [Enterprise cloud](../../../enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](../../../enterprise-guide/enterprise-on-premises-guide). This Add-On is available for all installations under the [Enterprise Corporate plan](https://www.openproject.org/pricing/). diff --git a/docs/user-guide/work-packages/work-package-table-configuration/README.md b/docs/user-guide/work-packages/work-package-table-configuration/README.md index 921606db75d..1078d484dc6 100644 --- a/docs/user-guide/work-packages/work-package-table-configuration/README.md +++ b/docs/user-guide/work-packages/work-package-table-configuration/README.md @@ -218,7 +218,7 @@ If you group the work package table, sums will be shown for each group. ## Attribute highlighting (Enterprise add-on) > [!NOTE] -> Attribute highlighting is an Enterprise add-on and can only be used with [Enterprise cloud](https://www.openproject.org/docs/enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](https://www.openproject.org/docs/enterprise-guide/enterprise-on-premises-guide). An upgrade from the free community edition is easy and helps support OpenProject. +> Attribute highlighting is an Enterprise add-on and can only be used with [Enterprise cloud](../../../enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](../../../enterprise-guide/enterprise-on-premises-guide). An upgrade from the free community edition is easy and helps support OpenProject. You can highlight attributes in the work package table to emphasize the importance of certain attributes and have important topics at a glance. To activate attribute highlighting open the work package configuration table and select the **Highlighting** tab.