1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

docs: remove jira cloud plugin docs for now (#1118)

This commit is contained in:
Christopher Kolstad 2021-11-22 11:43:06 +01:00 committed by GitHub
parent 4c4c1de0fb
commit 52ae753466
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 0 additions and 102 deletions

View File

@ -1,57 +0,0 @@
---
id: jira_plugin_installation
title: Jira Cloud Integration - Installation
---
> 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.
## Required access levels
### Unleash
You will need an Unleash Instance Admin to configure an admin API token.
### Jira
You will need a Jira user with access to install plugins.
## Installation
The Jira 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 and install the Unleash Jira plugin.
When following the link you'll be greeted by an installation screen similar to the one down below ![Jira plugin install](/img/jira_plugin_installation.png)
## Configuring plugin
Once installed you'll need to head to "Manage your apps"
![Jira - app menu bar location](/img/jira_apps_menu_bar.png) ![Jira - manage your apps link](/img/jira_manage_apps.png)
Once there you should see "Unleash Admin" in your sidebar.
Click it, and you'll get taken to our configuration page
![Jira - manage apps sidebar](/img/jira_manage_apps_sidebar.png)
Once on the configuration page. You should enter your installation URL and an API Key with access level `Admin`
- For your installation URL
- if you're using Unleash Hosted in Europe, your URL will have the format `https://app.unleash-hosted.com/**[instanceName]**/api`
- if you're using Unleash Hosted in US, your URL will have the format `https://us.unleash-hosted.com/**[instanceName]**/api`
- if you're Self hosted, your URL will need to point to wherever your installation is located, suffixed with `/api`.
- See [the API token doc](/user_guide/api-token) for how to configure an Admin token
> NB! Since the plugin is currently using an ADMIN level API token, it has full access to all projects and issues
![Jira - Configure unleash app](/img/jira_configure_unleash_app.png)
After you've entered the URL and API key and clicked `Submit` your api token will no longer be visible.
![Jira - API key already set](/img/jira_admin_api_key_set.png)
Now, you're ready to [use the plugin from Jira issues](/integrations/jira_plugin_usage)

View File

@ -1,41 +0,0 @@
---
id: jira_plugin_usage
title: Jira Cloud Integration - Usage
---
> 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.
## 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.
![Jira - Issue panel button](/img/jira_issue_panel_button.png)
Clicking this button adds a section to your issue panel allowing you to connect a feature toggle to the issue. If no feature toggle is connected to the issue, you'll be greeted by an entry form for creating the toggle.
![Jira - Create Feature Toggle entry form](/img/jira_create_feature_toggle.png)
### Creating a new feature toggle
Once you've entered the necessary information:
- name - The name must be unique, at the current time, you'll receive an error from the plugin if the name already exist.
- project - Here we fetch valid projects from your Unleash installation and provide you with a dropdown, we'll default to the Default project.
- toggle-type - Again, the plugin will fetch valid types for the toggle from your Unleash installation and provide you with a dropdown.
- enabled - Is the toggle enabled when created
Click the `Create Feature Toggle` button and Unleash will create the toggle for you. Once created, the section in your issue view changes to show if the toggle is enabled.
It also adds a link back to your unleash installation allowing easy access to more advanced configuration of the feature toggle.
Since this leaves JIRA and enters Unleash, you'll be met by the Unleash login screen if you don't already have an active session in Unleash.
![Jira - Issue with existing Feature Toggle](/img/jira_existing_feature_toggle.png)
### Connecting existing feature toggle
- Still to come

View File

@ -106,10 +106,6 @@ module.exports = {
},
Integrations: {
Integrations: ['integrations/integrations'],
JIRA: [
'integrations/jira_plugin_installation',
'integrations/jira_plugin_usage',
],
'Jira server': [
'integrations/jira_server_plugin_installation',
'integrations/jira_server_plugin_usage',

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB