Merge pull request #1103 from Unleash/docs/jiraServerPlugin
Docs/jira server plugin
@ -1,9 +1,9 @@
 | 
			
		||||
---
 | 
			
		||||
id: jira_plugin_installation
 | 
			
		||||
title: Jira Integration - Installation
 | 
			
		||||
title: Jira Cloud Integration - Installation
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
> The Jira Plugin is part of Unleash Enterprise.
 | 
			
		||||
> The Jira Cloud Plugin is part of Unleash Enterprise.
 | 
			
		||||
> The Jira Cloud Plugin has been moved back in priority, in its current state we don't recommend using it
 | 
			
		||||
 | 
			
		||||
With the Unleash JIRA plugin you can create new feature toggles in Unleash from a JIRA issue. You'll also be able to link existing toggles to JIRA issues as well as see current status of the linked toggle as both a custom field and as an Issue Panel.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -1,9 +1,11 @@
 | 
			
		||||
---
 | 
			
		||||
id: jira_plugin_usage
 | 
			
		||||
title: Jira Integration - Usage
 | 
			
		||||
title: Jira Cloud Integration - Usage
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
> The Jira Plugin is part of Unleash Enterprise.
 | 
			
		||||
> The Jira Cloud Plugin is part of Unleash Enterprise.
 | 
			
		||||
> The Jira Cloud Plugin has been moved back in priority, in its current state we don't recommend using it
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
With the Unleash JIRA plugin you can create new feature toggles in Unleash from a JIRA issue. You'll also be able to link existing toggles to JIRA issues as well as see current status of the linked toggle as both a custom field and as an Issue Panel.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										89
									
								
								website/docs/integrations/jira-server-plugin-installation.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						@ -0,0 +1,89 @@
 | 
			
		||||
---
 | 
			
		||||
id: jira_server_plugin_installation
 | 
			
		||||
title: Jira Server Integration - Installation
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
> The Jira Server Plugin is part of Unleash Enterprise.
 | 
			
		||||
 | 
			
		||||
With the Unleash Jira server plugin you can create new feature toggles in Unleash from a Jira issue as well as link
 | 
			
		||||
existing toggles to Jira issues.
 | 
			
		||||
 | 
			
		||||
The plugin also shows you current status of connected toggles.
 | 
			
		||||
 | 
			
		||||
## Required access levels
 | 
			
		||||
 | 
			
		||||
### Unleash
 | 
			
		||||
 | 
			
		||||
You will need an Unleash admin to configure an admin API token.
 | 
			
		||||
 | 
			
		||||
### Jira
 | 
			
		||||
 | 
			
		||||
You will need a Jira admin user.
 | 
			
		||||
 | 
			
		||||
## Installation
 | 
			
		||||
 | 
			
		||||
The Jira server plugin is currently not listed on the Atlassian marketplace.
 | 
			
		||||
 | 
			
		||||
To get access to the Jira plugin, please reach out to sales@getunleash.io.
 | 
			
		||||
 | 
			
		||||
You will receive a dedicated link that will allow you to download the Unleash Jira server plugin.
 | 
			
		||||
 | 
			
		||||
Once you've downloaded the plugin artifact, you'll need to click the Manage Apps link in Jira's administration menu
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
This will take you to Atlassian's marketplace for Jira apps.
 | 
			
		||||
 | 
			
		||||
From here, click the "Manage apps" link in the left-hand menu
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
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}
 | 
			
		||||
 | 
			
		||||
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)
 | 
			
		||||
 | 
			
		||||
### Edit existing servers
 | 
			
		||||
 | 
			
		||||
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
 | 
			
		||||
 | 
			
		||||
Deleting a server from the admin interface does not actually delete the server, but it deletes Jira's knowledge of the
 | 
			
		||||
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
 | 
			
		||||
warning dialog telling you that you'll need to disconnect the toggles from their issues first.
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
							
								
								
									
										50
									
								
								website/docs/integrations/jira-server-plugin-usage.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						@ -0,0 +1,50 @@
 | 
			
		||||
---
 | 
			
		||||
id: jira_server_plugin_usage
 | 
			
		||||
title: Jira Server Integration - Usage
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
> The Jira Server Plugin is part of Unleash Enterprise.
 | 
			
		||||
 | 
			
		||||
With the Unleash Jira server plugin you can create new feature toggles in Unleash from a Jira issue as well as link
 | 
			
		||||
existing toggles to Jira issues.
 | 
			
		||||
 | 
			
		||||
The plugin also shows you current status of connected toggles.
 | 
			
		||||
 | 
			
		||||
## Using the plugin
 | 
			
		||||
 | 
			
		||||
To use the plugin, you'll need to create an issue or use an existing one. Once the issue is saved and you open up the Issue panel, you'll be greeted with a button to activate the Unleash plugin for that issue.
 | 
			
		||||
 | 
			
		||||
### Connecting a toggle to an issue
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
Clicking this button opens a dialog, allowing you to either connect an existing toggle
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
or if you flip the switch that says "Use existing toggle", allows you to create a new toggle
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
### Toggle status as part of Issue view
 | 
			
		||||
 | 
			
		||||
Once you've connected at least one toggle to an issue, our plugin will list the current status of each environment for
 | 
			
		||||
that toggle. If the current user is allowed to edit the issue, they can also enable or disable environments directly
 | 
			
		||||
from Jira.
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### Disconnecting toggle from Issue
 | 
			
		||||
 | 
			
		||||
If a toggle is no longer relevant for your Jira Issue, you can disconnect it using the Disconnect toggle button (
 | 
			
		||||
provided your user has edit rights on the issue)
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
Once you click the button, you'll need to confirm the dialog that opens up.
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
If confirmed, the toggle will be disconnected immediately. However, the plugin will not delete the toggle from Unleash,
 | 
			
		||||
so you can still reconnect your Jira issue to the same toggle using the "Connect to existing toggle" functionality 
 | 
			
		||||
@ -110,5 +110,9 @@ module.exports = {
 | 
			
		||||
            'integrations/jira_plugin_installation',
 | 
			
		||||
            'integrations/jira_plugin_usage',
 | 
			
		||||
        ],
 | 
			
		||||
        'Jira server': [
 | 
			
		||||
            'integrations/jira_server_plugin_installation',
 | 
			
		||||
            'integrations/jira_server_plugin_usage',
 | 
			
		||||
        ]
 | 
			
		||||
    },
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_marketplace_manage_apps.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 12 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_add_existing_toggle.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 17 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_add_new_toggle.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 24 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_delete_connected_toggles.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 17 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_delete_server_confirmation.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 16 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_disconnect_toggle.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 12 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_disconnect_toggle_dialog.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 17 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_edit_server.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 21 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_installed_ready_to_go.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 28 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_issue_panel_button.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 9.5 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_manage_apps.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 33 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_manage_servers.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 61 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_manage_unleash_admin.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 10 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_server_toggle_status.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 24 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_upload_app.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 59 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								website/static/img/jira_upload_app_dialog.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 51 KiB  |