diff --git a/website/docs/integrations/jira-server-plugin-installation.md b/website/docs/integrations/jira-server-plugin-installation.md new file mode 100644 index 0000000000..fa7f854faf --- /dev/null +++ b/website/docs/integrations/jira-server-plugin-installation.md @@ -0,0 +1,86 @@ +--- +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 Instance 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 + +![Jira Manage Apps](/img/jira_server_manage_apps.png) + +This will take you to Atlassian's marketplace for Jira apps. + +From here, click the "Manage apps" link in the left-hand menu + +![Jira Marketplace - Manage apps](/img/jira_marketplace_manage_apps.png) + +Now, click "Upload app" + +![Jira Manage Apps - Upload App](/img/jira_upload_app.png) + +This will prompt you to select the plugin artifact for upload. + +![Jira Manage Apps - Browse](/img/jira_upload_app_dialog.png) + +Once you've selected your file and clicked "Upload". Jira will install the plugin, and you can 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". + +![Jira Manage Apps - Unleash Admin](/img/jira_server_manage_unleash_admin.png) + +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. + +![Jira Manage Apps - Unleash Server Admin](/img/jira_server_manage_servers.png) + +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 + +![Jira Manage Apps - Edit server](/img/jira_server_edit_server.png) + + +### 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. + +![Jira Manage apps - Delete server confirmation](/img/jira_server_delete_server_confirmation.png) + +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. + +![Jira Manage apps - Delete server connected toggles](/img/jira_server_delete_connected_toggles.png) diff --git a/website/docs/integrations/jira-server-plugin-usage.md b/website/docs/integrations/jira-server-plugin-usage.md new file mode 100644 index 0000000000..a910b80e59 --- /dev/null +++ b/website/docs/integrations/jira-server-plugin-usage.md @@ -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 + +![Jira Server - Issue panel button](/img/jira_server_issue_panel_button.png) + +Clicking this button opens a dialog, allowing you to either connect an existing toggle + +![Jira Server - Add Existing toggle](/img/jira_server_add_existing_toggle.png) + +or if you flip the switch that says "Use existing toggle", allows you to create a new toggle + +![Jira Server - Add new toggle](/img/jira_server_add_new_toggle.png) + +### 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. + +![Jira Server - Toggle status](/img/jira_server_toggle_status.png) + + +### 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) + +![Jira Server - Disconnect toggle](/img/jira_server_disconnect_toggle.png) + +Once you click the button, you'll need to confirm the dialog that opens up + +![Jira Server - Disconnect toggle dialog](/img/jira_server_disconnect_toggle_dialog.png) + +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 diff --git a/website/sidebars.js b/website/sidebars.js index 27234ebd56..5612e04dcf 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -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', + ] }, }; diff --git a/website/static/img/jira_marketplace_manage_apps.png b/website/static/img/jira_marketplace_manage_apps.png new file mode 100644 index 0000000000..e2cf66ae54 Binary files /dev/null and b/website/static/img/jira_marketplace_manage_apps.png differ diff --git a/website/static/img/jira_server_add_existing_toggle.png b/website/static/img/jira_server_add_existing_toggle.png new file mode 100644 index 0000000000..8721b4ecdc Binary files /dev/null and b/website/static/img/jira_server_add_existing_toggle.png differ diff --git a/website/static/img/jira_server_add_new_toggle.png b/website/static/img/jira_server_add_new_toggle.png new file mode 100644 index 0000000000..ce3d8bac30 Binary files /dev/null and b/website/static/img/jira_server_add_new_toggle.png differ diff --git a/website/static/img/jira_server_delete_connected_toggles.png b/website/static/img/jira_server_delete_connected_toggles.png new file mode 100644 index 0000000000..1376b585c3 Binary files /dev/null and b/website/static/img/jira_server_delete_connected_toggles.png differ diff --git a/website/static/img/jira_server_delete_server_confirmation.png b/website/static/img/jira_server_delete_server_confirmation.png new file mode 100644 index 0000000000..339b18a77f Binary files /dev/null and b/website/static/img/jira_server_delete_server_confirmation.png differ diff --git a/website/static/img/jira_server_disconnect_toggle.png b/website/static/img/jira_server_disconnect_toggle.png new file mode 100644 index 0000000000..d1d7500db6 Binary files /dev/null and b/website/static/img/jira_server_disconnect_toggle.png differ diff --git a/website/static/img/jira_server_disconnect_toggle_dialog.png b/website/static/img/jira_server_disconnect_toggle_dialog.png new file mode 100644 index 0000000000..2f29747a1e Binary files /dev/null and b/website/static/img/jira_server_disconnect_toggle_dialog.png differ diff --git a/website/static/img/jira_server_edit_server.png b/website/static/img/jira_server_edit_server.png new file mode 100644 index 0000000000..c04f4cb4dd Binary files /dev/null and b/website/static/img/jira_server_edit_server.png differ diff --git a/website/static/img/jira_server_issue_panel_button.png b/website/static/img/jira_server_issue_panel_button.png new file mode 100644 index 0000000000..93e34a31b2 Binary files /dev/null and b/website/static/img/jira_server_issue_panel_button.png differ diff --git a/website/static/img/jira_server_manage_apps.png b/website/static/img/jira_server_manage_apps.png new file mode 100644 index 0000000000..a79df26f11 Binary files /dev/null and b/website/static/img/jira_server_manage_apps.png differ diff --git a/website/static/img/jira_server_manage_servers.png b/website/static/img/jira_server_manage_servers.png new file mode 100644 index 0000000000..5da410db4f Binary files /dev/null and b/website/static/img/jira_server_manage_servers.png differ diff --git a/website/static/img/jira_server_manage_unleash_admin.png b/website/static/img/jira_server_manage_unleash_admin.png new file mode 100644 index 0000000000..11a37fdadb Binary files /dev/null and b/website/static/img/jira_server_manage_unleash_admin.png differ diff --git a/website/static/img/jira_server_toggle_status.png b/website/static/img/jira_server_toggle_status.png new file mode 100644 index 0000000000..d4868b9b1b Binary files /dev/null and b/website/static/img/jira_server_toggle_status.png differ diff --git a/website/static/img/jira_upload_app.png b/website/static/img/jira_upload_app.png new file mode 100644 index 0000000000..b9d9be71dc Binary files /dev/null and b/website/static/img/jira_upload_app.png differ diff --git a/website/static/img/jira_upload_app_dialog.png b/website/static/img/jira_upload_app_dialog.png new file mode 100644 index 0000000000..1fa18c68b2 Binary files /dev/null and b/website/static/img/jira_upload_app_dialog.png differ