Skip to content
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

docs: Improve docs SEO #142

Merged
merged 2 commits into from
Nov 11, 2024
Merged

docs: Improve docs SEO #142

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0478a33
added SEO changes
tyaga001 Nov 11, 2024
5697caf
Merge branch 'main' into seo-changes
tyaga001 Nov 11, 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
8 changes: 4 additions & 4 deletions docs/platforms/azure-devops.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ DevOps.

:::

![azure devops apps consent](/img/integrations/azure_apps_consent_page.png)
![CodeRabbit admin consent page for Azure DevOps integration](/img/integrations/azure_apps_consent_page.png)

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.
![azure devops user page](/img/integrations/azure_devops_user_page.png)
![CodeRabbit azure devOps integration settings page](/img/integrations/azure_devops_user_page.png)
6. To install CodeRabbit on a repository, toggle the switch on the
"Repositories" page.

Expand All @@ -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.

![azure devops user modal](/img/integrations/azure_personal_access_token_add.png)
![CodeRabbit azure devOps integration modal](/img/integrations/azure_personal_access_token_add.png)

### Recommendations

Expand Down Expand Up @@ -98,4 +98,4 @@ Follow these steps to generate the token:
on pull requests.
8. Click "Create"

![Generate Personal Access Token](/img/integrations/azure-access-token.png)
![CodeRabbit azure devOps personal access token creation form](/img/integrations/azure-access-token.png)
4 changes: 2 additions & 2 deletions docs/platforms/github-enterprise-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

![login-page](/img/integrations/login-self-hosted-github.png)
![CodeRabbit login page](/img/integrations/login-self-hosted-github.png)
tyaga001 marked this conversation as resolved.
Show resolved Hide resolved

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.

![Untitled](/img/integrations/self-hosted-github-host-url.png)
![Self-hosted gitHub enterprise connection page for CodeRabbit](/img/integrations/self-hosted-github-host-url.png)
tyaga001 marked this conversation as resolved.
Show resolved Hide resolved

If the self-managed GitHub instance is not found, you will be required to enter
more details for the onboarding.
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/gitlab-com.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

![Untitled](/img/integrations/admin-access-token.png)
![GitLab personal access token configuration page](/img/integrations/admin-access-token.png)
tyaga001 marked this conversation as resolved.
Show resolved Hide resolved
12 changes: 6 additions & 6 deletions docs/platforms/self-hosted-gitlab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ upgrading your GitLab instance to obtain the intended experience.
**Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and
select Self-Hosted GitLab

![login-page](/img/integrations/login-self-hosted-gitlab.png)
![CodeRabbit login](/img/integrations/login-self-hosted-gitlab.png)

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

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.

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

If the self-managed GitLab instance is not found, we initiate the onboarding
process, which can be either manual or automated.
Expand All @@ -39,7 +39,7 @@ process, which can be either manual or automated.

#### 1. Automated onboarding

![Untitled](/img/integrations/automated-onboarding.png)
![Self-managed GitLab connection page](/img/integrations/automated-onboarding.png)

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

Expand All @@ -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).
![Untitled](/img/integrations/manual-onboarding.png)
![Self-managed GitLab connection page](/img/integrations/manual-onboarding.png)

#### **Creating CodeRabbit user**

Expand Down Expand Up @@ -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

![Untitled](/img/integrations/admin-access-token.png)
![GitLab personal access token configuration page](/img/integrations/admin-access-token.png)

### **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. ![Untitled](/img/integrations/self-hosted-page.png)
direct login. ![CodeRabbit authentication options page](/img/integrations/self-hosted-page.png)

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

Expand Down