From 80c073432fbed22becc4749d304a5855fb30479a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Guillot?= Date: Sat, 12 Nov 2022 10:23:29 -0800 Subject: [PATCH] Update links to the new documentation website --- .github/ISSUE_TEMPLATE/feature_request.md | 6 ++++-- .github/ISSUE_TEMPLATE/question---discussion.md | 2 -- .github/pull_request_template.md | 3 ++- README.md | 8 ++++---- app/Helper/UrlHelper.php | 12 ++---------- app/Template/header/user_dropdown.php | 2 +- app/constants.php | 2 +- 7 files changed, 14 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 162046431b..b28f7a6b49 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,5 +7,7 @@ assignees: '' --- -- [ ] I understand that Kanboard is in maintenance mode. It doesn't mean it's abandoned, but there is no significant feature development. -- [ ] I have read this document: https://docs.kanboard.org/en/latest/developer_guide/faq.html#why-are-you-not-developing-my-feature-request + diff --git a/.github/ISSUE_TEMPLATE/question---discussion.md b/.github/ISSUE_TEMPLATE/question---discussion.md index feb6931529..96ee94f685 100644 --- a/.github/ISSUE_TEMPLATE/question---discussion.md +++ b/.github/ISSUE_TEMPLATE/question---discussion.md @@ -10,5 +10,3 @@ assignees: '' Don't use the bug tracker! Go to the forum -> https://kanboard.discourse.group/ - -https://docs.kanboard.org/en/latest/developer_guide/faq.html#why-did-you-close-my-question-on-the-bug-tracker diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c57dcf0fd8..98af65fb2f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,5 +3,6 @@ Do you follow the guidelines? - [ ] I have tested my changes - [ ] There is no breaking change - [ ] There is no regression -- [ ] I follow existing [coding style](https://docs.kanboard.org/en/latest/developer_guide/coding_standards.html) +- [ ] I have updated the unit tests and integration tests accordingly +- [ ] I follow the existing [coding style](https://docs.kanboard.org/v1/dev/coding_standards/) diff --git a/README.md b/README.md index 447ebe52e3..084e032d9f 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,10 @@ Pull-requests are still accepted as long as the [guidelines](.github/pull_reques - [Change Log](https://github.com/kanboard/kanboard/blob/main/ChangeLog) - [Forum](https://kanboard.discourse.group/) - Official documentation: - - [Requirements](https://docs.kanboard.org/en/latest/admin_guide/requirements.html) - - [Installation instructions](https://docs.kanboard.org/en/latest/admin_guide/installation.html) - - [Upgrade to a new version](https://docs.kanboard.org/en/latest/admin_guide/upgrade.html) - - [Use Kanboard with Docker](https://docs.kanboard.org/en/latest/admin_guide/docker.html) + - [Requirements](https://docs.kanboard.org/v1/admin/requirements/) + - [Installation instructions](https://docs.kanboard.org/v1/admin/installation/) + - [Upgrade to a new version](https://docs.kanboard.org/v1/admin/upgrade/) + - [Use Kanboard with Docker](https://docs.kanboard.org/v1/admin/docker/) Credits ------- diff --git a/app/Helper/UrlHelper.php b/app/Helper/UrlHelper.php index 94cb161bc1..3579600ea8 100644 --- a/app/Helper/UrlHelper.php +++ b/app/Helper/UrlHelper.php @@ -23,17 +23,9 @@ class UrlHelper extends Base * @param string $file * @return string */ - public function doc($label, $file) + public function doc($label, $file = '') { - $version = 'latest'; - - if (substr(APP_VERSION, 0, 1) === 'v') { - $version = substr(APP_VERSION, 1); - } else if (ctype_digit(substr(APP_VERSION, 0, 1))) { - $version = APP_VERSION; - } - - $url = sprintf(DOCUMENTATION_URL_PATTERN, $version, $file); + $url = sprintf(DOCUMENTATION_URL_PATTERN, 'v1', $file); return sprintf('%s', $url, $label); } diff --git a/app/Template/header/user_dropdown.php b/app/Template/header/user_dropdown.php index 9ccefdf215..10d77ebc67 100644 --- a/app/Template/header/user_dropdown.php +++ b/app/Template/header/user_dropdown.php @@ -30,7 +30,7 @@
  • - url->doc(t('Documentation'), 'index') ?> + url->doc(t('Documentation')) ?>
  • diff --git a/app/constants.php b/app/constants.php index 0fa9c86e55..3fc1d329db 100644 --- a/app/constants.php +++ b/app/constants.php @@ -176,4 +176,4 @@ defined('SHOW_GROUP_MEMBERSHIPS_IN_USERLIST_WITH_LIMIT') or define('SHOW_GROUP_MEMBERSHIPS_IN_USERLIST_WITH_LIMIT', intval(getenv('SHOW_GROUP_MEMBERSHIPS_IN_USERLIST_WITH_LIMIT')) ?: 7); // Documentation URL -defined('DOCUMENTATION_URL_PATTERN') or define('DOCUMENTATION_URL_PATTERN', getenv('DOCUMENTATION_URL_PATTERN') ?: 'https://docs.kanboard.org/en/%s/user_guide/%s.html'); +defined('DOCUMENTATION_URL_PATTERN') or define('DOCUMENTATION_URL_PATTERN', getenv('DOCUMENTATION_URL_PATTERN') ?: 'https://docs.kanboard.org/v1/user/%s');