From 19232c80c5ebc2e2e03a10f41dd62a2df60f7483 Mon Sep 17 00:00:00 2001 From: Ganesh Patro Date: Wed, 23 Jul 2025 00:39:09 +0530 Subject: [PATCH] Add knowledge base feature flag defns in self hosted docs --- docs/self-hosted/azure-devops.md | 17 +++++++++++++---- docs/self-hosted/bitbucket.md | 18 ++++++++++++++---- docs/self-hosted/github.md | 18 ++++++++++++++---- docs/self-hosted/gitlab.md | 19 +++++++++++++++---- 4 files changed, 56 insertions(+), 16 deletions(-) diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md index 7fc28ad8..c7b7f21b 100644 --- a/docs/self-hosted/azure-devops.md +++ b/docs/self-hosted/azure-devops.md @@ -118,10 +118,19 @@ CODERABBIT_LICENSE_KEY= CODERABBIT_API_KEY= ENABLE_METRICS=[true] -ENABLE_LEARNINGS=[true] -# if using CodeRabbit's learnings, also provide the following -# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc. -OBJECT_STORE_URI=[] + +# CodeRabbit - KNOWLEDGE BASE +# +# Requisite: To enable CodeRabbit's knowledge base, you need to provide an 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. + +ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features. + +ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing. +ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing. +ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing. +ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing. +ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing. JIRA_HOST=[] JIRA_PAT=[] diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md index d1ef7492..92c539f8 100644 --- a/docs/self-hosted/bitbucket.md +++ b/docs/self-hosted/bitbucket.md @@ -113,10 +113,20 @@ CODERABBIT_LICENSE_KEY= CODERABBIT_API_KEY= ENABLE_METRICS=[true] -ENABLE_LEARNINGS=[true] -# if using CodeRabbit's learnings, also provide the following -# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc. -OBJECT_STORE_URI=[] + + +# CodeRabbit - KNOWLEDGE BASE +# +# Requisite: To enable CodeRabbit's knowledge base, you need to provide an 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. + +ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features. + +ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing. +ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing. +ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing. +ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing. +ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing. JIRA_HOST=[] JIRA_PAT=[] diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md index c91d3cbf..accdb8a2 100644 --- a/docs/self-hosted/github.md +++ b/docs/self-hosted/github.md @@ -131,10 +131,20 @@ CODERABBIT_LICENSE_KEY= CODERABBIT_API_KEY= ENABLE_METRICS=[true] -ENABLE_LEARNINGS=[true] -# if using CodeRabbit's learnings, also provide the following -# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc. -OBJECT_STORE_URI=[] + + +# CodeRabbit - KNOWLEDGE BASE +# +# Requisite: To enable CodeRabbit's knowledge base, you need to provide an 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. + +ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features. + +ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing. +ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing. +ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing. +ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing. +ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing. JIRA_HOST=[] JIRA_PAT=[] diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md index c0535646..26ad309d 100644 --- a/docs/self-hosted/gitlab.md +++ b/docs/self-hosted/gitlab.md @@ -158,10 +158,21 @@ CODERABBIT_LICENSE_KEY= CODERABBIT_API_KEY= ENABLE_METRICS=[true] -ENABLE_LEARNINGS=[true] -# if using CodeRabbit's learnings, also provide the following -# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc. -OBJECT_STORE_URI=[] + + +# CodeRabbit - KNOWLEDGE BASE +# +# Requisite: To enable CodeRabbit's knowledge base, you need to provide an 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. + +ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features. + +ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing. +ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing. +ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing. +ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing. +ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing. + JIRA_HOST=[] JIRA_PAT=[]