Goal
This section contains the instructions to automatically create Jira issues links into the Confluence pages of your templates, by adding the Gaia tags for Jira issues.
Pre-requisites
This tutorial was written considering that :
- you have a Jira instance installed and running on your server with Gaia for Jira installed;
- you have a Confluence instance installed and running on your server or you are using the Confluence Cloud service from Atlassian;
- you are logged into Jira and Confluence.
Linking Jira issues with Confluence
1. Adding the Jira Issues Gaia tags into a Confluence page :
In your Confluence Space template, create a link to a Jira issue, by adding the following tag element into your text
##ID:mytag##
Where mytag represents a unique string. The figure below depicts an example for using tags into a table element. Here, mytag is repaced with 1.1 and 1.2. Tags can be added anywhere in the text section of a Confluence page.
| Info | ||
|---|---|---|
| ||
You may use alphanumeric characters, dashes and dots only for mytag. Other characters are not supported. Also, we require that mytag is limited to 16 characters. |
2. Add the same tag in the Jira issue you want to link :
To associate a tag added into a Confluence page to any Jira issue, add the exact same tag in the Comments section of a Jira issue, as shown below :
| Warning | ||
|---|---|---|
| ||
Newer versions of Jira offer a rich-text editor for writing comments. Please note that formatting within the tag (such as bold characters) is not supported and may cause the tag not to be recognized by Gaia when creating new projects. Also, this editor replaces key names with their corresponding hyperlinks, which also changes the formatting of the tags (tags generally becomes blue and clickable). To avoid this, make sure you do not use key names for your tags. For instance, if your issue has MYPROJ-1 as issue key, do not use MYPROJ-1 as the tag name. |
3. Create the template files :
To use this feature, you need to export your templates by creating the Jira issues file and the Confluence Space file. When the files are created, use them in your templates settings in the Gaia administration panel (see create or edit template).
| Tip | ||
|---|---|---|
| ||
There you go, you can now add links between Jira and Confluence with Gaia for Jira! |
| Page Properties | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Table of contents
| Table of Contents | ||
|---|---|---|
|