Skip to content

Commit

Permalink
Update links to the new documentation website
Browse files Browse the repository at this point in the history
  • Loading branch information
fguillot committed Nov 12, 2022
1 parent a376ffb commit 80c0734
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 21 deletions.
6 changes: 4 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Expand Up @@ -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
<!--
I understand that Kanboard is in maintenance mode.
It doesn't mean it's abandoned, but there is no significant feature development.
-->
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE/question---discussion.md
Expand Up @@ -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
3 changes: 2 additions & 1 deletion .github/pull_request_template.md
Expand Up @@ -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/)

8 changes: 4 additions & 4 deletions README.md
Expand Up @@ -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: <https://docs.kanboard.org/>
- [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
-------
Expand Down
12 changes: 2 additions & 10 deletions app/Helper/UrlHelper.php
Expand Up @@ -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('<a href="%s" target="_blank">%s</a>', $url, $label);
}

Expand Down
2 changes: 1 addition & 1 deletion app/Template/header/user_dropdown.php
Expand Up @@ -30,7 +30,7 @@

<li>
<i class="fa fa-fw fa-life-ring" aria-hidden="true"></i>
<?= $this->url->doc(t('Documentation'), 'index') ?>
<?= $this->url->doc(t('Documentation')) ?>
</li>
<?php if (! DISABLE_LOGOUT): ?>
<li>
Expand Down
2 changes: 1 addition & 1 deletion app/constants.php
Expand Up @@ -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');

0 comments on commit 80c0734

Please sign in to comment.