mirror of
https://github.com/Unleash/unleash.git
synced 2025-07-26 13:48:33 +02:00
Merge pull request #1466 from Unleash/docs/update-jira-docs
docs: Update Jira docs with new installation instructions
This commit is contained in:
commit
f469b41eb9
@ -10,6 +10,18 @@ existing toggles to Jira issues.
|
||||
|
||||
The plugin also shows you current status of connected toggles.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### Jira
|
||||
|
||||
- [Jira **data center**](https://www.atlassian.com/enterprise/data-center/jira), v8.0 or higher
|
||||
|
||||
We do not support Jira Cloud at the moment.
|
||||
|
||||
### Unleash
|
||||
|
||||
- Unleash v4 or higher
|
||||
|
||||
## Required access levels
|
||||
|
||||
### Unleash
|
||||
@ -22,48 +34,36 @@ You will need a Jira admin user.
|
||||
|
||||
## Installation
|
||||
|
||||
The Jira server plugin is currently not listed on the Atlassian marketplace.
|
||||
The [Jira server plugin is available in the Atlassian marketplace](https://marketplace.atlassian.com/apps/1227377/unleash-for-jira?tab=overview&hosting=datacenter).
|
||||
|
||||
To get access to the Jira plugin, please reach out to sales@getunleash.io.
|
||||
You'll need to download the plugin and create a license key.
|
||||
|
||||
You will receive a dedicated link that will allow you to download the Unleash Jira server plugin.
|
||||
If you have an Unleash enterprise license you're welcome to reach out to us at sales@getunleash.io for a free plugin license, otherwise you'll need to try the plugin for 30 days free or purchase a license through the marketplace.
|
||||
|
||||
Once you've downloaded the plugin artifact, you'll need to click the Manage Apps link in Jira's administration menu
|
||||
Once you've downloaded the plugin artifact, you'll need to follow the Manage apps link in Jira's administration menu.
|
||||
|
||||

|
||||
On the Manage apps page, use the "upload app" button.
|
||||
|
||||
This will take you to Atlassian's marketplace for Jira apps.
|
||||

|
||||
|
||||
From here, click the "Manage apps" link in the left-hand menu
|
||||
This will prompt you to select the plugin file you downloaded in the previous steps for upload.
|
||||
|
||||

|
||||
Once you've selected your file and started the upload, Jira will install the plugin. If the installation is successful, you'll get a status screen saying that it successfully installed.
|
||||
|
||||
Now, click "Upload app"
|
||||

|
||||
|
||||

|
||||
|
||||
This will prompt you to select the plugin artifact for upload.
|
||||
|
||||

|
||||
|
||||
Once you've selected your file and clicked "Upload". Jira will install the plugin, and you should get a nice status screen saying that it successfully installed.
|
||||
|
||||

|
||||
|
||||
You can now move on to [Configuring the plugin](#configure-plugin)
|
||||
|
||||
## Configuring plugin {#configure-plugin}
|
||||
## Configuring the plugin {#configure-plugin}
|
||||
|
||||
After the plugin is installed. Jira's Manage Apps page will have a new menu section called "Unleash Admin" with a single
|
||||
link - "Configure servers".
|
||||
|
||||

|
||||

|
||||
|
||||
Following the "Configure servers" link will take you to a config page where you can setup your connection(s) to Unleash
|
||||
servers. The Unleash Jira server plugin supports having a global server configured for all Jira projects, or a specific
|
||||
server configured for a specific Jira project.
|
||||
|
||||

|
||||

|
||||
|
||||
Once you have configured at least one Unleash server, your users should be ready to [use the Jira Server plugin](/integrations/jira_server_plugin_usage)
|
||||
|
||||
@ -72,7 +72,7 @@ Once you have configured at least one Unleash server, your users should be ready
|
||||
In the list of known servers, each server has a connected edit button. Clicking the edit button brings up the edit
|
||||
dialog for the server, allowing you to change the details for the selected server
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
### Delete (disconnect) existing servers
|
||||
@ -81,9 +81,9 @@ Deleting a server from the admin interface does not actually delete the server,
|
||||
server.
|
||||
Since this is a destructive operation, our plugin will ask for confirmation that you're sure you want to do this.
|
||||
|
||||

|
||||

|
||||
|
||||
You will not be allowed to delete a server that has toggles connected to issues, instead you'll receive a
|
||||
You cannot delete a server that has toggles connected to issues. Instead, you'll get a
|
||||
warning dialog telling you that you'll need to disconnect the toggles from their issues first.
|
||||
|
||||

|
||||

|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 12 KiB |
Binary file not shown.
Before Width: | Height: | Size: 51 KiB |
Loading…
Reference in New Issue
Block a user