diff --git a/docs/integrations/Jira/link.md b/docs/integrations/Jira/link.md new file mode 100644 index 00000000..b56e31f7 --- /dev/null +++ b/docs/integrations/Jira/link.md @@ -0,0 +1,50 @@ +--- +title: Jira Integration +description: Integrate CodeRabbit with Jira. +sidebar_label: Linked and Related Issues +image: "/preview_meta.jpg" +--- + + + + + + + + + + + + + + + + + + +### Linking Issues + +After successfully integrating CodeRabbit with Jira, you gain the ability to link Jira issues directly to your pull requests. + +To link a Jira issue to a pull request, simply include the Jira Issue ID in the pull request description. For instance: + +Jira issue: TEK-01 + +This indicates that the pull request addresses a specific issue, such as fixing a bug. When the pull request is submitted with the associated Jira Issue ID, CodeRabbit automatically retrieves the corresponding issue and evaluates whether the pull request fulfills its objectives. + +:::info +You can view the assessment outcome in the Walkthrough section of CodeRabbit's Review +::: + +Upon posting the review findings, CodeRabbit provides details about the issue's objectives, confirms whether they were met, and offers additional explanations if needed. + +### Finding Related Issues + +One of the key features of CodeRabbit's Jira integration is its ability to discover existing related Jira issues addressed in the pull request. Leveraging RAG (Retrieval-Augmented Generation), CodeRabbit enhances its AI capabilities. RAG empowers AI models to incorporate external data sources beyond their training sets or predefined parameters, thereby enhancing their responses to given prompts. + +After integrating with Jira, CodeRabbit scans through open issues, indexing them for future reference. This means that pre-existing issues are retrieved, indexed into a Vector database, and subsequently searched for each new pull request. +:::info +Indexing occurs periodically on a scheduled basis. As a result, newly created issues or those not yet scheduled for indexing may not be immediately detected by CodeRabbit. +::: + +If any related issues are identified, CodeRabbit highlights them, providing insights into the pull request's coverage and facilitating collaboration between developers and reviewers. diff --git a/docs/integrations/Jira/setup.md b/docs/integrations/Jira/setup.md new file mode 100644 index 00000000..37823f96 --- /dev/null +++ b/docs/integrations/Jira/setup.md @@ -0,0 +1,61 @@ +--- +title: Integrate CodeRabbit with Jira +description: Integrate CodeRabbit with Jira. +sidebar_label: Setup +image: "/preview_meta.jpg" +--- + + + + + + + + + + + + + + + + + + +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) +![Integrations Page](../images/cr-integrations-dark.png#gh-dark-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/jira-login-light.png#gh-light-mode-only) +![Integrations Page](../images/Jira/jira-login-dark.png#gh-dark-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/jira-auth-light.png#gh-light-mode-only) +![Integrations Page](../images/Jira/jira-auth-dark.png#gh-dark-mode-only) + +Lastly, Jira will ask you to authorize CodeRabbit for read access to Jira Issues and read/write access to manage webhooks. + +![Integrations Page](../images/Jira/jira-connected-dark.png#gh-dark-mode-only) +![Integrations Page](../images/Jira/jira-connected-light.png#gh-light-mode-only) + +**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 Jira + +Disconnecting the integration is seamless. Just toggle the button off for the Jira Integration and CodeRabbit will automatically disconnect. + +--- + +Next we will look at how we can link Jira issues and see how CodeRabbit assess them within the Pull Request. diff --git a/docs/integrations/Linear/link.md b/docs/integrations/Linear/link.md new file mode 100644 index 00000000..f1c99e72 --- /dev/null +++ b/docs/integrations/Linear/link.md @@ -0,0 +1,51 @@ +--- +title: Linear Integration +description: Utilize CodeRabbit with Linear. +sidebar_label: Linked and Related Issues +image: "/preview_meta.jpg" +--- + + + + + + + + + + + + + + + + + + +### Linking Issues + +After successfully integrating CodeRabbit with Linear, you gain the ability to link Linear issues directly to your pull requests. + +To link a Linear issue to a pull request, simply include the Linear Issue ID in the pull request description. + +For instance: + +Linear issue: **_COD-86_** + +![Linear Issue](../images/Linear/link/linear-linked-issue.png) + +This indicates that the pull request addresses a specific issue, such as adding a new feature. In this simple example, the issue created on linear specified to implement the division functionality for the simple calculator. + +When the pull request is submitted with the associated Linear Issue ID, CodeRabbit automatically retrieves the corresponding issue and evaluates whether the pull request fulfills its objectives. + +:::info +You can view the assessment outcome in the Walkthrough section of CodeRabbit's Review. +::: + +Upon posting the review findings, CodeRabbit provides details about the issue's objectives, confirms whether they were met, and offers additional explanations if needed. For example, here, the developer added the division functionality for the simple calculator in the pull request. CodeRabbit was able to find that issue, assess whether the pull request did indeed resolve the issue, and provided the assessment as seen below. + +![Linear Issue Response](../images/Linear/link/linear-assessment.png) + +### Finding Related Issues + +Another key feature of CodeRabbit's Linear integration is its ability to discover existing related Linear issues addressed in a pull request. Leveraging RAG (Retrieval-Augmented Generation) as described in [Jira Integration - Finding Related Issues](../Jira/link#finding-related-issues) diff --git a/docs/integrations/Linear/setup.md b/docs/integrations/Linear/setup.md new file mode 100644 index 00000000..defd4fba --- /dev/null +++ b/docs/integrations/Linear/setup.md @@ -0,0 +1,61 @@ +--- +title: Integrate CodeRabbit with Linear +description: Integrate CodeRabbit with Linear. +sidebar_label: Setup +image: "/preview_meta.jpg" +--- + + + + + + + + + + + + + + + + + + +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) +![Integrations Page](../images/cr-integrations-dark.png#gh-dark-mode-only) + +On this page, toggle the button for the Linear Integration. + +![Integrations Page](../images/Linear/setup/linear-login-light.png#gh-light-mode-only) +![Integrations Page](../images/Linear/setup/linear-login.png#gh-dark-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/setup/linear-auth-light.png#gh-light-mode-only) +![Integrations Page](../images/Linear/setup/linear-auth.png#gh-dark-mode-only) + +Lastly, Linear will ask you to authorize CodeRabbit for read access. + +![Integrations Page](../images/Linear/setup/linear-connected-dark.png#gh-dark-mode-only) +![Integrations Page](../images/Linear/setup/linear-connected-light.png#gh-light-mode-only) + +**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/Jira/jira-auth-dark.png b/docs/integrations/images/Jira/jira-auth-dark.png new file mode 100644 index 00000000..6d30e3b9 Binary files /dev/null and b/docs/integrations/images/Jira/jira-auth-dark.png differ diff --git a/docs/integrations/images/Jira/jira-auth-light.png b/docs/integrations/images/Jira/jira-auth-light.png new file mode 100644 index 00000000..3c7d1b64 Binary files /dev/null and b/docs/integrations/images/Jira/jira-auth-light.png differ diff --git a/docs/integrations/images/Jira/jira-connected-dark.png b/docs/integrations/images/Jira/jira-connected-dark.png new file mode 100644 index 00000000..3675a74c Binary files /dev/null and b/docs/integrations/images/Jira/jira-connected-dark.png differ diff --git a/docs/integrations/images/Jira/jira-connected-light.png b/docs/integrations/images/Jira/jira-connected-light.png new file mode 100644 index 00000000..d06e6428 Binary files /dev/null and b/docs/integrations/images/Jira/jira-connected-light.png differ diff --git a/docs/integrations/images/Jira/jira-login-dark.png b/docs/integrations/images/Jira/jira-login-dark.png new file mode 100644 index 00000000..c7fb8dfd Binary files /dev/null and b/docs/integrations/images/Jira/jira-login-dark.png differ diff --git a/docs/integrations/images/Jira/jira-login-light.png b/docs/integrations/images/Jira/jira-login-light.png new file mode 100644 index 00000000..595f1fd2 Binary files /dev/null and b/docs/integrations/images/Jira/jira-login-light.png differ diff --git a/docs/integrations/images/Linear/link/linear-assessment.png b/docs/integrations/images/Linear/link/linear-assessment.png new file mode 100644 index 00000000..aef6e21a Binary files /dev/null and b/docs/integrations/images/Linear/link/linear-assessment.png differ diff --git a/docs/integrations/images/Linear/link/linear-linked-issue.png b/docs/integrations/images/Linear/link/linear-linked-issue.png new file mode 100644 index 00000000..11a8c066 Binary files /dev/null and b/docs/integrations/images/Linear/link/linear-linked-issue.png differ diff --git a/docs/integrations/images/Linear/setup/linear-auth-light.png b/docs/integrations/images/Linear/setup/linear-auth-light.png new file mode 100644 index 00000000..e76ab8d7 Binary files /dev/null and b/docs/integrations/images/Linear/setup/linear-auth-light.png differ diff --git a/docs/integrations/images/Linear/setup/linear-auth.png b/docs/integrations/images/Linear/setup/linear-auth.png new file mode 100644 index 00000000..4b0a0737 Binary files /dev/null and b/docs/integrations/images/Linear/setup/linear-auth.png differ diff --git a/docs/integrations/images/Linear/setup/linear-connected-dark.png b/docs/integrations/images/Linear/setup/linear-connected-dark.png new file mode 100644 index 00000000..c3a74149 Binary files /dev/null and b/docs/integrations/images/Linear/setup/linear-connected-dark.png differ diff --git a/docs/integrations/images/Linear/setup/linear-connected-light.png b/docs/integrations/images/Linear/setup/linear-connected-light.png new file mode 100644 index 00000000..c30791a7 Binary files /dev/null and b/docs/integrations/images/Linear/setup/linear-connected-light.png differ diff --git a/docs/integrations/images/Linear/setup/linear-login-light.png b/docs/integrations/images/Linear/setup/linear-login-light.png new file mode 100644 index 00000000..cd8f1e5d Binary files /dev/null and b/docs/integrations/images/Linear/setup/linear-login-light.png differ diff --git a/docs/integrations/images/Linear/setup/linear-login.png b/docs/integrations/images/Linear/setup/linear-login.png new file mode 100644 index 00000000..47aafdf2 Binary files /dev/null and b/docs/integrations/images/Linear/setup/linear-login.png differ diff --git a/docs/integrations/images/admin-access-token.png b/docs/integrations/images/SelfHosted/admin-access-token.png similarity index 100% rename from docs/integrations/images/admin-access-token.png rename to docs/integrations/images/SelfHosted/admin-access-token.png diff --git a/docs/integrations/images/enter-url.png b/docs/integrations/images/SelfHosted/enter-url.png similarity index 100% rename from docs/integrations/images/enter-url.png rename to docs/integrations/images/SelfHosted/enter-url.png diff --git a/docs/integrations/images/login-page.png b/docs/integrations/images/SelfHosted/login-page.png similarity index 100% rename from docs/integrations/images/login-page.png rename to docs/integrations/images/SelfHosted/login-page.png diff --git a/docs/integrations/images/self-hosted-page.png b/docs/integrations/images/SelfHosted/self-hosted-page.png similarity index 100% rename from docs/integrations/images/self-hosted-page.png rename to docs/integrations/images/SelfHosted/self-hosted-page.png diff --git a/docs/integrations/images/cr-integrations-dark.png b/docs/integrations/images/cr-integrations-dark.png new file mode 100644 index 00000000..21d09d87 Binary files /dev/null and b/docs/integrations/images/cr-integrations-dark.png differ diff --git a/docs/integrations/images/cr-integrations-light.png b/docs/integrations/images/cr-integrations-light.png new file mode 100644 index 00000000..9df762e9 Binary files /dev/null and b/docs/integrations/images/cr-integrations-light.png differ diff --git a/docs/integrations/self-hosted-gitlab.md b/docs/integrations/self-hosted-gitlab.md index b4653b53..e363ad15 100644 --- 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) +![login-page](./images/SelfHosted/login-page.png) -### Step 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) +![Untitled](./images/SelfHosted/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. @@ -50,19 +50,23 @@ the token, please follow the process outlined below: 9. Select Create personal access token. 10. Please note down this token as this will be visible one time only -![Untitled](./images/admin-access-token.png) +![Untitled](./images/SelfHosted/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/SelfHosted/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 index 3d051844..5f459411 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -40,7 +40,19 @@ const sidebars: SidebarsConfig = { { type: "category", label: "Integrations", - items: ["integrations/self-hosted-gitlab"], + items: [ + { + 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", + ], }, "faq/faq", ],