From d88fea8d4d4e97f717bbfe589e25b06866cb8e71 Mon Sep 17 00:00:00 2001 From: Ankit Jena Date: Tue, 22 Jul 2025 12:03:04 +0530 Subject: [PATCH 1/2] docs fix for self-hosted extension --- docs/guides/use-vscode-selfhosted.md | 18 +++++++++--------- sidebars.ts | 1 + 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/guides/use-vscode-selfhosted.md b/docs/guides/use-vscode-selfhosted.md index acba2a4c..bae21f62 100644 --- a/docs/guides/use-vscode-selfhosted.md +++ b/docs/guides/use-vscode-selfhosted.md @@ -1,5 +1,5 @@ --- -title: Use the VSCode extension with self-hosted CodeRabbit +title: With self-hosted CodeRabbit description: How to setup the VSCode extension with self-hosted CodeRabbit --- @@ -7,20 +7,20 @@ This page is about setting up the VSCode extension with self-hosted CodeRabbit. ## Prerequisites -Your extension version should be greater than `0.12.1` +1. Your extension version should be greater than `0.12.1`. +2. Logout of the extension if previously logged in. ## Connect your self-hosted instance{#connect-self-hosted-instance} To connect the VSCode extension to your self-hosted instance, follow these steps: -1. Logout from the VSCode extension, if logged in to our managed offering. -2. Click on the "Self hosting CodeRabbit?" button, below the "Use CodeRabbit for free" button. -3. Enter your self-hosted instance URL. - 3.1. Make sure the instance URL is reachable within your network and websocket connections are allowed. -4. Select your git provider which you are using with your self-hosted CodeRabbit. (GitLab, Self-Hostd Gitlab, GitHub, GitHub Enterprise) -5. If using GitHub, enter your [Github Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) when asked. -6. You should be connected to your self-hosted instance and ready to use the VSCode extension. +1. Click on the "Self hosting CodeRabbit?" button, below the "Use CodeRabbit for free" button. +2. Enter your self-hosted instance URL when prompted. + - Make sure the instance URL is reachable within your network and websocket connections are allowed. +3. Select your git provider which you are using with your self-hosted CodeRabbit. (GitLab, Self-Hosted Gitlab, GitHub, GitHub Enterprise) + - If using GitHub or GitHub Enterprise, enter your [Github Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) when prompted. +You should be connected to your self-hosted instance and ready to use the VSCode extension. ## What's next {#whats-next} diff --git a/sidebars.ts b/sidebars.ts index 0e93a242..25fded60 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -131,6 +131,7 @@ const sidebars: SidebarsConfig = { "guides/about-vscode", "guides/install-vscode", "guides/use-vscode", + "guides/use-vscode-selfhosted", "guides/config-vscode", "guides/uninstall-vscode", ], From 04c45ff9072bb7e18aebb76c1293ea1e97648d94 Mon Sep 17 00:00:00 2001 From: Ankit Jena Date: Tue, 22 Jul 2025 12:05:33 +0530 Subject: [PATCH 2/2] change title --- docs/guides/use-vscode-selfhosted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/use-vscode-selfhosted.md b/docs/guides/use-vscode-selfhosted.md index bae21f62..4452ad8d 100644 --- a/docs/guides/use-vscode-selfhosted.md +++ b/docs/guides/use-vscode-selfhosted.md @@ -1,5 +1,5 @@ --- -title: With self-hosted CodeRabbit +title: Use with self-hosted CodeRabbit description: How to setup the VSCode extension with self-hosted CodeRabbit ---