Manual:Extension/IssueTrackerLinks: Difference between revisions

Revision as of 11:45, 20 October 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.

GitHub issue tracker link

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 ULR path of the issue tracker link.

Technical Reference: IssueTrackerLinks

PDF exclude - start

To submit feedback about this documentation, visit our community forum.

PDF exclude - end

@@ 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 ==
 For example, an administrator has [[Reference:IssueTrackerLinks|configured issue tracking for GitHub]]:<syntaxhighlight lang="json">
@@ Line 16: / Line 14: @@
 === 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.
-[[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]]
 == Content droplet ==
-Some issue links can be entered as content droplet:
+Some issue links can be entered as [[Manual:Extension/ContentDroplets|Content droplet]]:
 * GitHub issue link
 * GitLab issue link
+* Jira
+{{Textbox|boxtype=note|header=Note:|text=Content droplets only accept the full ULR path of the issue tracker link.|icon=yes}}
 [[Category:Content]]