1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
unleash.unleash/website/docs/reference/integrations/jira-cloud-plugin-usage.mdx

68 lines
3.7 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 - Usage
---
import Figure from '@site/src/components/Figure/Figure.tsx'
With the Unleash Jira Cloud Plugin you can create, view and manage Unleash feature flags directly from a Jira issue.
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
The plugin also shows you current status of connected flags.
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
## 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.
<Figure caption="The Unleash Feature Flags button gets added to the top-level actions of new issues. Use that button to activate the Unleash plugin for that issue." img="/img/jira-cloud-activate-unleash-panel-button.png" />
### Connecting a flag to an issue
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
<Figure caption="Once active, the Unleash plugin adds a button labeled 'connect toggle' to the issue." img="/img/jira-cloud-issue-button.png" />
Use the issue's "connect toggle" button to open a dialog.
There are a few steps to connect a flag:
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
1. Select the Unleash project that contains the flag:
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 Cloud: connect feature flag form. The project selection dropdown contains all Unleash projects](/img/jira-cloud-select-project-expanded.png)
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
2. Use the "create new toggle" option to choose whether you want to add an existing flag or create a new one.
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
<Figure caption="When you add an existing flag, use the flag name select list to choose from existing flags in the selected Unleash project." img="/img/jira-cloud-add-existing-toggle.png" />
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
<Figure caption="When you add a new flag, you must give it a name and can choose to give it a description." img="/img/jira-cloud-add-new-toggle.png" />
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
### Flag status as part of Issue view
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
Once you've connected at least one flag to an issue, the Unleash plugin will list the current status of each environment for
that flag. If the current user is allowed to edit the issue, they can also enable or disable environments directly
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
from Jira.
<Figure caption="A Jira Cloud issue with a connected flag. The Unleash feature flags section now shows the connected flags along with the flag's environments. There are controls to enable or disable the flag in the development and production environments" img="/img/jira-cloud-toggle-status.png" />
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
### Change Requests
The plugin respects Unleash's [change requests](../change-requests). If change requests are turned on in the connected project and the selected environment, the plugin will ask whether you want to create a change request or not.
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
If you already have an active change request for that project and that environment, the changes will be added to your existing change request.
If you confirm that you would like to open a change request, then the plugin will create one for you and present a confirmation dialog.
<Figure caption="A dialog appears when the plugin creates a change request for you. The dialog contains a link directly to the newly created change request." img="/img/jira-cloud-change-request-confirmation.png" />
When the Change Request has been reviewed and applied in Unleash, the flag will show the requested state after the next refresh
of the issue and flag status page.
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
### Disconnecting flag from Issue
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
If a flag is no longer relevant for your Jira Issue, you can disconnect it using the "disconnect toggle" button. This button is only available if your user has edit permissions for the Jira issue.
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 Cloud: issue with a connected flag. The 'disconnect flag' button (highlighted) is displayed next to the flag's name.](/img/jira-cloud-disconnect-toggle.png)
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
The flag will be disconnected immediately. However, the plugin will not delete the flag from Unleash,
so you can still reconnect your Jira issue to the same flag using the "Connect to existing flag" functionality