Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
Code Issues Projects Releases Wiki Activity
bc55247e9f
unleash.unleash/website/docs/reference/integrations/jira-cloud-plugin-installation.mdx

54 lines
2.2 KiB
Plaintext
Raw Normal View History

docs: jira cloud documentation (#3494) <!-- Thanks for creating a PR! To make it easier for reviewers and everyone else to understand what your changes relate to, please add some relevant content to the headings below. Feel free to ignore or delete sections that you don't think are relevant. Thank you! ❤️ --> New PR using correct prefixes ## About the changes <!-- Describe the changes introduced. What are they and why are they being introduced? Feel free to also add screenshots or steps to view the changes if they're visual. --> Adds documentation to the docs website for the new Jira Cloud plugin. Couple of pieces on install page are missing due to the nature of having to have the docs before we can start the review process after which we'll get the final details on how/where to install/from etc. Also a couple of pending fixes that might impact screenshots/warrant new ones made ![Skjermbilde 2023-04-06 kl 12 34 40](https://user-images.githubusercontent.com/707867/230353148-98c5915f-0d97-4cba-bec5-33d46503448d.png) ![Skjermbilde 2023-04-06 kl 12 34 49](https://user-images.githubusercontent.com/707867/230353157-e9dd3f57-e6a3-4e9b-a966-ebdfcdaf2581.png) <!-- (For internal contributors): Does it relate to an issue on public roadmap? --> Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item: #2952 ### Important files <!-- PRs can contain a lot of changes, but not all changes are equally important. Where should a reviewer start looking to get an overview of the changes? Are any files particularly important? --> - website/docs/reference/integrations/jira-cloud-plugin-installation.md - website/docs/reference/integrations/jira-cloud-plugin-usage.md ## Discussion points <!-- Anything about the PR you'd like to discuss before it gets merged? Got any questions or doubts? --> Very open to improvements on wording and tips on standards used in screenshots --------- Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-04-17 15:16:01 +02:00
---
title: Jira Cloud Integration - Installation
---
import Figure from '@site/src/components/Figure/Figure.tsx'
Align availability information in the docs (#8177)
2024-10-03 10:33:22 +02:00
:::note Availability
Introduce availability page in the docs (#8644)
2024-11-06 12:43:03 +01:00
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.0+`
Align availability information in the docs (#8177)
2024-10-03 10:33:22 +02:00
:::
docs: jira cloud documentation (#3494) <!-- Thanks for creating a PR! To make it easier for reviewers and everyone else to understand what your changes relate to, please add some relevant content to the headings below. Feel free to ignore or delete sections that you don't think are relevant. Thank you! ❤️ --> New PR using correct prefixes ## About the changes <!-- Describe the changes introduced. What are they and why are they being introduced? Feel free to also add screenshots or steps to view the changes if they're visual. --> Adds documentation to the docs website for the new Jira Cloud plugin. Couple of pieces on install page are missing due to the nature of having to have the docs before we can start the review process after which we'll get the final details on how/where to install/from etc. Also a couple of pending fixes that might impact screenshots/warrant new ones made ![Skjermbilde 2023-04-06 kl 12 34 40](https://user-images.githubusercontent.com/707867/230353148-98c5915f-0d97-4cba-bec5-33d46503448d.png) ![Skjermbilde 2023-04-06 kl 12 34 49](https://user-images.githubusercontent.com/707867/230353157-e9dd3f57-e6a3-4e9b-a966-ebdfcdaf2581.png) <!-- (For internal contributors): Does it relate to an issue on public roadmap? --> Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item: #2952 ### Important files <!-- PRs can contain a lot of changes, but not all changes are equally important. Where should a reviewer start looking to get an overview of the changes? Are any files particularly important? --> - website/docs/reference/integrations/jira-cloud-plugin-installation.md - website/docs/reference/integrations/jira-cloud-plugin-usage.md ## Discussion points <!-- Anything about the PR you'd like to discuss before it gets merged? Got any questions or doubts? --> Very open to improvements on wording and tips on standards used in screenshots --------- Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-04-17 15:16:01 +02:00
## 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)
## Required access levels
### Unleash
You will need an Unleash admin user to configure the access tokens needed to connect the plugin to Unleash.
Fix incorrect md file extensions in docs (#8462)
2024-10-17 11:52:02 +02:00
We recommend using a [service account](../service-accounts.md) token for communicating with Unleash. Service accounts are also required to integrate with [change requests](../change-requests)
docs: jira cloud documentation (#3494) <!-- Thanks for creating a PR! To make it easier for reviewers and everyone else to understand what your changes relate to, please add some relevant content to the headings below. Feel free to ignore or delete sections that you don't think are relevant. Thank you! ❤️ --> New PR using correct prefixes ## About the changes <!-- Describe the changes introduced. What are they and why are they being introduced? Feel free to also add screenshots or steps to view the changes if they're visual. --> Adds documentation to the docs website for the new Jira Cloud plugin. Couple of pieces on install page are missing due to the nature of having to have the docs before we can start the review process after which we'll get the final details on how/where to install/from etc. Also a couple of pending fixes that might impact screenshots/warrant new ones made ![Skjermbilde 2023-04-06 kl 12 34 40](https://user-images.githubusercontent.com/707867/230353148-98c5915f-0d97-4cba-bec5-33d46503448d.png) ![Skjermbilde 2023-04-06 kl 12 34 49](https://user-images.githubusercontent.com/707867/230353157-e9dd3f57-e6a3-4e9b-a966-ebdfcdaf2581.png) <!-- (For internal contributors): Does it relate to an issue on public roadmap? --> Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item: #2952 ### Important files <!-- PRs can contain a lot of changes, but not all changes are equally important. Where should a reviewer start looking to get an overview of the changes? Are any files particularly important? --> - website/docs/reference/integrations/jira-cloud-plugin-installation.md - website/docs/reference/integrations/jira-cloud-plugin-usage.md ## Discussion points <!-- Anything about the PR you'd like to discuss before it gets merged? Got any questions or doubts? --> Very open to improvements on wording and tips on standards used in screenshots --------- Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-04-17 15:16:01 +02:00
### Jira
You will need a Jira admin user.
## Installation
docs: add description of how to install jira cloud plugin (#4197)
2023-07-13 09:36:38 +02:00
Start by visiting the [Landing page for the Unleash Enterprise For Jira plugin on Atlassian marketplace](https://marketplace.atlassian.com/apps/1231447/unleash-enterprise-for-jira?hosting=cloud&tab=overview).
![Atlassian marketplace landing page for the Unleash Enterprise For Jira plugin.](/img/unleash-marketplace-for-unleash-enterprise-jira-plugin.png)
1. Click the yellow button in the top right corner labeled "Get it now"
2. Choose which site to install the app to.
3. Click the blue "Install app" button located at the bottom right.
docs: jira cloud documentation (#3494) <!-- Thanks for creating a PR! To make it easier for reviewers and everyone else to understand what your changes relate to, please add some relevant content to the headings below. Feel free to ignore or delete sections that you don't think are relevant. Thank you! ❤️ --> New PR using correct prefixes ## About the changes <!-- Describe the changes introduced. What are they and why are they being introduced? Feel free to also add screenshots or steps to view the changes if they're visual. --> Adds documentation to the docs website for the new Jira Cloud plugin. Couple of pieces on install page are missing due to the nature of having to have the docs before we can start the review process after which we'll get the final details on how/where to install/from etc. Also a couple of pending fixes that might impact screenshots/warrant new ones made ![Skjermbilde 2023-04-06 kl 12 34 40](https://user-images.githubusercontent.com/707867/230353148-98c5915f-0d97-4cba-bec5-33d46503448d.png) ![Skjermbilde 2023-04-06 kl 12 34 49](https://user-images.githubusercontent.com/707867/230353157-e9dd3f57-e6a3-4e9b-a966-ebdfcdaf2581.png) <!-- (For internal contributors): Does it relate to an issue on public roadmap? --> Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item: #2952 ### Important files <!-- PRs can contain a lot of changes, but not all changes are equally important. Where should a reviewer start looking to get an overview of the changes? Are any files particularly important? --> - website/docs/reference/integrations/jira-cloud-plugin-installation.md - website/docs/reference/integrations/jira-cloud-plugin-usage.md ## Discussion points <!-- Anything about the PR you'd like to discuss before it gets merged? Got any questions or doubts? --> Very open to improvements on wording and tips on standards used in screenshots --------- Co-authored-by: Simon Hornby <liquidwicked64@gmail.com> Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-04-17 15:16:01 +02:00
## 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)
Reference in New Issue Copy Permalink