No edit summary |
m (username removed) (log details removed) |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
The '''IssueTrackerLinks''' extension handles the rendering of links to external issue tracker applications, such as GitHub, GitLab, Jira, or EasyRedmine. Administrators can define which applications are available as issue tracker links. | The '''IssueTrackerLinks''' extension handles the rendering of links to external issue tracker applications, such as GitHub, GitLab, Jira, or EasyRedmine. Administrators can [[Reference:IssueTrackerLinks|define which applications are available]] as issue tracker links. | ||
== How it works == | == How it works == | ||
For example, an administrator has configured issue tracking for GitHub:<syntaxhighlight lang="json"> | For example, an administrator has [[Reference:IssueTrackerLinks|configured issue tracking for GitHub]]:<syntaxhighlight lang="json"> | ||
{ | { | ||
"github": { | "github": { | ||
| Line 46: | Line 14: | ||
=== Copy and paste === | === Copy and paste === | ||
With the above configuration, you can now paste the following link in a wiki page: <syntaxhighlight lang="text">https://github.com/wikimedia/edx-platform/issues/553</syntaxhighlight>The URL label will be visually formatted as an issue tracker url with the text string of the display-mask parameter that is defined for GitHub in your wiki. | With the above configuration, you can now paste the following link in a wiki page: <syntaxhighlight lang="text">https://github.com/wikimedia/edx-platform/issues/553</syntaxhighlight>The URL label will be visually formatted as an issue tracker url with the text string of the display-mask parameter that is defined for GitHub in your wiki. | ||
[[File:IssueTrackerLinks github display.png|alt=Formatted shortened link label for a GitHub issue|center|thumb|GitHub issue link]] | [[File:IssueTrackerLinks github display.png|alt=Formatted shortened link label for a GitHub issue|center|thumb|GitHub issue tracker link]] | ||
=== Shortcut sequence === | |||
It is possible that Administrators define a shortcut ("[[Reference:IssueTrackerLinks|sequence]]"). By default, GitHub issue links do not have a shortcut sequence defined, because it is not really time-saving to manually string the necessary values for the three variables <code>owner</code>, <code>repo</code>, and <code>id</code> together. But an administrator could define a shortcut sequence like:<syntaxhighlight lang="text"> | |||
GH-{owner}-{repo}-{id} | |||
</syntaxhighlight>Then, the above link could be created by manually entering the following string, followed by a space:<syntaxhighlight lang="text"> | |||
GH-wikimedia-edxplatform-553 | |||
</syntaxhighlight>Keyboard shortcuts are mainly useful if an issue tracker requires only one variable. | |||
== Content droplet == | == Content droplet == | ||
Some issue links can be entered as | Some issue links can be entered as [[Manual:Extension/ContentDroplets|Content droplet]]: | ||
* GitHub issue link | * GitHub issue link | ||
* GitLab issue link | * GitLab issue link | ||
* Jira | |||
{{Textbox|boxtype=note|header=Note:|text=Content droplets only accept the full URL path of the issue tracker link.|icon=yes}} | |||
[[Category:Content]] | [[Category:Content]] | ||
Latest revision as of 10:34, 18 November 2025
The IssueTrackerLinks extension handles the rendering of links to external issue tracker applications, such as GitHub, GitLab, Jira, or EasyRedmine. Administrators can define which applications are available as issue tracker links.
How it works
For example, an administrator has configured issue tracking for GitHub:
{
"github": {
"url": "https://github.com/{owner}/{repo}/issues/{id}",
"label": "issuetrackerlinks-type-label-github",
"icon": "github",
"display-mask": "{owner}/{repo}#{id}"
}
}
Copy and paste
With the above configuration, you can now paste the following link in a wiki page:
https://github.com/wikimedia/edx-platform/issues/553
The URL label will be visually formatted as an issue tracker url with the text string of the display-mask parameter that is defined for GitHub in your wiki.
Shortcut sequence
It is possible that Administrators define a shortcut ("sequence"). By default, GitHub issue links do not have a shortcut sequence defined, because it is not really time-saving to manually string the necessary values for the three variables owner, repo, and id together. But an administrator could define a shortcut sequence like:
GH-{owner}-{repo}-{id}
Then, the above link could be created by manually entering the following string, followed by a space:
GH-wikimedia-edxplatform-553
Keyboard shortcuts are mainly useful if an issue tracker requires only one variable.
Content droplet
Some issue links can be entered as Content droplet:
- GitHub issue link
- GitLab issue link
- Jira
Note:
Content droplets only accept the full URL path of the issue tracker link.
