From 44f5cd843f9d269e6fefc964fd64f3ac7325cd7e Mon Sep 17 00:00:00 2001 From: mamoodi Date: Fri, 6 Jun 2025 10:10:11 -0400 Subject: [PATCH 1/2] Update gitlab integration docs --- docs/docs.json | 1 - docs/usage/cloud/cloud-ui.mdx | 1 - docs/usage/cloud/github-installation.mdx | 4 ++-- docs/usage/cloud/gitlab-installation.mdx | 18 ++++++++++-------- docs/usage/cloud/openhands-cloud.mdx | 2 +- frontend/src/utils/tips.ts | 2 +- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/docs.json b/docs/docs.json index 2ad00adafcd7..c91d7064ed5a 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -38,7 +38,6 @@ ] }, "usage/cloud/cloud-ui", - "usage/cloud/cloud-issue-resolver", "usage/cloud/cloud-api" ] }, diff --git a/docs/usage/cloud/cloud-ui.mdx b/docs/usage/cloud/cloud-ui.mdx index e5bc417f7561..9537fd2f41c7 100644 --- a/docs/usage/cloud/cloud-ui.mdx +++ b/docs/usage/cloud/cloud-ui.mdx @@ -24,5 +24,4 @@ The settings page allows you to: ## Next Steps -- [Use the Cloud Issue Resolver](./cloud-issue-resolver) to automate code fixes and get assistance. - [Learn about the Cloud API](./cloud-api) for programmatic access. diff --git a/docs/usage/cloud/github-installation.mdx b/docs/usage/cloud/github-installation.mdx index 09ad18105369..28eb533ca4d0 100644 --- a/docs/usage/cloud/github-installation.mdx +++ b/docs/usage/cloud/github-installation.mdx @@ -1,7 +1,7 @@ --- title: GitHub Integration description: This guide walks you through the process of installing OpenHands Cloud for your GitHub repositories. Once - set up, it will allow OpenHands to work with your GitHub repository through the Cloud UI or straight from GitHub issues! + set up, it will allow OpenHands to work with your GitHub repository through the Cloud UI or straight from GitHub! --- ## Prerequisites @@ -37,7 +37,7 @@ You can modify GitHub repository access at any time by: - Selecting `Add GitHub repos` on the landing page or - Visiting the Settings page and selecting `Configure GitHub Repositories` under the `Git` tab -## Working With Github Repos in Openhands Cloud +## Working With GitHub Repos in Openhands Cloud Once you've granted GitHub repository access, you can start working with your GitHub repository. Use the `select a repo` and `select a branch` dropdowns to select the appropriate repository and branch you'd like OpenHands to work on. Then diff --git a/docs/usage/cloud/gitlab-installation.mdx b/docs/usage/cloud/gitlab-installation.mdx index 95c1a1f210eb..c0ddaf18f6ba 100644 --- a/docs/usage/cloud/gitlab-installation.mdx +++ b/docs/usage/cloud/gitlab-installation.mdx @@ -1,21 +1,23 @@ --- title: GitLab Integration -description: This guide walks you through the process of installing and configuring OpenHands Cloud for your GitLab repositories. +description: This guide walks you through the process of installing OpenHands Cloud for your GitLab repositories. Once + set up, it will allow OpenHands to work with your GitLab repository through the Cloud UI or straight from GitLab! --- ## Prerequisites -- A GitLab account -- Access to OpenHands Cloud +- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a GitLab account](/usage/cloud/openhands-cloud). -## Installation Steps +## Adding GitLab Repository Access -1. Log in to [OpenHands Cloud](https://app.all-hands.dev) -2. If you haven't connected your GitLab account yet: - - Click on `Log in with GitLab` - - Authorize the OpenHands application +Upon signing into OpenHands Cloud with a GitLab account, OpenHands will have access to your repositories. +## Working With GitLab Repos in Openhands Cloud +After signing in with a Gitlab account, use the `select a repo` and `select a branch` dropdowns to select the +appropriate repository and branch you'd like OpenHands to work on. Then click on `Launch` to start the session! + +![Connect Repo](/static/img/connect-repo.png) ## Next Steps diff --git a/docs/usage/cloud/openhands-cloud.mdx b/docs/usage/cloud/openhands-cloud.mdx index 9a058c17d385..2710830c5aa2 100644 --- a/docs/usage/cloud/openhands-cloud.mdx +++ b/docs/usage/cloud/openhands-cloud.mdx @@ -14,6 +14,7 @@ You'll be prompted to connect with your GitHub or GitLab account: 2. Review the permissions requested by OpenHands and authorize the application. - OpenHands will require certain permissions from your account. To read more about these permissions, you can click the `Learn more` link on the authorization page. +3. Review and accept the `terms of service` and select `Continue`. ## Next Steps @@ -23,4 +24,3 @@ Once you've connected your account, you can: - [Install GitLab Integration](./gitlab-installation) to use OpenHands with your GitLab repositories - [Access the Cloud UI](./cloud-ui) to interact with the web interface - [Use the Cloud API](./cloud-api) to programmatically interact with OpenHands -- [Set up the Cloud Issue Resolver](./cloud-issue-resolver) to automate code fixes and provide intelligent assistance diff --git a/frontend/src/utils/tips.ts b/frontend/src/utils/tips.ts index aa7da22730a2..a6eda139dc8b 100644 --- a/frontend/src/utils/tips.ts +++ b/frontend/src/utils/tips.ts @@ -30,7 +30,7 @@ export const TIPS: Tip[] = [ }, { key: I18nKey.TIPS$GITHUB_HOOK, - link: "https://docs.all-hands.dev/usage/cloud/cloud-issue-resolver", + link: "https://docs.all-hands.dev/usage/cloud/github-installation#working-on-github-issues-and-pull-requests-using-openhands", }, { key: I18nKey.TIPS$BLOG_SIGNUP, From e21e128b6cef46a517f237876785e2ed5a98e68c Mon Sep 17 00:00:00 2001 From: mamoodi Date: Fri, 6 Jun 2025 10:11:25 -0400 Subject: [PATCH 2/2] Remove snippet until we get it working --- docs/usage/cloud/gitlab-installation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage/cloud/gitlab-installation.mdx b/docs/usage/cloud/gitlab-installation.mdx index c0ddaf18f6ba..234b76729bed 100644 --- a/docs/usage/cloud/gitlab-installation.mdx +++ b/docs/usage/cloud/gitlab-installation.mdx @@ -1,7 +1,7 @@ --- title: GitLab Integration description: This guide walks you through the process of installing OpenHands Cloud for your GitLab repositories. Once - set up, it will allow OpenHands to work with your GitLab repository through the Cloud UI or straight from GitLab! + set up, it will allow OpenHands to work with your GitLab repository. --- ## Prerequisites