Skip to content

Commit a9bb694

Browse files
ganeshpatro321hasit
ganeshpatro321
and
hasit
authored
Add knowledge base feature flag defns in self hosted docs (#469)
Co-authored-by: Hasit Mistry <hasit@coderabbit.ai>
1 parent bb84d3f commit a9bb694

File tree

4 files changed

+56
-16
lines changed

4 files changed

+56
-16
lines changed

‎docs/self-hosted/azure-devops.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,19 @@ CODERABBIT_LICENSE_KEY=<license-key>
118118

119119
CODERABBIT_API_KEY=<coderabbitai-api-key>
120120
ENABLE_METRICS=[true]
121-
ENABLE_LEARNINGS=[true]
122-
# if using CodeRabbit's learnings, also provide the following
123-
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
124-
OBJECT_STORE_URI=[<object-store-uri>]
121+
122+
# CodeRabbit - KNOWLEDGE BASE
123+
#
124+
# Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI.
125+
OBJECT_STORE_URI=[<object-store-uri>] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
126+
127+
ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features.
128+
129+
ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing.
130+
ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing.
131+
ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing.
132+
ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing.
133+
ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing.
125134

126135
JIRA_HOST=[<jira-host-url>]
127136
JIRA_PAT=[<jira-personal-access-token>]

‎docs/self-hosted/bitbucket.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,20 @@ CODERABBIT_LICENSE_KEY=<license-key>
113113

114114
CODERABBIT_API_KEY=<coderabbitai-api-key>
115115
ENABLE_METRICS=[true]
116-
ENABLE_LEARNINGS=[true]
117-
# if using CodeRabbit's learnings, also provide the following
118-
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
119-
OBJECT_STORE_URI=[<object-store-uri>]
116+
117+
118+
# CodeRabbit - KNOWLEDGE BASE
119+
#
120+
# Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI.
121+
OBJECT_STORE_URI=[<object-store-uri>] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
122+
123+
ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features.
124+
125+
ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing.
126+
ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing.
127+
ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing.
128+
ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing.
129+
ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing.
120130

121131
JIRA_HOST=[<jira-host-url>]
122132
JIRA_PAT=[<jira-personal-access-token>]

‎docs/self-hosted/github.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,20 @@ CODERABBIT_LICENSE_KEY=<license-key>
131131

132132
CODERABBIT_API_KEY=<coderabbitai-api-key>
133133
ENABLE_METRICS=[true]
134-
ENABLE_LEARNINGS=[true]
135-
# if using CodeRabbit's learnings, also provide the following
136-
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
137-
OBJECT_STORE_URI=[<object-store-uri>]
134+
135+
136+
# CodeRabbit - KNOWLEDGE BASE
137+
#
138+
# Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI.
139+
OBJECT_STORE_URI=[<object-store-uri>] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
140+
141+
ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features.
142+
143+
ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing.
144+
ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing.
145+
ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing.
146+
ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing.
147+
ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing.
138148

139149
JIRA_HOST=[<jira-host-url>]
140150
JIRA_PAT=[<jira-personal-access-token>]

‎docs/self-hosted/gitlab.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,10 +158,21 @@ CODERABBIT_LICENSE_KEY=<license-key>
158158

159159
CODERABBIT_API_KEY=<coderabbitai-api-key>
160160
ENABLE_METRICS=[true]
161-
ENABLE_LEARNINGS=[true]
162-
# if using CodeRabbit's learnings, also provide the following
163-
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
164-
OBJECT_STORE_URI=[<object-store-uri>]
161+
162+
163+
# CodeRabbit - KNOWLEDGE BASE
164+
#
165+
# Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI.
166+
OBJECT_STORE_URI=[<object-store-uri>] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
167+
168+
ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features.
169+
170+
ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing.
171+
ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing.
172+
ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing.
173+
ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing.
174+
ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing.
175+
165176

166177
JIRA_HOST=[<jira-host-url>]
167178
JIRA_PAT=[<jira-personal-access-token>]

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy