1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
unleash.unleash/website/docs/reference/integrations/jira-server-plugin-usage.md
Thomas Heartman d5fbd0b743
refactor: move docs into new structure / fix links for SEO (#2416)
## 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.
2022-11-22 09:05:30 +00:00

2.0 KiB

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

Clicking this button opens a dialog, allowing you to either connect an existing toggle

Jira Server - Add Existing toggle

or if you flip the switch that says "Use existing toggle", allows you to create a new toggle

Jira Server - Add new toggle

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

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

Once you click the button, you'll need to confirm the dialog that opens up.

Jira Server - Disconnect toggle dialog

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