diff --git a/website/docs/reference/integrations/jira-cloud-plugin-installation.md b/website/docs/reference/integrations/jira-cloud-plugin-installation.md new file mode 100644 index 0000000000..ffedbdd57d --- /dev/null +++ b/website/docs/reference/integrations/jira-cloud-plugin-installation.md @@ -0,0 +1,46 @@ +--- +title: Jira Cloud Integration - Installation +--- +import Figure from '@site/src/components/Figure/Figure.tsx' + +## Prerequisites + +### Jira Cloud + +- [Jira **Cloud**](https://www.atlassian.com/software/jira) + +For Jira Data Center, check out the [Jira Server plugin](jira-server-plugin-installation.md) + +### Unleash + +- Unleash v4 or higher + +## Required access levels + +### Unleash + +You will need an Unleash admin user to configure the access tokens needed to connect the plugin to Unleash. + +For Unleash Open Source this plugin requires the use of an [Admin API token](../api-tokens-and-client-keys.mdx) to connect. + +For Unleash Enterprise we recommend using a [service account](../service-accounts.md). Service accounts are also required to integrate with [Change Requests](../change-requests.md) + +### Jira + +You will need a Jira admin user. + +## Installation + +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. + +## Configuring the plugin {#configure-plugin} + +After the plugin has been installed, each project's settings page in Jira will have a menu entry link called "Unleash Project Settings" under the "Apps" menu section. + +![Jira Cloud project settings page with the apps menu open. The link to Unleash project settings is highlighted.](/img/jira-cloud-project-settings-link.png) + +Following that link takes you to the "Unleash Project Settings" configuration page. This is where you specify the connection details (Unleash server URL and access token) for the Unleash server to be used with this particular project. + +![Jira Cloud: Unleash project settings. A form with inputs for Unleash URL and an Unleash auth token.](/img/jira-cloud-project-settings.png) + +Once you have configured the connection for the Unleash server, your users should be ready to [use the Jira Cloud plugin](jira-cloud-plugin-usage) diff --git a/website/docs/reference/integrations/jira-cloud-plugin-usage.md b/website/docs/reference/integrations/jira-cloud-plugin-usage.md new file mode 100644 index 0000000000..6b9b2b2215 --- /dev/null +++ b/website/docs/reference/integrations/jira-cloud-plugin-usage.md @@ -0,0 +1,65 @@ +--- +title: Jira Cloud Integration - Usage +--- + +With the Unleash Jira Cloud Plugin you can create, view and manage Unleash feature toggles directly from a Jira issue. + +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 + +
+ + +Use the issue's "connect toggle" button to open a dialog. + +There are a few steps to connect a toggle: + +1. Select the Unleash project that contains the toggle: + + +![Jira Cloud: connect feature toggle form. The project selection dropdown contains all Unleash projects](/img/jira-cloud-select-project-expanded.png) + +2. Use the "create new toggle" option to choose whether you want to add an existing toggle or create a new one. + +
+ +
+ +### Toggle status as part of Issue view + +Once you've connected at least one toggle to an issue, the Unleash 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. + +
+ +### Change Requests + +The plugin respects Unleash's [change requests](../change-requests.md). If change requests are turned on in the connected project and the selected environment, the plugin will ask whether you want to create a change request or not. + +If you already have an active change request for that project and that environment, the changes will be added to your existing change request. + + +If you confirm that you would like to open a change request, then the plugin will create one for you and present a confirmation dialog. + +
+ +When the Change Request has been reviewed and applied in Unleash, the toggle will show the requested state after the next refresh +of the issue and toggle status page. + + +### Disconnecting toggle from Issue + +If a toggle is no longer relevant for your Jira Issue, you can disconnect it using the "disconnect toggle" button. This button is only available if your user has edit permissions for the Jira issue. + +![Jira Cloud: issue with a connected toggle. The 'disconnect toggle' button (highlighted) is displayed next to the toggle's name.](/img/jira-cloud-disconnect-toggle.png) + +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/docs/reference/integrations/jira-server-plugin-installation.md b/website/docs/reference/integrations/jira-server-plugin-installation.md index 4f30eac04c..ba38e643ee 100644 --- a/website/docs/reference/integrations/jira-server-plugin-installation.md +++ b/website/docs/reference/integrations/jira-server-plugin-installation.md @@ -15,7 +15,7 @@ The plugin also shows you current status of connected toggles. - [Jira **data center**](https://www.atlassian.com/enterprise/data-center/jira), v8.0 or higher -We do not support Jira Cloud at the moment. +For Jira Cloud, refer to the [Jira Cloud plugin](jira-cloud-plugin-installation) ### Unleash diff --git a/website/sidebars.js b/website/sidebars.js index db7a6aabe8..8c6cfdacfa 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -293,6 +293,10 @@ module.exports = { 'reference/integrations/jira-server-plugin-installation', 'reference/integrations/jira-server-plugin-usage', ], + 'Jira Cloud': [ + 'reference/integrations/jira-cloud-plugin-installation', + 'reference/integrations/jira-cloud-plugin-usage', + ], }, , ], diff --git a/website/static/img/jira-cloud-activate-unleash-panel-button.png b/website/static/img/jira-cloud-activate-unleash-panel-button.png new file mode 100644 index 0000000000..39f0114801 Binary files /dev/null and b/website/static/img/jira-cloud-activate-unleash-panel-button.png differ diff --git a/website/static/img/jira-cloud-add-existing-toggle.png b/website/static/img/jira-cloud-add-existing-toggle.png new file mode 100644 index 0000000000..8cd9f10fad Binary files /dev/null and b/website/static/img/jira-cloud-add-existing-toggle.png differ diff --git a/website/static/img/jira-cloud-add-new-toggle.png b/website/static/img/jira-cloud-add-new-toggle.png new file mode 100644 index 0000000000..4d7e0cc3f8 Binary files /dev/null and b/website/static/img/jira-cloud-add-new-toggle.png differ diff --git a/website/static/img/jira-cloud-change-request-confirmation.png b/website/static/img/jira-cloud-change-request-confirmation.png new file mode 100644 index 0000000000..830872606f Binary files /dev/null and b/website/static/img/jira-cloud-change-request-confirmation.png differ diff --git a/website/static/img/jira-cloud-change-request-dialog.png b/website/static/img/jira-cloud-change-request-dialog.png new file mode 100644 index 0000000000..0185996936 Binary files /dev/null and b/website/static/img/jira-cloud-change-request-dialog.png differ diff --git a/website/static/img/jira-cloud-disconnect-toggle-dialog.png b/website/static/img/jira-cloud-disconnect-toggle-dialog.png new file mode 100644 index 0000000000..ef2279f423 Binary files /dev/null and b/website/static/img/jira-cloud-disconnect-toggle-dialog.png differ diff --git a/website/static/img/jira-cloud-disconnect-toggle.png b/website/static/img/jira-cloud-disconnect-toggle.png new file mode 100644 index 0000000000..ef2279f423 Binary files /dev/null and b/website/static/img/jira-cloud-disconnect-toggle.png differ diff --git a/website/static/img/jira-cloud-issue-button.png b/website/static/img/jira-cloud-issue-button.png new file mode 100644 index 0000000000..370524d67b Binary files /dev/null and b/website/static/img/jira-cloud-issue-button.png differ diff --git a/website/static/img/jira-cloud-project-settings-link.png b/website/static/img/jira-cloud-project-settings-link.png new file mode 100644 index 0000000000..5324ca2cb7 Binary files /dev/null and b/website/static/img/jira-cloud-project-settings-link.png differ diff --git a/website/static/img/jira-cloud-project-settings.png b/website/static/img/jira-cloud-project-settings.png new file mode 100644 index 0000000000..58f2240f3f Binary files /dev/null and b/website/static/img/jira-cloud-project-settings.png differ diff --git a/website/static/img/jira-cloud-select-project-expanded.png b/website/static/img/jira-cloud-select-project-expanded.png new file mode 100644 index 0000000000..578ce70aa5 Binary files /dev/null and b/website/static/img/jira-cloud-select-project-expanded.png differ diff --git a/website/static/img/jira-cloud-toggle-status.png b/website/static/img/jira-cloud-toggle-status.png new file mode 100644 index 0000000000..306f065f36 Binary files /dev/null and b/website/static/img/jira-cloud-toggle-status.png differ