Manual:Extension/IssueTrackerLinks

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

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.

Technical Reference: IssueTrackerLinks

PDF exclude - start

---

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

PDF exclude - end