Skip to content

Commit f15d5c1

Browse files
karan925karan925
committed
Add setup documentation for Jira and Linear
1 parent 858b7f1 commit f15d5c1

11 files changed

+138
-16
lines changed

‎docs/integrations/jira.md renamed to ‎docs/integrations/Jira/link.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Connect CodeRabbit with Jira
2+
title: Integrate CodeRabbit with Jira
33
description: Integrate CodeRabbit with Jira.
4-
sidebar_label: Jira
4+
sidebar_label: Link Issues with Pull Request
55
image: "/preview_meta.jpg"
66
---
77

‎docs/integrations/Jira/setup.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Integrate CodeRabbit with Jira
3+
description: Integrate CodeRabbit with Jira.
4+
sidebar_label: Setup
5+
image: "/preview_meta.jpg"
6+
---
7+
8+
<head>
9+
<meta charSet="utf-8" />
10+
<meta name="title" content="Connect CodeRabbit with Jira" />
11+
<meta name="description" content="Integrate CodeRabbit with Jira" />
12+
13+
<meta property="og:type" content="website" />
14+
<meta property="og:url" content="https://coderabbit.ai/" />
15+
<meta property="og:title" content="Connect CodeRabbit with Jira" />
16+
<meta property="og:description" content="CodeRabbit: AI-powered Code Reviews" />
17+
<meta property="og:image" content="/preview_meta.jpg" />
18+
19+
<meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
20+
<meta name="twitter:card" content="summary_large_image" />
21+
<meta name="twitter:title" content="Connect CodeRabbit with Jira" />
22+
<meta name="twitter:description" content="CodeRabbit: AI-powered Code Reviews" />
23+
</head>
24+
25+
Jira is a widely-used project management tool that helps teams organize tasks, track progress, and collaborate effectively. With Jira, teams can create issues to represent tasks, bugs, or features, assign them to team members, set due dates, and monitor their status throughout the project lifecycle.
26+
27+
:::note
28+
Visit [Jira](https://www.atlassian.com/software/jira) if you're unfamiliar and would like to learn more.
29+
:::
30+
31+
As your team works on resolving Jira issues, CodeRabbit automatically assesses the changes made in the associated pull requests, helping you meet project objectives and maintain code quality standards.
32+
33+
## Connect CodeRabbit with Jira
34+
35+
![Integrations Page](../images/cr-integrations-light.png#gh-light-mode-only)
36+
37+
Visit the integrations page by selecting Integrations on the left sidebar on the webapp. On this page, toggle the button for the Jira Integration.
38+
39+
![Integrations Page](../images/jira-login-light.png#gh-light-mode-only)
40+
41+
Once toggling, you will be redirected over to Jira's authorization page. If you are not signed in, please sign in with your Jira credentials.
42+
43+
![Integrations Page](../images/jira-auth-light.png#gh-light-mode-only)
44+
45+
Lastly, Jira will ask you to authorize CodeRabbit for read access to Jira Issues and read/write access to manage webhooks.
46+
47+
**That's It!** Jira will redirect you back to the CodeRabbit integrations page where you should see the toggle enabled for the Jira Integration.
48+
49+
### Disconnect CodeRabbit with Linear
50+
51+
Disconnecting the integration is seamless. Just toggle the button off for the Linear Integration and CodeRabbit will automatically disconnect.
52+
53+
---
54+
55+
Next we will look at how we can link Jira issues with pull requests and see how CodeRabbit assess them within the Pull Request.

‎docs/integrations/linear.md renamed to ‎docs/integrations/Linear/link.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Connect CodeRabbit with Linear
3-
description: Integrate CodeRabbit with Linear.
4-
sidebar_label: Linear
2+
title: Utilize CodeRabbit with Linear
3+
description: Utilize CodeRabbit with Linear.
4+
sidebar_label: Link Issues with Pull Request
55
image: "/preview_meta.jpg"
66
---
77

‎docs/integrations/Linear/setup.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Integrate CodeRabbit with Linear
3+
description: Integrate CodeRabbit with Linear.
4+
sidebar_label: Setup
5+
image: "/preview_meta.jpg"
6+
---
7+
8+
<head>
9+
<meta charSet="utf-8" />
10+
<meta name="title" content="Connect CodeRabbit with Linear" />
11+
<meta name="description" content="Integrate CodeRabbit with Linear" />
12+
13+
<meta property="og:type" content="website" />
14+
<meta property="og:url" content="https://coderabbit.ai/" />
15+
<meta property="og:title" content="Connect CodeRabbit with Linear" />
16+
<meta property="og:description" content="CodeRabbit: AI-powered Code Reviews" />
17+
<meta property="og:image" content="/preview_meta.jpg" />
18+
19+
<meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
20+
<meta name="twitter:card" content="summary_large_image" />
21+
<meta name="twitter:title" content="Connect CodeRabbit with Linear" />
22+
<meta name="twitter:description" content="CodeRabbit: AI-powered Code Reviews" />
23+
</head>
24+
25+
Linear is the project planning tool for teams dedicated to quality. Like Jira, it facilitates task organization, progress tracking, and seamless collaboration. Users can create issues to outline tasks, bugs, or features, assign them, set deadlines, and monitor their progress across the project lifecycle.
26+
27+
:::note
28+
Visit [Linear](https://linear.app/) if you're unfamiliar and would like to learn more.
29+
:::
30+
31+
As your team works on resolving Linear issues, CodeRabbit automatically assesses the changes made in the associated pull requests, helping you meet project objectives and maintain code quality standards.
32+
33+
### Connect CodeRabbit with Linear
34+
35+
![Integrations Page](../images/cr-integrations-light.png#gh-light-mode-only)
36+
37+
On this page, toggle the button for the Linear Integration.
38+
39+
![Integrations Page](../images/linear-login.png#gh-light-mode-only)
40+
41+
Once toggling, you will be redirected over to Linear's authorization page. If you are not signed in, please sign in with your Linear credentials.
42+
43+
![Integrations Page](../images/linear-auth.png#gh-light-mode-only)
44+
45+
Lastly, Linear will ask you to authorize CodeRabbit for read access.
46+
47+
**That's It!** Linear will redirect you back to the CodeRabbit integrations page where you should see the toggle enabled for the Linear Integration.
48+
49+
### Disconnect CodeRabbit with Linear
50+
51+
Disconnecting the integration is seamless. Just toggle the button off for the Linear Integration and CodeRabbit will automatically disconnect.
52+
53+
---
54+
55+
Next we will look at how we can link Linear Issues with pull requests and see how CodeRabbit assess them within the Pull Request.

‎docs/integrations/images/cr-integrations-light.png

278 KB
Loading

‎docs/integrations/images/jira-auth-light.png

243 KB
Loading

‎docs/integrations/images/jira-login-light.png

545 KB
Loading

‎docs/integrations/images/linear-auth.png

293 KB
Loading

‎docs/integrations/images/linear-login.png

162 KB
Loading

‎docs/integrations/self-hosted-gitlab.md

+13-9
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,22 @@ To initiate the integration, we require specific information. This is essential
1111
for the initial setup of CodeRabbit within your domain. Once this setup is
1212
complete, you can log in directly using the OAuth2 flow.
1313

14-
### **Step 1: Getting Started**
14+
### 1. Getting Started
1515

1616
**Visit CodeRabbit:** Land on to our [Login](https://coderabbit.ai/login) page
1717
and select Self-Hosted GitLab
1818

1919
![login-page](./images/login-page.png)
2020

21-
### Step 2: Enter your Self Managed GitLab URL
21+
### 2. Enter your Self Managed GitLab URL
2222

2323
On this page, enter the URL of your self managed GitLab instance and click
2424
submit. Once, you submit, we check our database for a record of your
2525
organization.
2626

2727
![Untitled](./images/enter-url.png)
2828

29-
### **Step 3: Enter Admin Personal Access Token (First time only)**
29+
### 3. Enter Admin Personal Access Token (First time only)
3030

3131
If this is the first time you are signing up with your instance, we need an
3232
admin access token for setting up the CodeRabbit.
@@ -52,17 +52,21 @@ the token, please follow the process outlined below:
5252

5353
![Untitled](./images/admin-access-token.png)
5454

55-
### **Step 4: Paste the token and click submit**
55+
### 4. Paste the Token and Submit
5656

5757
- Submit the access token.
5858
- We will handle the setup process for you.
59-
- On subsequent visits, your setup will be automatically detected, allowing for
60-
direct login. ![Untitled](./images/self-hosted-page.png)
6159

62-
### **Step 5: Whitelist CodeRabbit IP address**
60+
![Untitled](./images/self-hosted-page.png)
61+
:::note
62+
For future visits, your setup will be automatically recognized, enabling seamless login.
63+
:::
64+
65+
### 5. Whitelist CodeRabbit IP Address
6366

6467
Use this CodeRabbit IP if your instance requires IP whitelisting
6568
`35.222.179.152/32`
6669

67-
- Furthermore, please refer to our Get Started Guide to make the most of
68-
CodeRabbit [here](../get-started/add-repo.md).
70+
:::tip
71+
Refer to our [Get Started Guide](../get-started/add-repo.md) to make the most of CodeRabbit.
72+
:::

‎sidebars.ts

+10-2
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,16 @@ const sidebars: SidebarsConfig = {
4141
type: "category",
4242
label: "Integrations",
4343
items: [
44-
"integrations/jira",
45-
"integrations/linear",
44+
{
45+
type: "category",
46+
label: "Jira",
47+
items: ["integrations/Jira/setup", "integrations/Jira/link"],
48+
},
49+
{
50+
type: "category",
51+
label: "Linear",
52+
items: ["integrations/Linear/setup", "integrations/Linear/link"],
53+
},
4654
"integrations/self-hosted-gitlab",
4755
],
4856
},

0 commit comments

Comments
 (0)