Skip to content

Commit 48a5c78

Browse files
feat(jira): Update dev setup docs for Jira setup/installation (#12421)
1 parent b1ccf21 commit 48a5c78

File tree

8 files changed

+31
-13
lines changed

8 files changed

+31
-13
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading

develop-docs/integrations/jira/index.mdx

+31-13
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,44 @@ title: Jira Integration
33
sidebar_title: Jira
44
---
55

6-
Create an [Atlassian Cloud Developer Instance](http://go.atlassian.com/cloud-dev)
6+
## Create an Atlassian Cloud Developer Instance
77

8-
Atlassian offers a development-specific org option, different from simply having a personal Jira organization. Even if you already have a personal Jira org, it's worth creating a development org, because it will correctly set a number of necessary options for you automatically.
8+
[Atlassian offers a development-specific org](http://go.atlassian.com/cloud-dev) option, different from simply having a personal Jira organization. Even if you already have a personal Jira org, it's worth creating a development org, because it will correctly set a number of necessary options for you automatically.
99

10-
Set Up ngrok
10+
### Permissions for Certain Features
1111

12-
(This is only necessary if you're developing locally.) [Download](https://ngrok.com/download) and [set up](https://ngrok.com/docs/getting-started/) ngrok, then start an ngrok server.
12+
To enable issue-sync between Jira and a locally hosted Sentry Jira integration, you must set your email address permission to "Anyone". This setting can be found in the [Profile and visiblity](https://id.atlassian.com/manage-profile/profile-and-visibility) page under "Contact".
1313

14-
Configure Jira Settings
14+
15+
## Set Up ngrok
16+
17+
[Download](https://ngrok.com/download) and [set up](https://ngrok.com/docs/getting-started/) ngrok, then start an ngrok server. If you are using getsentry devserver, follow our [ngrok guide](https://develop.sentry.dev/development-infrastructure/ngrok/).
18+
19+
## Installing Local Jira App
1520

1621
1. If you don't have any projects in your Jira org yet, create a new project.
17-
2. In the navigation bar at the top of the screen, go to Apps > Manage Your Apps.
18-
3. At the bottom of the Manage Apps page, click Settings (1).
19-
4. Select Enable Development Mode and Enable Private Listings (2), and click Apply.
22+
2. In the navigation bar at the top of the screen, click on the waffle icon (1), select the desired organization and click "Administration" (2).
23+
![Navigating to Administration](./images/jira-setup1.png)
24+
25+
3. In the navigation bar, click "Products" (3) and under "Sites and products" (4) select the appropriate site/product with your Jira project.
26+
![Navigating to the Correct Site](./images/jira-setup1.5.png)
27+
28+
4. In the sidebar on the left, click on "Connected apps" (5) and then click on the Settings tab (6).
29+
5. Click on the button labeled "Install a private app" (7).
30+
![Navigating to Connected Apps](./images/jira-setup2.png)
31+
32+
6. In the new modal, select JIRA for the product to install the app on (8).
33+
7. For the "App descriptor URL" (9), use the following URL, `https://{YOUR_SENTRY_DOMAIN}/extensions/jira/descriptor/`. Note that if you are running a local devserver, `YOUR_SENTRY_DOMAIN` will be your ngrok (or other tunneling service) domain.
34+
![Filling out Modal](./images/jira-setup3.png)
2035

21-
![Jira Settings](./configure-jira.png)
36+
8. Click "Install app" (10), now if you select the "Installed Apps" (11) tab next to "Settings", you should see your newly installed app listed under "Sentry" (12). (Note: that "Sentry for Jira" is the SaaS integration).
37+
9. On the right the newly installed app click on the three dots and then click "Manage" (13).
38+
![Navigating to App Listing](./images/jira-setup4.png)
2239

23-
5. Reload the page, and Upload App should appear next to Build a New App.
24-
6. Click Upload App and upload the Atlassian Connect descriptor by using the URL  `https://{YOUR_SENTRY_DOMAIN}/extensions/jira/descriptor/`. Note that if you are running a local devserver, `YOUR_SENTRY_DOMAIN` will be your ngrok (or other tunneling service) domain.
40+
10. In the app listing, click on the three dots in the top right and click "Configure" (14).
41+
![Navigating to Configure App](./images/jira-setup5.png)
2542

26-
![Upload Descriptor to Jira](./upload-descriptor.png)
43+
11. Click "Finish Installation in Sentry" and select the desired organization to install the Jira integration on.
44+
![Last step on Jira site](./images/jira-setup6.png)
2745

28-
Follow our [documentation on installing and configuring the Jira integration](https://docs.sentry.io/product/integrations/issue-tracking/jira/) to use the integration.
46+
From here follow our [documentation on installing and configuring the Jira integration](https://docs.sentry.io/product/integrations/issue-tracking/jira/) to use the integration (For reference: We just completed the equivalent to Step 4 under that page's "Install" section).

0 commit comments

Comments
 (0)