You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/organization-settings.md
+5-15Lines changed: 5 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -4,21 +4,17 @@ description: Learn the basics of configuring CodeRabbit for your organization.
4
4
---
5
5
6
6
This page is about managing the default settings of CodeRabbit across your
7
-
whole Git platform organization. If you instead want to configure CodeRabbit
8
-
separately for your organization's different repositories, then see [Set your repository preferences](/guides/repository-settings)
7
+
whole Git platform organization.
9
8
10
9
For a general overview of configuring CodeRabbit, see [Configure CodeRabbit](/guides/configuration-overview).
11
10
12
11
## About organization settings {#about}
13
12
14
-
You can use the CodeRabbit web interface to set a CodeRabbit configuration
15
-
for all Git repositories associated with your organization.
13
+
You can use the CodeRabbit web interface to set the CodeRabbit configuration
14
+
for all of the Git repositories associated with your organization. By default, all of your repositories apply your organization's CodeRabbit configuration.
16
15
17
-
You
18
-
19
-
:::note
20
-
Some settings, such as [Data retention](/reference/configuration#data-retention), apply only at the organizational level, with no per-repository equivalent.
21
-
:::
16
+
You have the option to define separate settings for some or
17
+
all of your individual repositories, instead. For more information, see [Set your repository preferences](/guides/repository-settings).
22
18
23
19
## Browse and modify your organization settings {#modify}
24
20
@@ -28,12 +24,6 @@ To view or modify your organizational settings, follow these steps:
28
24
1. In the sidebar, click **Organization Settings** > **Configuration**.
29
25
1. Browse and modify the settings as needed. If you do make changes, click **Apply Changes** when you are finished.
30
26
31
-
## Apply organization settings to your repositories {#repositories}
32
-
33
-
To apply your organizational settings to a repository, follow these steps:
Copy file name to clipboardExpand all lines: docs/guides/repository-settings.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -13,12 +13,17 @@ CodeRabbit provides two ways to manage its code-review behavior with each of you
13
13
- Add a `.coderabbit.yaml` file to your repository.
14
14
- View or modify your per-repository settings using the CodeRabbit web interface.
15
15
16
-
Any settings that you define in the `.coderabbit.yaml` file take precedence over
17
-
settings defined by the web interface. If your repository doesn't have a
18
-
`.coderabbit.yaml` file, then CodeRabbit applies only the settings from the web
19
-
interface.
16
+
If your repository contains a `.coderabbit.yaml` file at the top level of its default branch,
17
+
then CodeRabbit applies all of its settings to that repository's code reviews. CodeRabbit applies its own default values to any configuration settings not defined by your `.coderabbit.yaml` file.
20
18
21
-
While the web interface provides and easier way to explore the available configuration options for your repository, we recommend using a `.coderabbit.yaml` file as a best practice. For more information, see [Fine-tune reviews using YAML files](/guides/setup-best-practices#yaml).
19
+
If your repository doesn't have a `.coderabbit.yaml` file, then CodeRabbit applies the configuration from the CodeRabbit web interface, instead.
20
+
21
+
While the web interface provides an easier way to explore the available configuration options for your repository, we recommend using a `.coderabbit.yaml` file as a best practice. For more information, see [Fine-tune reviews using YAML files](/guides/setup-best-practices#yaml).
22
+
23
+
## Configure your repository with `.coderabbit.yaml`
24
+
25
+
For more information about creating and updating a `.coderabbit.yaml` file in
26
+
your repository, see [Add a configuration file](/getting-started/configure-coderabbit).
22
27
23
28
## Browse and modify your settings using the web interface {#modify}
24
29
@@ -30,11 +35,6 @@ To view or modify your repository settings using the CodeRabbit web interface, f
30
35
1. If the **Use Organization Settings** toggle is on, then click it to turn it off. If you leave it on, then CodeRabbit applies the settings you have set through [the organization-configuration page](/guides/organization-settings) to this repository.
31
36
1. Browse and modify the settings as needed. If you do make changes, click **Apply Changes** when you are finished.
32
37
33
-
## Configure your repository with `.coderabbit.yaml`
34
-
35
-
For more information about creating and updating a `.coderabbit.yaml` file in
36
-
your repository, see [Add a configuration file](/getting-started/configure-coderabbit).
37
-
38
38
## What's next {#whats-next}
39
39
40
40
-[Configuration best practices](/guides/setup-best-practices#configuration)
0 commit comments