diff --git a/docs/docs.json b/docs/docs.json index 72fd90f19d..cbd66e3e77 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -34,6 +34,7 @@ { "group": "Integrations", "pages": [ + "usage/cloud/bitbucket-installation", "usage/cloud/github-installation", "usage/cloud/gitlab-installation", "usage/cloud/slack-installation" diff --git a/docs/static/img/connect-repo-no-github.png b/docs/static/img/connect-repo-no-github.png new file mode 100644 index 0000000000..bbc3af3c3a Binary files /dev/null and b/docs/static/img/connect-repo-no-github.png differ diff --git a/docs/usage/cloud/bitbucket-installation.mdx b/docs/usage/cloud/bitbucket-installation.mdx new file mode 100644 index 0000000000..4ae8668c5e --- /dev/null +++ b/docs/usage/cloud/bitbucket-installation.mdx @@ -0,0 +1,25 @@ +--- +title: Bitbucket Integration +description: This guide walks you through the process of installing OpenHands Cloud for your Bitbucket repositories. Once + set up, it will allow OpenHands to work with your Bitbucket repository. +--- + +## Prerequisites + +- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a Bitbucket account](/usage/cloud/openhands-cloud). + +## Adding Bitbucket Repository Access + +Upon signing into OpenHands Cloud with a Bitbucket account, OpenHands will have access to your repositories. + +## Working With Bitbucket Repos in Openhands Cloud + +After signing in with a Bitbucket 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 conversation! + +![Connect Repo](/static/img/connect-repo-no-github.png) + +## Next Steps + +- [Learn about the Cloud UI](/usage/cloud/cloud-ui). +- [Use the Cloud API](/usage/cloud/cloud-api) to programmatically interact with OpenHands. diff --git a/docs/usage/cloud/cloud-ui.mdx b/docs/usage/cloud/cloud-ui.mdx index 492ea99949..d63ac66c99 100644 --- a/docs/usage/cloud/cloud-ui.mdx +++ b/docs/usage/cloud/cloud-ui.mdx @@ -9,8 +9,9 @@ description: The Cloud UI provides a web interface for interacting with OpenHand The landing page is where you can: - [Add GitHub repository access](/usage/cloud/github-installation#adding-github-repository-access) to OpenHands. -- [Select a GitHub repo](/usage/cloud/github-installation#working-with-github-repos-in-openhands-cloud) or - [a GitLab repo](/usage/cloud/gitlab-installation#working-with-gitlab-repos-in-openhands-cloud) to start working on. +- [Select a GitHub repo](/usage/cloud/github-installation#working-with-github-repos-in-openhands-cloud), + [a GitLab repo](/usage/cloud/gitlab-installation#working-with-gitlab-repos-in-openhands-cloud) or + [a Bitbucket repo](/usage/cloud/bitbucket-installation#working-with-bitbucket-repos-in-openhands-cloud) to start working on. - See `Suggested Tasks` for repositories that OpenHands has access to. - Launch an empty conversation using `Launch from Scratch`. diff --git a/docs/usage/cloud/gitlab-installation.mdx b/docs/usage/cloud/gitlab-installation.mdx index a2334d1e7c..4f7aef6df8 100644 --- a/docs/usage/cloud/gitlab-installation.mdx +++ b/docs/usage/cloud/gitlab-installation.mdx @@ -17,7 +17,7 @@ Upon signing into OpenHands Cloud with a GitLab account, OpenHands will have acc 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 conversation! -![Connect Repo](/static/img/connect-repo.png) +![Connect Repo](/static/img/connect-repo-no-github.png) ## Using Tokens with Reduced Scopes diff --git a/docs/usage/cloud/openhands-cloud.mdx b/docs/usage/cloud/openhands-cloud.mdx index 053453afb2..6c0e363497 100644 --- a/docs/usage/cloud/openhands-cloud.mdx +++ b/docs/usage/cloud/openhands-cloud.mdx @@ -8,9 +8,9 @@ description: Getting started with OpenHands Cloud. OpenHands Cloud is the hosted cloud version of All Hands AI's OpenHands. To get started with OpenHands Cloud, visit [app.all-hands.dev](https://app.all-hands.dev). -You'll be prompted to connect with your GitHub or GitLab account: +You'll be prompted to connect with your GitHub, GitLab or Bitbucket account: -1. Click `Log in with GitHub` or `Log in with GitLab`. +1. Click `Log in with GitHub`, `Log in with GitLab` or `Log in with Bitbucket`. 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. @@ -22,5 +22,6 @@ Once you've connected your account, you can: - [Install GitHub Integration](/usage/cloud/github-installation) to use OpenHands with your GitHub repositories. - [Install GitLab Integration](/usage/cloud/gitlab-installation) to use OpenHands with your GitLab repositories. +- [Install Bitbucket Integration](/usage/cloud/bitbucket-installation) to use OpenHands with your Bitbucket repositories. - [Learn about the Cloud UI](/usage/cloud/cloud-ui). - [Use the Cloud API](/usage/cloud/cloud-api) to programmatically interact with OpenHands. diff --git a/docs/usage/faqs.mdx b/docs/usage/faqs.mdx index 1897e89d31..4b322dba7a 100644 --- a/docs/usage/faqs.mdx +++ b/docs/usage/faqs.mdx @@ -12,7 +12,8 @@ icon: question [GitHub](/usage/cloud/github-installation), [GitLab](/usage/cloud/gitlab-installation), and [Slack](/usage/cloud/slack-installation) integrations. 2. **Run on your own**: If you prefer to run it on your own hardware, follow our [Getting Started guide](/usage/local-setup). -3. **First steps**: Complete the [start building tutorial](/usage/getting-started) to learn the basics. +3. **First steps**: Read over the [start building guidelines](/usage/getting-started) and + [prompting best practices](/usage/prompting/prompting-best-practices) to learn the basics. ### Can I use OpenHands for production workloads? diff --git a/docs/usage/how-to/gui-mode.mdx b/docs/usage/how-to/gui-mode.mdx index 1b7c944b12..331ecd595d 100644 --- a/docs/usage/how-to/gui-mode.mdx +++ b/docs/usage/how-to/gui-mode.mdx @@ -25,7 +25,8 @@ You can use the Settings page at any time to: - Setup the LLM provider and model for OpenHands. - [Setup the search engine](/usage/search-engine-setup). - [Configure MCP servers](/usage/mcp). -- [Connect to GitHub](/usage/how-to/gui-mode#github-setup) and [connect to GitLab](/usage/how-to/gui-mode#gitlab-setup). +- [Connect to GitHub](/usage/how-to/gui-mode#github-setup), [connect to GitLab](/usage/how-to/gui-mode#gitlab-setup) + and [connect to Bitbucket](/usage/how-to/gui-mode#bitbucket-setup). - Set application settings like your preferred language, notifications and other preferences. - [Manage custom secrets](/usage/common-settings#secrets-management).