Update example formatting in configuration files for consistency (#393)

hasit · web-flow · commit 10ab70cdbf6e · 2025-06-10T11:32:05.000-07:00
diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md
@@ -117,7 +117,7 @@ CODERABBIT_API_KEY=<coderabbitai-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.
+# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
 OBJECT_STORE_URI=[<object-store-uri>]
 
 JIRA_HOST=[<jira-host-url>]
diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md
@@ -112,7 +112,7 @@ CODERABBIT_API_KEY=<coderabbitai-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.
+# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
 OBJECT_STORE_URI=[<object-store-uri>]
 
 JIRA_HOST=[<jira-host-url>]
diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md
@@ -130,7 +130,7 @@ CODERABBIT_API_KEY=<coderabbitai-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.
+# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
 OBJECT_STORE_URI=[<object-store-uri>]
 
 JIRA_HOST=[<jira-host-url>]
diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md
@@ -114,14 +114,17 @@ SELF_HOSTED=gitlab
 
 GITLAB_BOT_TOKEN=<personal-access-token>
 GITLAB_WEBHOOK_SECRET=<webhook-secret-key>
+# if seeing '500 Internal Server Error' in CodeRabbit logs when trying to post review comments,
+# make sure to set the following environment variable to 1500 (1.5 seconds).
+GITLAB_PUBLISH_DELAY=[<delay-ms-between-draft-and-publish>]
 
 CODERABBIT_LICENSE_KEY=<license-key>
 
 CODERABBIT_API_KEY=<coderabbitai-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.
+# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
 OBJECT_STORE_URI=[<object-store-uri>]
 
 JIRA_HOST=[<jira-host-url>]
