From fc6662452b3666075d59ade1353fd0b5fa78e3ed Mon Sep 17 00:00:00 2001 From: alex Date: Mon, 13 Jan 2025 15:22:17 -0800 Subject: [PATCH] split the knowledge and issue pages --- docs/integrations/issue-integrations.md | 46 +++++++++++++++++++++++++ docs/integrations/knowledge-base.md | 42 ++-------------------- 2 files changed, 48 insertions(+), 40 deletions(-) create mode 100644 docs/integrations/issue-integrations.md diff --git a/docs/integrations/issue-integrations.md b/docs/integrations/issue-integrations.md new file mode 100644 index 00000000..fc139b0b --- /dev/null +++ b/docs/integrations/issue-integrations.md @@ -0,0 +1,46 @@ +--- +title: Issue Integrations +description: Learn about CodeRabbit's integrations with issue tracking systems like Jira and Linear. +sidebar_label: Issue Integrations +sidebar_position: 5 +--- + +CodeRabbit integrates with popular issue tracking systems to provide context from linked and related issues while reviewing code. + +## Jira {#jira} + +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + +### CodeRabbit App + +1. Navigate to [integrations][integrations] in the CodeRabbit app. +2. Toggle the Jira switch to enable the integration. + +Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira login page. Enter your Jira credentials to authenticate the integration. + +### CodeRabbit Configuration + +1. Add Jira's Project Keys to the `knowledge_base.jira.project_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`. + +## Linear {#Linear} + +```mdx-code-block + +``` + +### CodeRabbit App + +1. Navigate to [integrations][integrations] in the CodeRabbit app. +2. Toggle the Linear switch to enable the integration. + +Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear login page. Enter your Linear credentials to authenticate the integration. + +### CodeRabbit Configuration + +1. Add Linear's Team Keys to the `knowledge_base.linear.team_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`. + +[integrations]: https://app.coderabbit.ai/integrations diff --git a/docs/integrations/knowledge-base.md b/docs/integrations/knowledge-base.md index d4c52540..23b79400 100644 --- a/docs/integrations/knowledge-base.md +++ b/docs/integrations/knowledge-base.md @@ -7,47 +7,9 @@ sidebar_position: 4 CodeRabbit utilizes an internal knowledge base that integrates with several external services to provide a seamless review and issue management experience. -## Issues +## Issue Tracking Integration -The issues knowledge base allows CodeRabbit to use the context from linked and related issues while reviewing the code. - -### Jira {#jira} - -```mdx-code-block -import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; - - -``` - -#### CodeRabbit App - -1. Navigate to [integrations][integrations] in the CodeRabbit app. -2. Toggle the Jira switch to enable the integration. - -Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira login page. Enter your Jira credentials to authenticate the integration. - -#### CodeRabbit Configuration - -1. Add Jira's Project Keys to the `knowledge_base.jira.project_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`. - -### Linear {#Linear} - -```mdx-code-block - -``` - -#### CodeRabbit App - -1. Navigate to [integrations][integrations] in the CodeRabbit app. -2. Toggle the Linear switch to enable the integration. - -Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear login page. Enter your Linear credentials to authenticate the integration. - -#### CodeRabbit Configuration - -1. Add Linear's Team Keys to the `knowledge_base.linear.team_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`. - -[integrations]: https://app.coderabbit.ai/integrations +CodeRabbit can integrate with your issue tracking systems to provide better context during code reviews. For details on setting up issue tracking integrations, see our [Issue Integrations](./issue-integrations.md) guide. ## Learnings {#learnings}