mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-25 00:07:47 +01:00
docs: updated jira-plugin from feedback
This commit is contained in:
Christopher Kolstad
parent
297d5474e6
commit
60d3982e66
@ -1,6 +1,6 @@
|
||||
---
|
||||
id: integrations
|
||||
title: Integrations and plugins
|
||||
title: External Integrations and plugins
|
||||
---
|
||||
|
||||
Available integrations with Unleash
|
||||
|
||||
57
websitev2/docs/integrations/jira-plugin-installation.md
Normal file
57
websitev2/docs/integrations/jira-plugin-installation.md
Normal file
@ -0,0 +1,57 @@
|
||||
---
|
||||
id: jira_plugin_installation
|
||||
title: Jira Integration - Installation
|
||||
---
|
||||
|
||||
> The Jira Plugin is part of Unleash Enterprise.
|
||||
|
||||
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 
|
||||
|
||||
## Configuring plugin
|
||||
|
||||
Once installed you'll need to head to "Manage your apps"
|
||||
|
||||
 
|
||||
|
||||
Once there you should see "Unleash Admin" in your sidebar.
|
||||
|
||||
Click it, and you'll get taken to our configuration page
|
||||
|
||||
|
||||
|
||||
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
|
||||
|
||||
|
||||
|
||||
After you've entered the URL and API key and clicked `Submit` your api token will no longer be visible.
|
||||
|
||||
|
||||
|
||||
Now, you're ready to [use the plugin from Jira issues](/integrations/jira_plugin_usage)
|
||||
39
websitev2/docs/integrations/jira-plugin-usage.md
Normal file
39
websitev2/docs/integrations/jira-plugin-usage.md
Normal file
@ -0,0 +1,39 @@
|
||||
---
|
||||
id: jira_plugin_usage
|
||||
title: Jira Integration - Usage
|
||||
---
|
||||
|
||||
> The Jira Plugin is part of Unleash Enterprise.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
### 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.
|
||||
|
||||
|
||||
|
||||
### Connecting existing feature toggle
|
||||
|
||||
- Still to come
|
||||
@ -1,50 +0,0 @@
|
||||
---
|
||||
id: jira_plugin
|
||||
title: Jira Integration
|
||||
---
|
||||
|
||||
# Jira Plugin (Enterprise only)
|
||||
|
||||
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.
|
||||
|
||||
## Installation
|
||||
|
||||
You will receive an installation link from your Unleash sales representative. You'll need to keep this link, since it will be needed for upgrades or uninstallation later. When following the link you'll be greeted by an installation screen similar to the one down below 
|
||||
|
||||
## Configuring plugin
|
||||
|
||||
Once installed you'll need to head to "Manage your apps"
|
||||
|
||||
 
|
||||
|
||||
Once there you should see "Unleash Admin" in your sidebar.
|
||||
|
||||
Click it and you'll get taken to our configuration page
|
||||
|
||||
|
||||
|
||||
Once on the configuration page. You should enter your installation URL and an API Key with access level `Admin`
|
||||
|
||||
- See [the API token doc](/user_guide/api-token) for how to configure an Admin token
|
||||
|
||||
|
||||
|
||||
After you've entered the URL and API key and clicked `Submit` your api token will no longer be visible.
|
||||
|
||||
|
||||
|
||||
Now, you're ready to use the plugin from Jira issues
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
Once you've entered the necessary information; name, project, toggle type, and whether the toggle starts out enabled you can 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.
|
||||
|
||||
|
||||
@ -93,6 +93,7 @@ module.exports = {
|
||||
]
|
||||
},
|
||||
"Integrations": {
|
||||
"Integrations": ["integrations/integrations", "integrations/jira_plugin"]
|
||||
"Integrations": ["integrations/integrations"],
|
||||
"JIRA": ["integrations/jira_plugin_installation", "integrations/jira_plugin_usage"]
|
||||
}
|
||||
};
|
||||
|
||||
Loading…
Reference in New Issue
Block a user