d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
3.7 KiB
| 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.
Prerequisites
Jira
- Jira data center, v8.0 or higher
We do not support Jira Cloud at the moment.
Unleash
- Unleash v4 or higher
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 available in the Atlassian marketplace.
You'll need to download the plugin and create a license key.
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.
Once you've downloaded the plugin artifact, you'll need to follow the Manage apps link in Jira's administration menu.
On the Manage apps page, use the "upload app" button.
This will prompt you to select the plugin file you downloaded in the previous steps for upload.
Once you've selected your file and started the upload, Jira will install the plugin. If the installation is successful, you'll get a status screen saying that it successfully installed.
Configuring the 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
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 cannot delete a server that has toggles connected to issues. Instead, you'll get a warning dialog telling you that you'll need to disconnect the toggles from their issues first.
