From 91f9e8e1d08f0194e15582eb66475c766624deed Mon Sep 17 00:00:00 2001 From: Ankur Tyagi <tyaga001@live.com> Date: Fri, 1 Nov 2024 16:49:26 +0100 Subject: [PATCH 1/5] docs: refactored integration guides images SEO and accessibility --- docs/platforms/azure-devops.md | 8 ++++---- docs/platforms/github-enterprise-server.md | 6 +++--- docs/platforms/gitlab-com.md | 6 +++--- docs/platforms/self-hosted-gitlab.md | 12 ++++++------ ...> gitlab-personal-access-token-scopes-setup.png} | Bin 5 files changed, 16 insertions(+), 16 deletions(-) rename static/img/integrations/{admin-access-token.png => gitlab-personal-access-token-scopes-setup.png} (100%) diff --git a/docs/platforms/azure-devops.md b/docs/platforms/azure-devops.md index b9564473..d9b8746f 100644 --- a/docs/platforms/azure-devops.md +++ b/docs/platforms/azure-devops.md @@ -28,14 +28,14 @@ DevOps. ::: -  + 3. Once your administrator has approved the applications, click "Continue." 4. You will be redirected to the "Onboarding" page, where you can select the organization you wish to integrate with. 5. On the "Azure DevOps User" page, enter your Personal Access Token for Azure DevOps. -  +  6. To install CodeRabbit on a repository, toggle the switch on the "Repositories" page. @@ -58,7 +58,7 @@ your existing users. Upon first login to the application (immediately after the onboarding screen), you will need to add the Personal Access Token. - + ### Recommendations @@ -98,4 +98,4 @@ Follow these steps to generate the token: on pull requests. 8. Click "Create" - + diff --git a/docs/platforms/github-enterprise-server.md b/docs/platforms/github-enterprise-server.md index 81c10f16..0be32e00 100644 --- a/docs/platforms/github-enterprise-server.md +++ b/docs/platforms/github-enterprise-server.md @@ -25,13 +25,13 @@ complete, you can log in directly. **Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and select Self-Hosted GitHub - + On this page, enter the URL of your self-managed GitHub instance and click submit. Once, you submit, we check our database for a record of your organization and if we find an existing one, we will start the login process. - + If the self-managed GitHub instance is not found, you will be required to enter more details for the onboarding. @@ -66,7 +66,7 @@ Keep the following details handy: - Client ID - Client secret - + ### **Step 3: GitHub App** diff --git a/docs/platforms/gitlab-com.md b/docs/platforms/gitlab-com.md index ea7589f8..fb51865b 100644 --- a/docs/platforms/gitlab-com.md +++ b/docs/platforms/gitlab-com.md @@ -27,7 +27,7 @@ To interact with the GitLab API, a **Personal Access Token** is required. This t Upon first login to the application (immediately after the onboarding screen), you will need to choose based on your organization's requirements. - + **We recommend using the default CodeRabbit user** for most organizations, as it is pre-configured. However, we understand that some organizations may prefer more control over the user or have restrictions regarding user inclusion within their organization. @@ -35,7 +35,7 @@ Upon first login to the application (immediately after the onboarding screen), y If your organization opts to use another user within the organization, you can do so by [generating a personal access token](#generating-a-personal-access-token). - + #### Recommendations @@ -67,4 +67,4 @@ GitLab provides an option to generate a personal access token for a new user. Fo 9. Click "Create Personal Access Token." 10. Note down the token as it will only be displayed once. - + \ No newline at end of file diff --git a/docs/platforms/self-hosted-gitlab.md b/docs/platforms/self-hosted-gitlab.md index f6ccae10..4c1dd2bd 100644 --- a/docs/platforms/self-hosted-gitlab.md +++ b/docs/platforms/self-hosted-gitlab.md @@ -22,7 +22,7 @@ upgrading your GitLab instance to obtain the intended experience. **Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and select Self-Hosted GitLab - + ### Step 2: Enter your Self-Managed GitLab URL @@ -30,7 +30,7 @@ On this page, enter the URL of your self-managed GitLab instance and click submit. Once, you submit, we check our database for a record of your organization and if we find an existing one, we are starting the login process. - + If the self-managed GitLab instance is not found, we initiate the onboarding process, which can be either manual or automated. @@ -39,7 +39,7 @@ process, which can be either manual or automated. #### 1. Automated onboarding - + #### **Why do we need the Admin Access Token?** @@ -55,7 +55,7 @@ add CodeRabbit manually on the projects you wish, as the next step. For the manual onboarding process we need to create the [CodeRabbit user](#creating-coderabbit-user) and the [OAuth2 GitLab application](#creating-oauth2-application). - + #### **Creating CodeRabbit user** @@ -105,14 +105,14 @@ the token, please follow the process outlined below: 9. Select Create personal access token. 10. Please note down this token as this will be visible one time only - + ### **Step 4: Paste the details and click submit** - Submit the form. - We will handle the setup process for you. - On subsequent visits, your setup will be automatically detected, allowing for - direct login.  + direct login.  ### **Step 5: Whitelist CodeRabbit IP address** diff --git a/static/img/integrations/admin-access-token.png b/static/img/integrations/gitlab-personal-access-token-scopes-setup.png similarity index 100% rename from static/img/integrations/admin-access-token.png rename to static/img/integrations/gitlab-personal-access-token-scopes-setup.png From d687c2db289294cd164139ec43bf7acfc9d681d6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 10:56:34 +0000 Subject: [PATCH 2/5] =?UTF-8?q?=F0=9F=8E=A8=20pnpm=20run=20lint:fix?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit [dependabot skip] --- docs/platforms/gitlab-com.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/gitlab-com.md b/docs/platforms/gitlab-com.md index fb51865b..6a1531eb 100644 --- a/docs/platforms/gitlab-com.md +++ b/docs/platforms/gitlab-com.md @@ -67,4 +67,4 @@ GitLab provides an option to generate a personal access token for a new user. Fo 9. Click "Create Personal Access Token." 10. Note down the token as it will only be displayed once. - \ No newline at end of file + From b10564857afec18a31de94b2d5586ceb3202cef7 Mon Sep 17 00:00:00 2001 From: Ankur Tyagi <tyaga001@live.com> Date: Wed, 6 Nov 2024 16:39:16 +0100 Subject: [PATCH 3/5] docs: added newline at end of file. --- docs/platforms/gitlab-com.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/platforms/gitlab-com.md b/docs/platforms/gitlab-com.md index 6a1531eb..c5cb3481 100644 --- a/docs/platforms/gitlab-com.md +++ b/docs/platforms/gitlab-com.md @@ -68,3 +68,4 @@ GitLab provides an option to generate a personal access token for a new user. Fo 10. Note down the token as it will only be displayed once.  + From 34f7c5d65c3570d6862af412a6a4fcffa0fb5d90 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 6 Nov 2024 15:44:34 +0000 Subject: [PATCH 4/5] =?UTF-8?q?=F0=9F=8E=A8=20pnpm=20run=20lint:fix?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit [dependabot skip] --- docs/platforms/gitlab-com.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/platforms/gitlab-com.md b/docs/platforms/gitlab-com.md index c5cb3481..6a1531eb 100644 --- a/docs/platforms/gitlab-com.md +++ b/docs/platforms/gitlab-com.md @@ -68,4 +68,3 @@ GitLab provides an option to generate a personal access token for a new user. Fo 10. Note down the token as it will only be displayed once.  - From 060f4a2d743fc7f6c63a64f67bf91361ef26c6a1 Mon Sep 17 00:00:00 2001 From: Ankur Tyagi <tyaga001@live.com> Date: Wed, 6 Nov 2024 16:52:12 +0100 Subject: [PATCH 5/5] chore: verify commit signing for previous commits