Skip to content

Commit 9e498c7

Browse files
tyaga001tyaga001
committed
docs: refactored integration guides images SEO and accessibility
1 parent 7f5fb69 commit 9e498c7

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

‎docs/platforms/azure-devops.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ please contact your administrator to request approval for the applications.
2828

2929
:::
3030

31-
![azure devops apps consent](/img/integrations/azure_apps_consent_page.png)
31+
![CodeRabbit admin consent page for Azure DevOps integration showing Microsoft authentication URLs and continue button for granting application permissions](/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+
![Azure DevOps integration settings page showing organization user ID and personal access token input field for CodeRabbit configuration](/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+
![Azure DevOps integration modal with personal access token input field and documentation link for connecting CodeRabbit to Azure DevOps API](/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+
![Azure DevOps personal access token creation form showing name field, organization selector, expiration date, and detailed permission scopes for work items, code, build, release, test management, and packaging](/img/integrations/azure-access-token.png)

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

+3-3
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 displaying multiple sign-in options - Login with GitHub, Login with GitLab, Self-Hosted GitHub and GitLab](/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 showing URL input field for GitHub instance domain](/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.
@@ -66,7 +66,7 @@ Keep the following details handy:
6666
- Client ID
6767
- Client secret
6868

69-
![GitHub OAuth Client ID & Secret](/img/integrations/github-oauth-client-id-secret.png)
69+
![GitHub Developer Settings page showing CodeRabbit OAuth application configuration with client ID display, client secret management](/img/integrations/github-oauth-client-id-secret.png)
7070

7171
### **Step 3: GitHub App**
7272

‎docs/platforms/gitlab-com.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ To interact with the GitLab API, a **Personal Access Token** is required. This t
2727

2828
Upon first login to the application (immediately after the onboarding screen), you will need to choose based on your organization's requirements.
2929

30-
![gitlab user modal choice](/img/integrations/gitlab_user_choice.png)
30+
![GitLab repository access configuration modal showing how to choose between default CodeRabbit user or organization user token](/img/integrations/gitlab_user_choice.png)
3131

3232
**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.
3333

3434
### Personal Access Tokens
3535

3636
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).
3737

38-
![gitlab organization user modal choice](/img/integrations/gitlab_organization_user.png)
38+
![GitLab integration configuration modal showing personal access token input field and organization user setup with detailed instructions for token integration](/img/integrations/gitlab_organization_user.png)
3939

4040
#### Recommendations
4141

@@ -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 showing token name input, expiration date selector, and API permission scopes including read/write access options](/img/integrations/gitlab-personal-access-token-scopes-setup.png)

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,23 @@ CodeRabbit supports GitLab `16.x` and above. Version `15.x` may experience unexp
1919
**Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and
2020
select Self-Hosted GitLab
2121

22-
![login-page](/img/integrations/login-self-hosted-gitlab.png)
22+
![CodeRabbit login page displaying multiple sign-in options - Login with GitHub, Login with GitLab, Self-Hosted GitHub and GitLab](/img/integrations/login-self-hosted-gitlab.png)
2323

2424
### Step 2: Enter your Self-Managed GitLab URL
2525

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

30-
![Untitled](/img/integrations/self-hosted-gitlab-host-url.png)
30+
![Self-hosted Gitlab enterprise connection page for CodeRabbit](/img/integrations/self-hosted-gitlab-host-url.png)
3131

3232
If the self-managed GitLab instance is not found, we initiate the onboarding process, which can be either manual or automated.
3333

3434
### **Step 3: Onboarding Manual or Automated**
3535

3636
#### 1. Automated onboarding
3737

38-
![Untitled](/img/integrations/automated-onboarding.png)
38+
![Self-managed GitLab connection page showing instance URL input, admin access token field, installation type toggles (Manual/Automated)](/img/integrations/automated-onboarding.png)
3939

4040
#### **Why do we need the Admin Access Token?**
4141

@@ -50,7 +50,7 @@ wish, as the next step.
5050
#### 2. Manual onboarding
5151

5252
For the manual onboarding process we need to create the [CodeRabbit user](#creating-coderabbit-user) and the [OAuth2 GitLab application](#creating-oauth2-application).
53-
![Untitled](/img/integrations/manual-onboarding.png)
53+
![Self-managed GitLab connection page showing instance URL input, admin access token field, installation type toggles (Manual/Automated)](/img/integrations/manual-onboarding.png)
5454

5555
#### **Creating CodeRabbit user**
5656

@@ -92,14 +92,14 @@ the token, please follow the process outlined below:
9292
9. Select Create personal access token.
9393
10. Please note down this token as this will be visible one time only
9494

95-
![Untitled](/img/integrations/admin-access-token.png)
95+
![GitLab personal access token configuration page showing token name input, expiration date selector, and API permission scopes including read/write access options](/img/integrations/gitlab-personal-access-token-scopes-setup.png)
9696

9797
### **Step 4: Paste the details and click submit**
9898

9999
- Submit the form.
100100
- We will handle the setup process for you.
101101
- On subsequent visits, your setup will be automatically detected, allowing for
102-
direct login. ![Untitled](/img/integrations/self-hosted-page.png)
102+
direct login. ![CodeRabbit authentication options page displaying three login choices - GitHub login button, GitLab login button, and Self-Hosted GitLab option](/img/integrations/self-hosted-page.png)
103103

104104
### **Step 5: Whitelist CodeRabbit IP address**
105105

‎static/img/integrations/admin-access-token.png renamed to ‎static/img/integrations/gitlab-personal-access-token-scopes-setup.png

File renamed without changes.

0 commit comments

Comments
 (0)