Skip to content

New Document on Self Hosted Gitlab Integration #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jan 14, 2024
Merged

New Document on Self Hosted Gitlab Integration #4

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f5c8251
feat: added document under integration on integration with self hoste…
coderabbit-amank Jan 12, 2024
cf652b3
Update docs/integrations/self-hosted-gitlab.md
guritfaq Jan 14, 2024
0cfae40
Update docs/integrations/self-hosted-gitlab.md
guritfaq Jan 14, 2024
d9444be
Update docs/integrations/self-hosted-gitlab.md
guritfaq Jan 14, 2024
80d4f1f
Update docs/integrations/self-hosted-gitlab.md
guritfaq Jan 14, 2024
6e9fe64
Update docs/integrations/self-hosted-gitlab.md
guritfaq Jan 14, 2024
feb40b2
Update docs/integrations/self-hosted-gitlab.md
guritfaq Jan 14, 2024
f8f5ee3
Update docs/integrations/self-hosted-gitlab.md
guritfaq Jan 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/integrations/images/admin-access-token.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/integrations/images/enter-url.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/integrations/images/login-page.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/integrations/images/self-hosted-page.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 changes: 70 additions & 0 deletions docs/integrations/self-hosted-gitlab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: CodeRabbit in Self Managed Gitlab
description: Integrate CodeRabbit with your Self Managed Gitlab instance.
sidebar_label: Self Managed Gitlab
image: "/preview_meta.jpg"
---

<head>
<meta charSet="utf-8" />
<meta name="title" content="CodeRabbit in Self Managed Gitlab" />
<meta name="description" content="Integrate CodeRabbit in your own hosted Gitlab instance." />

<meta property="og:type" content="website" />
<meta property="og:url" content="https://coderabbit.ai/" />
<meta property="og:title" content="CodeRabbit in Self Managed Gitlab" />
<meta property="og:description" content="CodeRabbit: AI-powered Code Reviews" />
<meta property="og:image" content="/preview_meta.jpg" />

<meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="CodeRabbit in Self Managed Gitlab" />
<meta name="twitter:description" content="CodeRabbit: AI-powered Code Reviews" />
</head>

This page guides you through the process of integrating your Self-Managed GitLab with CodeRabbit.

To initiate the integration, we require specific information. This is essential for the initial setup of our CodeRabbit user and the creation of the CodeRabbit application within your domain. Once this setup is complete, you can log in directly using the OAuth2 flow.

### **Step 1: Getting Started**

**Visit CodeRabbit:** Land on to our login page https://coderabbit.ai/login and select Self-Hosted Gitlab

![login-page](./images/login-page.png)

### Step 2: Enter your Self Managed Gitlab URL
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the video you sent, there was additional ** here, just confirm those aren't visible on the page


On this page, you need to enter the URL of your self managed GitLab instance and click submit. Once, you submit, we will check for your organization record in our database.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure consistency in the capitalization of "self managed GitLab instance."

- On this page, you need to enter the URL of your self managed GitLab instance and click submit. Once, you submit, we will check for your organization record in our database.
+ On this page, you need to enter the URL of your Self-Managed GitLab instance and click submit. Once you submit, we will check for your organization's record in our database.
Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
On this page, you need to enter the URL of your self managed GitLab instance and click submit. Once, you submit, we will check for your organization record in our database.
On this page, you need to enter the URL of your Self-Managed GitLab instance and click submit. Once you submit, we will check for your organization's record in our database.


![Untitled](./images/enter-url.png)

### **Step 3: Enter Admin Personal Access Token (First time only)**

If this is the first time you are signing up with your instance, then we need the admin access token for setup.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase "then we need the admin access token for setup" could be more formal and clear.

- If this is the first time you are signing up with your instance, then we need the admin access token for setup.
+ If this is your first time signing up with your instance, we require an admin access token to complete the setup.
Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
If this is the first time you are signing up with your instance, then we need the admin access token for setup.
If this is your first time signing up with your instance, we require an admin access token to complete the setup.


#### **Generating Admin Personal Access token**

Gitlab provide an option to generate the personal access token to add a new user and setup application in the self managed instance. To generate the token, please follow the below process

1. Login to the instance. Make sure you have admin rights.
2. On the left sidebar, select your avatar.
3. Select Edit profile.
4. On the left sidebar, select Access Tokens.
5. Select Add new token.
6. Enter a name and expiry date for the token. We need this for One time, so you can set the minimum expiry time
7. If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
8. Make sure, you select scope `api`
9. Select Create personal access token.
10. Please copy this token, this will be visible at one time only

![Untitled](./images/admin-access-token.png)

### **Step 3: Paste the token and click submit**

- Once you submit the access token.
- Sit, Relax. We will setup everything
Copy link
Collaborator

@karan925 karan925 Jan 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Once you submit the access token.
- Sit, Relax. We will setup everything
- Provide the newly created access token in the Admin Access token input field on the Self-hosted GitLab Integration page.
- Once you submit the access token, sit back, relax, and let us handle the setup process for you.

- And next time, when you visit. This will auto detect and you will be able to directly login.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- And next time, when you visit. This will auto detect and you will be able to directly login.
- Next time you visit, it will automatically detect your setup, allowing you to log in directly.


![Untitled](./images/self-hosted-page.png)

- Further, Please refer to our Get Started Guide on how to use best of the CodeRabbit [here](../get-started/add-repo.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link to the Get Started Guide should be presented in a more user-friendly manner.

- - Further, Please refer to our Get Started Guide on how to use best of the CodeRabbit [here](../get-started/add-repo.md)
+ - For more information on how to make the most of CodeRabbit, please refer to our [Get Started Guide](../get-started/add-repo.md).
Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- Further, Please refer to our Get Started Guide on how to use best of the CodeRabbit [here](../get-started/add-repo.md)
- For more information on how to make the most of CodeRabbit, please refer to our [Get Started Guide](../get-started/add-repo.md).

65 changes: 33 additions & 32 deletions sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,38 +11,39 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
Create as many sidebars as you want.
*/
const sidebars: SidebarsConfig = {
docsSidebar: [
"introduction/introduction",
{
type: "category",
label: "About",
collapsed: false,
items: ["about/features", "about/pricing", "about/support"],
},
{
type: "category",
label: "Get Started",
items: [
"get-started/signup",
"get-started/add-repo",
// "get-started/customize-coderabbit",
// "get-started/prompt-customization",
"get-started/analytics",
// "get-started/coderabbit-commands",
,
],
},
{
type: "category",
label: "Guides",
items: [
"guides/customize-coderabbit",
"guides/prompt-customization",
"guides/coderabbit-commands",
],
},
"faq/faq",
],
docsSidebar: [
"introduction/introduction",
{
type: "category",
label: "About",
collapsed: false,
items: ["about/features", "about/pricing", "about/support"],
},
{
type: "category",
label: "Get Started",
items: [
"get-started/signup",
"get-started/add-repo",
// "get-started/customize-coderabbit",
// "get-started/prompt-customization",
"get-started/analytics",
// "get-started/coderabbit-commands",
,
],
},
{
type: "category",
label: "Guides",
items: ["guides/customize-coderabbit", "guides/prompt-customization", "guides/coderabbit-commands"],
},
{
type: "category",
label: "Integrations",
items: ["integrations/self-hosted-gitlab"],
},
"faq/faq",
],
};

export default sidebars;