diff --git a/docs/Future Development.md b/docs/Future Development.md index 6c07ddd..1c68860 100644 --- a/docs/Future Development.md +++ b/docs/Future Development.md @@ -52,7 +52,6 @@ These are additional capabilities that can also be reviewed in the same PR to ac Finishing touches are about experience that often take developers time away from what they like doing best - coding. But adding finishing touches is crucial and should follow the ontology and taxonomy. We will start by looking into specefic areas such as documentation of code as an example . - > Disclaimer: any product roadmap features mentioned below are only meant to outline > our general product direction. This documentation is for informational purposes > only and may not be incorporated into any contract. diff --git a/docs/platforms/azure-devops.md b/docs/platforms/azure-devops.md index 9930219..cc6bb97 100644 --- a/docs/platforms/azure-devops.md +++ b/docs/platforms/azure-devops.md @@ -28,14 +28,14 @@ DevOps. ::: - ![azure devops apps consent](/img/integrations/azure_apps_consent_page.png) +![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) 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) + ![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) 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. -![azure devops user modal](/img/integrations/azure_personal_access_token_add.png) +![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) ### Recommendations @@ -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) +![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) diff --git a/docs/platforms/github-enterprise-server.md b/docs/platforms/github-enterprise-server.md index fae1a58..bfe134f 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 -![login-page](/img/integrations/login-self-hosted-github.png) +![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) 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 showing URL input field for GitHub instance domain](/img/integrations/self-hosted-github-host-url.png) 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 -![GitHub OAuth Client ID & Secret](/img/integrations/github-oauth-client-id-secret.png) +![GitHub Developer Settings page showing CodeRabbit OAuth application configuration with client ID display, client secret management](/img/integrations/github-oauth-client-id-secret.png) ### **Step 3: GitHub App** diff --git a/docs/platforms/gitlab-com.md b/docs/platforms/gitlab-com.md index 45886ad..39ac9e9 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. -![gitlab user modal choice](/img/integrations/gitlab_user_choice.png) +![GitLab repository access configuration modal showing how to choose between default CodeRabbit user or organization user token](/img/integrations/gitlab_user_choice.png) **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). -![gitlab organization user modal choice](/img/integrations/gitlab_organization_user.png) +![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) #### 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. -![Untitled](/img/integrations/admin-access-token.png) +![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) diff --git a/docs/platforms/self-hosted-gitlab.md b/docs/platforms/self-hosted-gitlab.md index 7bd814e..0947dd4 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 -![login-page](/img/integrations/login-self-hosted-gitlab.png) +![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) ### 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. -![Untitled](/img/integrations/self-hosted-gitlab-host-url.png) +![Self-hosted Gitlab enterprise connection page for CodeRabbit](/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. @@ -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 showing instance URL input, admin access token field, installation type toggles (Manual/Automated)](/img/integrations/automated-onboarding.png) #### **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). -![Untitled](/img/integrations/manual-onboarding.png) +![Self-managed GitLab connection page showing instance URL input, admin access token field, installation type toggles (Manual/Automated)](/img/integrations/manual-onboarding.png) #### **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 -![Untitled](/img/integrations/admin-access-token.png) +![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) ### **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 displaying three login choices - GitHub login button, GitLab login button, and Self-Hosted GitLab option](/img/integrations/self-hosted-page.png) ### **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