Quick Start Guide
View glossary dashboard
To load and check the whole glossary terms just find a top navigation menu “Apps” dropdown and find a Glossary link.
Add/Edit/Remove a term
To add a new term, just load Glossary dashboard and click a “New Term“ button in the right top corner. If you need to edit or remove an existing one, just hover a mouse on it and see an additional icons, choose needed action and click on the icon.
Review a term
After you load a glossary dashboard you will see a list of terms. By clicking the title of the term you will be redirected to the “view” page where you can see all needed details. By clicking “Find issues with term” button an additional list of Jira issues, which contain the term in their description, will appear.Find issues with term
Glossary terms on Jira issue details page
When you open any Jira issue details page you can show/hide an additional section with a Glossary terms, which are parsed based on the description field and help to the users better and faster understand a context of the issue, abbreviations, etc.
Enable glossary terms inside Jira issue description field
By default plugin will check glossary terms in 2 fields: issue summary
and issue description
and show related information about founded terms in the dedicated section. You can enable possibility that plugin will add founded terms directly inside Jira issue description field at the bottom. You will see those terms as a list of smart links.
To make an active this feature you need to load “Glossary settings” page inside project configuration by clicking “config” button which you can find inside Glossary section (please see a screenshot below).
When page is loaded you will see a toggle button “Enable glossary terms inside Jira issue description field “ which you should enable (please see a screenshot below).
After that each time you will load any Jira issue details page where the app will find some glossary terms inside description - they will be added as “smart links” at the bottom of the text.