Skip to content

Commit 881d971

Browse files
aravindputrevuaravindputrevu
authored
Merge branch 'main' into add-faq
2 parents 82c3088 + 8b590da commit 881d971

17 files changed

+79
-20
lines changed

‎docs/changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 9
66
---
77

8+
## November 8, 2024
9+
10+
### ESLint Support
11+
12+
We've introducded support for ES Lint, including .vue, .svelte, and .astro, alongside traditional .js, .ts, and .jsx extensions. We've worked on monorepo compatibility with improved Yarn and PNPM workspace support, ensuring seamless integration across your projects. While maintaining your existing ESLint configurations, we simply require all dependencies to be properly defined in your package.json. Note that private plugins aren't currently supported, but we're committed to making code quality maintenance as efficient as possible across all your web development needs
13+
814
## October 31, 2024
915

1016
### Learnings and Metrics Iteration for CodeRabbit Self-Hosted Customers

‎docs/configure-coderabbit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description:
55
CodeRabbit offers various configuration options to tailor the reviews to your
66
specific requirements. Configuration can be made using one of the below
77
options.
8-
sidebar_position: 4
8+
sidebar_position: 3
99
---
1010

1111
```mdx-code-block

‎docs/guides/_category_.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Guides
2-
position: 7
2+
position: 6
33
collapsible: true
44
collapsed: true

‎docs/integrations/_category_.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Integrations
2-
position: 8
2+
position: 7
33
collapsible: true
44
collapsed: true

‎docs/platforms/_category_.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Supported Git Platforms
2-
position: 6
2+
position: 5
33
collapsible: true
44
collapsed: true

‎docs/platforms/azure-devops.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ DevOps.
2828

2929
:::
3030

31-
![azure devops apps consent](/img/integrations/azure_apps_consent_page.png)
31+
![CodeRabbit admin consent page for Azure DevOps integration](/img/integrations/azure_apps_consent_page.png)
3232

3333
3. Once your administrator has approved the applications, click "Continue."
3434
4. You will be redirected to the "Onboarding" page, where you can select the
3535
organization you wish to integrate with.
3636
5. On the "Azure DevOps User" page, enter your Personal Access Token for Azure
3737
DevOps.
38-
![azure devops user page](/img/integrations/azure_devops_user_page.png)
38+
![CodeRabbit azure devOps integration settings page](/img/integrations/azure_devops_user_page.png)
3939
6. To install CodeRabbit on a repository, toggle the switch on the
4040
"Repositories" page.
4141

@@ -58,7 +58,7 @@ your existing users.
5858
Upon first login to the application (immediately after the onboarding screen),
5959
you will need to add the Personal Access Token.
6060

61-
![azure devops user modal](/img/integrations/azure_personal_access_token_add.png)
61+
![CodeRabbit azure devOps integration modal](/img/integrations/azure_personal_access_token_add.png)
6262

6363
### Recommendations
6464

@@ -98,4 +98,4 @@ Follow these steps to generate the token:
9898
on pull requests.
9999
8. Click "Create"
100100

101-
![Generate Personal Access Token](/img/integrations/azure-access-token.png)
101+
![CodeRabbit azure devOps personal access token creation form](/img/integrations/azure-access-token.png)

‎docs/platforms/github-enterprise-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ complete, you can log in directly.
2525
**Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and
2626
select Self-Hosted GitHub
2727

28-
![login-page](/img/integrations/login-self-hosted-github.png)
28+
![CodeRabbit login page](/img/integrations/login-self-hosted-github.png)
2929

3030
On this page, enter the URL of your self-managed GitHub instance and click
3131
submit. Once, you submit, we check our database for a record of your
3232
organization and if we find an existing one, we will start the login process.
3333

34-
![Untitled](/img/integrations/self-hosted-github-host-url.png)
34+
![Self-hosted gitHub enterprise connection page for CodeRabbit](/img/integrations/self-hosted-github-host-url.png)
3535

3636
If the self-managed GitHub instance is not found, you will be required to enter
3737
more details for the onboarding.

‎docs/platforms/gitlab-com.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ GitLab provides an option to generate a personal access token for a new user. Fo
6767
9. Click "Create Personal Access Token."
6868
10. Note down the token as it will only be displayed once.
6969

70-
![Untitled](/img/integrations/admin-access-token.png)
70+
![GitLab personal access token configuration page](/img/integrations/admin-access-token.png)

‎docs/platforms/self-hosted-gitlab.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ upgrading your GitLab instance to obtain the intended experience.
2222
**Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and
2323
select Self-Hosted GitLab
2424

25-
![login-page](/img/integrations/login-self-hosted-gitlab.png)
25+
![CodeRabbit login](/img/integrations/login-self-hosted-gitlab.png)
2626

2727
### Step 2: Enter your Self-Managed GitLab URL
2828

2929
On this page, enter the URL of your self-managed GitLab instance and click
3030
submit. Once, you submit, we check our database for a record of your
3131
organization and if we find an existing one, we are starting the login process.
3232

33-
![Untitled](/img/integrations/self-hosted-gitlab-host-url.png)
33+
![Self-hosted Gitlab enterprise connection page](/img/integrations/self-hosted-gitlab-host-url.png)
3434

3535
If the self-managed GitLab instance is not found, we initiate the onboarding
3636
process, which can be either manual or automated.
@@ -39,7 +39,7 @@ process, which can be either manual or automated.
3939

4040
#### 1. Automated onboarding
4141

42-
![Untitled](/img/integrations/automated-onboarding.png)
42+
![Self-managed GitLab connection page](/img/integrations/automated-onboarding.png)
4343

4444
#### **Why do we need the Admin Access Token?**
4545

@@ -55,7 +55,7 @@ add CodeRabbit manually on the projects you wish, as the next step.
5555
For the manual onboarding process we need to create the
5656
[CodeRabbit user](#creating-coderabbit-user) and the
5757
[OAuth2 GitLab application](#creating-oauth2-application).
58-
![Untitled](/img/integrations/manual-onboarding.png)
58+
![Self-managed GitLab connection page](/img/integrations/manual-onboarding.png)
5959

6060
#### **Creating CodeRabbit user**
6161

@@ -105,14 +105,14 @@ the token, please follow the process outlined below:
105105
9. Select Create personal access token.
106106
10. Please note down this token as this will be visible one time only
107107

108-
![Untitled](/img/integrations/admin-access-token.png)
108+
![GitLab personal access token configuration page](/img/integrations/admin-access-token.png)
109109

110110
### **Step 4: Paste the details and click submit**
111111

112112
- Submit the form.
113113
- We will handle the setup process for you.
114114
- On subsequent visits, your setup will be automatically detected, allowing for
115-
direct login. ![Untitled](/img/integrations/self-hosted-page.png)
115+
direct login. ![CodeRabbit authentication options page](/img/integrations/self-hosted-page.png)
116116

117117
### **Step 5: Whitelist CodeRabbit IP address**
118118

‎docs/self-hosted/_category_.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Self-Hosted CodeRabbit
2-
position: 3
2+
position: 8
33
collapsible: true
44
collapsed: true

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ description: Instructions to self-host CodeRabbit and integrate it with Azure De
55
sidebar_position: 3
66
---
77

8+
:::note
9+
10+
The self-hosted option is only available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](mailto:sales@coderabbit.ai) to learn more about the CodeRabbit Enterprise plan.
11+
12+
:::
13+
814
## Create a Azure DevOps User
915

1016
- **Username**: Set the username to "CodeRabbit" for easier identification (optional).

‎docs/self-hosted/github.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ description: Instructions to self-host CodeRabbit and integrate it with GitHub.
55
sidebar_position: 1
66
---
77

8+
:::note
9+
10+
The self-hosted option is only available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](mailto:sales@coderabbit.ai) to learn more about the CodeRabbit Enterprise plan.
11+
12+
:::
13+
814
## Create a GitHub App
915

1016
Set the following Repository permissions:

‎docs/self-hosted/gitlab.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ description: Instructions to self-host CodeRabbit and integrate it with GitLab.
55
sidebar_position: 2
66
---
77

8+
:::note
9+
10+
The self-hosted option is only available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](mailto:sales@coderabbit.ai) to learn more about the CodeRabbit Enterprise plan.
11+
12+
:::
13+
814
## Create a GitLab User
915

1016
- **Username**: Set the username to "CodeRabbit" for easier identification (optional).

‎docs/tools/_category_.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Supported Tools
2-
position: 5
2+
position: 4
33
collapsible: true
44
collapsed: true

‎docs/tools/eslint.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: ESLint
3+
sidebar_label: ESLint
4+
description: CodeRabbit's guide to ESLint.
5+
---
6+
7+
[ESLint](https://eslint.org/) is a linter for JavaScript, TypeScript, JSX, TSX, CSS, etc.
8+
9+
## Files
10+
11+
ESLint will run on files with the following extensions:
12+
13+
- `.js`
14+
- `.ts`
15+
- `.cjs`
16+
- `.mjs`
17+
- `.d.cts`
18+
- `.d.mts`
19+
- `.jsx`
20+
- `.tsx`
21+
- `.css`
22+
- `.vue`
23+
- `.svelte`
24+
- `.astro`
25+
26+
## Configuration
27+
28+
- ESLint configuration is read from the repository and is used as is. No additional configuration is required.
29+
- Please ensure that all ESLint dependencies are defined in your `package.json` file(s).
30+
- Yarn and PNPM workspaces are supported.
31+
- Private ESLint plugins or configurations are not supported at the moment. Please reach out to us on Discord if you would like us to add support for this.
32+
- For `@typescript-eslint`, linting with type information at the moment. The [type checking rules](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/disable-type-checked.ts) are disabled.
33+
- For `eslint-plugin-import`, the `import/no-unresolved` rule is disabled.

0 commit comments

Comments
 (0)