Skip to content

Commit eae7edb

Browse files
ankitjenaAnkit Jena
andauthored
docs fix for self-hosted extension (#466)
* docs fix for self-hosted extension * change title --------- Co-authored-by: Ankit Jena <ankit@coderabbit.ai>
1 parent 8a0881f commit eae7edb

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

docs/guides/use-vscode-selfhosted.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
---
2-
title: Use the VSCode extension with self-hosted CodeRabbit
2+
title: Use with self-hosted CodeRabbit
33
description: How to setup the VSCode extension with self-hosted CodeRabbit
44
---
55

66
This page is about setting up the VSCode extension with self-hosted CodeRabbit. If you are instead using the managed offering, see [Install the VSCode extension](/guides/install-vscode).
77

88
## Prerequisites
99

10-
Your extension version should be greater than `0.12.1`
10+
1. Your extension version should be greater than `0.12.1`.
11+
2. Logout of the extension if previously logged in.
1112

1213
## Connect your self-hosted instance{#connect-self-hosted-instance}
1314

1415
To connect the VSCode extension to your self-hosted instance, follow these steps:
1516

16-
1. Logout from the VSCode extension, if logged in to our managed offering.
17-
2. Click on the "Self hosting CodeRabbit?" button, below the "Use CodeRabbit for free" button.
18-
3. Enter your self-hosted instance URL.
19-
3.1. Make sure the instance URL is reachable within your network and websocket connections are allowed.
20-
4. Select your git provider which you are using with your self-hosted CodeRabbit. (GitLab, Self-Hostd Gitlab, GitHub, GitHub Enterprise)
21-
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.
22-
6. You should be connected to your self-hosted instance and ready to use the VSCode extension.
17+
1. Click on the "Self hosting CodeRabbit?" button, below the "Use CodeRabbit for free" button.
18+
2. Enter your self-hosted instance URL when prompted.
19+
- Make sure the instance URL is reachable within your network and websocket connections are allowed.
20+
3. Select your git provider which you are using with your self-hosted CodeRabbit. (GitLab, Self-Hosted Gitlab, GitHub, GitHub Enterprise)
21+
- 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.
2322

23+
You should be connected to your self-hosted instance and ready to use the VSCode extension.
2424

2525
## What's next {#whats-next}
2626

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ const sidebars: SidebarsConfig = {
131131
"guides/about-vscode",
132132
"guides/install-vscode",
133133
"guides/use-vscode",
134+
"guides/use-vscode-selfhosted",
134135
"guides/config-vscode",
135136
"guides/uninstall-vscode",
136137
],

0 commit comments

Comments
 (0)