|
1 | 1 | ---
|
2 |
| -title: External Knowledge Base |
3 |
| -description: Integrate CodeRabbit with an external knowledge base for issue tracking. |
| 2 | +title: Knowledge Base |
| 3 | +description: Learn about CodeRabbit's internal knowledge base and its integrations with external services. |
4 | 4 | sidebar_label: Knowledge Base
|
5 | 5 | sidebar_position: 4
|
6 | 6 | ---
|
7 | 7 |
|
8 |
| -CodeRabbit integrates with external knowledge bases to provide a seamless experience for issue tracking. This will allow CodeRabbit to use the context from the linked issues while reviewing the code. |
| 8 | +CodeRabbit utilizes an internal knowledge base that integrates with several external services to provide a seamless review and issue management experience. |
9 | 9 |
|
10 |
| -## Jira {#jira} |
| 10 | +## Issues |
11 | 11 |
|
12 |
| -### CodeRabbit App |
| 12 | +The issues knowledge base allows CodeRabbit to use the context from linked and related issues while reviewing the code. |
| 13 | + |
| 14 | +### Jira {#jira} |
| 15 | + |
| 16 | +#### CodeRabbit App |
13 | 17 |
|
14 | 18 | 1. Navigate to [integrations][integrations] in the CodeRabbit app.
|
15 | 19 | 2. Toggle the Jira switch to enable the integration.
|
16 | 20 |
|
17 | 21 | Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira login page. Enter your Jira credentials to authenticate the integration.
|
18 | 22 |
|
19 |
| -### CodeRabbit Configuration |
| 23 | +#### CodeRabbit Configuration |
20 | 24 |
|
21 | 25 | 1. Add Jira's Project Keys to the `knowledge_base.jira.project_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`.
|
22 | 26 |
|
23 |
| -## Linear {#Linear} |
| 27 | +### Linear {#Linear} |
24 | 28 |
|
25 |
| -### CodeRabbit App |
| 29 | +#### CodeRabbit App |
26 | 30 |
|
27 | 31 | 1. Navigate to [integrations][integrations] in the CodeRabbit app.
|
28 | 32 | 2. Toggle the Linear switch to enable the integration.
|
29 | 33 |
|
30 | 34 | Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear login page. Enter your Linear credentials to authenticate the integration.
|
31 | 35 |
|
32 |
| -### CodeRabbit Configuration |
| 36 | +#### CodeRabbit Configuration |
33 | 37 |
|
34 | 38 | 1. Add Linear's Team Keys to the `knowledge_base.linear.team_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`.
|
35 | 39 |
|
36 | 40 | [integrations]: https://app.coderabbit.ai/integrations
|
| 41 | + |
| 42 | +## Learnings {#learnings} |
| 43 | + |
| 44 | +You can tell the bot to remember things about either specific lines in files, or generally about the entire repository, or even across repositories. |
| 45 | + |
| 46 | +For example you can add a comment in a PR to chat directly with CodeRabbit. `@coderabbitai always remember to enforce camelCase`. |
| 47 | + |
| 48 | +Or you can comment directly on some lines of code in the PR. `@coderabbitai do not complain about lack of error handling here, it is handled higher up the execution stack.` |
| 49 | + |
| 50 | +## On-premises |
| 51 | + |
| 52 | +For self-hosted / on-premises deployments, you can enable the knowledge base features by setting `ON_PREM_KNOWLEDGE_BASE=true` in the environment variables for your self-hosted docker image. |
| 53 | + |
| 54 | +By default, CodeRabbit will store its data in the `coderabbitai/data` branch unless you set `ON_PREM_KNOWLEDGE_BASE_BRANCH=<branch_name>` with a different value. |
0 commit comments