Add setup documentation for Jira and Linear

coderabbitai · karan925 · Mar 15, 2024 · Mar 15, 2024 · Mar 15, 2024 · Mar 16, 2024
commit f15d5c128eef72d1abd1321420903bced724655b
diff --git a/docs/integrations/jira.md → docs/integrations/Jira/link.md b/docs/integrations/jira.md → docs/integrations/Jira/link.md
@@ -1,7 +1,7 @@
 ---
-title: Connect CodeRabbit with Jira
+title: Integrate CodeRabbit with Jira
 description: Integrate CodeRabbit with Jira.
-sidebar_label: Jira
+sidebar_label: Link Issues with Pull Request
 image: "/preview_meta.jpg"
 ---
 

diff --git a/docs/integrations/Jira/setup.md b/docs/integrations/Jira/setup.md
@@ -0,0 +1,55 @@
+---
+title: Integrate CodeRabbit with Jira
+description: Integrate CodeRabbit with Jira.
+sidebar_label: Setup
+image: "/preview_meta.jpg"
+---
+
+<head>
+ <meta charSet="utf-8" />
+  <meta name="title" content="Connect CodeRabbit with Jira" />
+  <meta name="description" content="Integrate CodeRabbit with Jira" />
+
+  <meta property="og:type" content="website" />
+  <meta property="og:url" content="https://coderabbit.ai/" />
+  <meta property="og:title" content="Connect CodeRabbit with Jira" />
+  <meta property="og:description" content="CodeRabbit: AI-powered Code Reviews" />
+  <meta property="og:image" content="/preview_meta.jpg" />
+
+  <meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
+  <meta name="twitter:card" content="summary_large_image" />
+  <meta name="twitter:title" content="Connect CodeRabbit with Jira" />
+  <meta name="twitter:description" content="CodeRabbit: AI-powered Code Reviews" />
+</head>
+
+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.
+
+:::note
+Visit [Jira](https://www.atlassian.com/software/jira) if you're unfamiliar and would like to learn more.
+:::
+
+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.
+
+## Connect CodeRabbit with Jira
+
+![Integrations Page](../images/cr-integrations-light.png#gh-light-mode-only)
+
+Visit the integrations page by selecting Integrations on the left sidebar on the webapp. On this page, toggle the button for the Jira Integration.
+
+![Integrations Page](../images/jira-login-light.png#gh-light-mode-only)
+
+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.
+
+![Integrations Page](../images/jira-auth-light.png#gh-light-mode-only)
+
+Lastly, Jira will ask you to authorize CodeRabbit for read access to Jira Issues and read/write access to manage webhooks.
+
+**That's It!** Jira will redirect you back to the CodeRabbit integrations page where you should see the toggle enabled for the Jira Integration.
+
+### Disconnect CodeRabbit with Linear
+
+Disconnecting the integration is seamless. Just toggle the button off for the Linear Integration and CodeRabbit will automatically disconnect.
+
+---
+
+Next we will look at how we can link Jira issues with pull requests and see how CodeRabbit assess them within the Pull Request.
diff --git a/docs/integrations/linear.md → docs/integrations/Linear/link.md b/docs/integrations/linear.md → docs/integrations/Linear/link.md
@@ -1,7 +1,7 @@
 ---
-title: Connect CodeRabbit with Linear
-description: Integrate CodeRabbit with Linear.
-sidebar_label: Linear
+title: Utilize CodeRabbit with Linear
+description: Utilize CodeRabbit with Linear.
+sidebar_label: Link Issues with Pull Request
 image: "/preview_meta.jpg"
 ---
 

diff --git a/docs/integrations/Linear/setup.md b/docs/integrations/Linear/setup.md
@@ -0,0 +1,55 @@
+---
+title: Integrate CodeRabbit with Linear
+description: Integrate CodeRabbit with Linear.
+sidebar_label: Setup
+image: "/preview_meta.jpg"
+---
+
+<head>
+ <meta charSet="utf-8" />
+  <meta name="title" content="Connect CodeRabbit with Linear" />
+  <meta name="description" content="Integrate CodeRabbit with Linear" />
+
+  <meta property="og:type" content="website" />
+  <meta property="og:url" content="https://coderabbit.ai/" />
+  <meta property="og:title" content="Connect CodeRabbit with Linear" />
+  <meta property="og:description" content="CodeRabbit: AI-powered Code Reviews" />
+  <meta property="og:image" content="/preview_meta.jpg" />
+
+  <meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
+  <meta name="twitter:card" content="summary_large_image" />
+  <meta name="twitter:title" content="Connect CodeRabbit with Linear" />
+  <meta name="twitter:description" content="CodeRabbit: AI-powered Code Reviews" />
+</head>
+
+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.
+
+:::note
+Visit [Linear](https://linear.app/) if you're unfamiliar and would like to learn more.
+:::
+
+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.
+
+### Connect CodeRabbit with Linear
+
+![Integrations Page](../images/cr-integrations-light.png#gh-light-mode-only)
+
+On this page, toggle the button for the Linear Integration.
+
+![Integrations Page](../images/linear-login.png#gh-light-mode-only)
+
+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.
+
+![Integrations Page](../images/linear-auth.png#gh-light-mode-only)
+
+Lastly, Linear will ask you to authorize CodeRabbit for read access.
+
+**That's It!** Linear will redirect you back to the CodeRabbit integrations page where you should see the toggle enabled for the Linear Integration.
+
+### Disconnect CodeRabbit with Linear
+
+Disconnecting the integration is seamless. Just toggle the button off for the Linear Integration and CodeRabbit will automatically disconnect.
+
+---
+
+Next we will look at how we can link Linear Issues with pull requests and see how CodeRabbit assess them within the Pull Request.
diff --git a/docs/integrations/images/cr-integrations-light.png b/docs/integrations/images/cr-integrations-light.png
diff --git a/docs/integrations/images/jira-auth-light.png b/docs/integrations/images/jira-auth-light.png
diff --git a/docs/integrations/images/jira-login-light.png b/docs/integrations/images/jira-login-light.png
diff --git a/docs/integrations/images/linear-auth.png b/docs/integrations/images/linear-auth.png
diff --git a/docs/integrations/images/linear-login.png b/docs/integrations/images/linear-login.png
diff --git a/docs/integrations/self-hosted-gitlab.md b/docs/integrations/self-hosted-gitlab.md
@@ -11,22 +11,22 @@ To initiate the integration, we require specific information. This is essential
 for the initial setup of CodeRabbit within your domain. Once this setup is
 complete, you can log in directly using the OAuth2 flow.
 
-### **Step 1: Getting Started**
+### 1. Getting Started
 
 **Visit CodeRabbit:** Land on to our [Login](https://coderabbit.ai/login) page
 and select Self-Hosted GitLab
 
 ![login-page](./images/login-page.png)
 
-### Step 2: Enter your Self Managed GitLab URL
+### 2. Enter your Self Managed GitLab URL
-### 2. Enter your Self Managed GitLab URL
+### 2. Enter your Self-Managed GitLab URL
-### 2. Enter your Self Managed GitLab URL
+### 2. Enter your Self-Managed GitLab URL
 
 On this page, enter the URL of your self managed GitLab instance and click
 submit. Once, you submit, we check our database for a record of your
 organization.
 
 ![Untitled](./images/enter-url.png)
 
-### **Step 3: Enter Admin Personal Access Token (First time only)**
+### 3. Enter Admin Personal Access Token (First time only)
 
 If this is the first time you are signing up with your instance, we need an
 admin access token for setting up the CodeRabbit.
@@ -52,17 +52,21 @@ the token, please follow the process outlined below:
 
 ![Untitled](./images/admin-access-token.png)
 
-### **Step 4: Paste the token and click submit**
+### 4. Paste the Token and Submit
 
 - Submit the access token.
 - We will handle the setup process for you.
-- On subsequent visits, your setup will be automatically detected, allowing for
-  direct login. ![Untitled](./images/self-hosted-page.png)
 
-### **Step 5: Whitelist CodeRabbit IP address**
+![Untitled](./images/self-hosted-page.png)
+:::note
+For future visits, your setup will be automatically recognized, enabling seamless login.
+:::
+
+### 5. Whitelist CodeRabbit IP Address
 
 Use this CodeRabbit IP if your instance requires IP whitelisting
 `35.222.179.152/32`
 
-- Furthermore, please refer to our Get Started Guide to make the most of
-  CodeRabbit [here](../get-started/add-repo.md).
+:::tip
+Refer to our [Get Started Guide](../get-started/add-repo.md) to make the most of CodeRabbit.
+:::
diff --git a/sidebars.ts b/sidebars.ts
@@ -41,8 +41,16 @@ const sidebars: SidebarsConfig = {
       type: "category",
       label: "Integrations",
       items: [
-        "integrations/jira",
-        "integrations/linear",
+        {
+          type: "category",
+          label: "Jira",
+          items: ["integrations/Jira/setup", "integrations/Jira/link"],
+        },
+        {
+          type: "category",
+          label: "Linear",
+          items: ["integrations/Linear/setup", "integrations/Linear/link"],
+        },
         "integrations/self-hosted-gitlab",
       ],
     },