From 4b04f09035dbf3966cdee2675a14f589b48d5c4b Mon Sep 17 00:00:00 2001 From: mamoodi Date: Mon, 10 Mar 2025 14:00:06 -0400 Subject: [PATCH] Update Cloud docs (#7158) Co-authored-by: Engel Nyst --- .../usage/cloud/cloud-github-resolver.md | 18 +++++++++++++++--- docs/modules/usage/cloud/openhands-cloud.md | 16 +++++++++++----- docs/modules/usage/feedback.md | 2 +- docs/modules/usage/how-to/github-action.md | 2 +- docs/modules/usage/installation.mdx | 2 +- 5 files changed, 29 insertions(+), 11 deletions(-) diff --git a/docs/modules/usage/cloud/cloud-github-resolver.md b/docs/modules/usage/cloud/cloud-github-resolver.md index 946bd1ba78..f91685deed 100644 --- a/docs/modules/usage/cloud/cloud-github-resolver.md +++ b/docs/modules/usage/cloud/cloud-github-resolver.md @@ -4,18 +4,30 @@ The GitHub Resolver automates code fixes and provides intelligent assistance for ## Setup -The Cloud Github Resolver is available automatically when you +The Cloud GitHub Resolver is available automatically when you [grant OpenHands Cloud repository access](./openhands-cloud.md#adding-repositories). ## Usage +After granting OpenHands Cloud repository access, you can use the Cloud GitHub Resolver on the issues and pull requests +on the repository. + ### Issues -On your repository, label an issue with `openhands`. OpenHands will attempt to fix the issue. +On your repository, label an issue with `openhands`. OpenHands will: +1. Comment on the issue to let you know it is working on it. + - You can click on the link to track the progress on OpenHands Cloud. +2. Open a pull request if it determines that the issue has been successfully resolved. +3. Comment on the issue with a summary of the performed tasks and a link to the pull request. + ### Pull Requests -In order to get OpenHands to work on pull requests, use `@openhands` in top level or single inline comments to: +To get OpenHands to work on pull requests, use `@openhands` in top level or inline comments to: - Ask questions - Request updates - Get code explanations + +OpenHands will: +1. Comment on the PR to let you know it is working on it. +2. Perform the task. diff --git a/docs/modules/usage/cloud/openhands-cloud.md b/docs/modules/usage/cloud/openhands-cloud.md index f39773cb27..9a77908204 100644 --- a/docs/modules/usage/cloud/openhands-cloud.md +++ b/docs/modules/usage/cloud/openhands-cloud.md @@ -12,14 +12,16 @@ instructions on how to access it. After visiting OpenHands Cloud, you will be asked to connect with your GitHub account: 1. After reading and accepting the terms of service, click `Connect to GitHub`. -2. Review the permissions requested by OpenHands and then click `Authorize OpenHands by All Hands AI`. +2. Review the permissions requested by OpenHands and then click `Authorize OpenHands AI`. - OpenHands will require some permissions from your GitHub account. To read more about these permissions, you can click the `Learn more` link on the GitHub authorize page. -## Adding Repositories +## Repository Access + +### Adding Repository Access You can grant OpenHands specific repository access: -1. Under the `Select a GitHub project` dropdown, select `Add more repositories...`. +1. Click the `Select a GitHub project` dropdown, select `Add more repositories...`. 2. Select the organization, then choose the specific repositories to grant OpenHands access to. - Openhands requests short-lived tokens (8-hour expiry) with these permissions: - Actions: Read and write @@ -34,6 +36,10 @@ You can grant OpenHands specific repository access: - Repository access for a user is granted based on: - Granted permission for the repository. - User's GitHub permissions (owner/collaborator). +3. Click on `Install & Authorize`. -You can manage repository access any time by following the above workflow or visiting the Settings page and selecting -`Configure GitHub Repositories` under the `GitHub Settings` section. +### Modifying Repository Access + +You can modify repository access at any time by: +* Using the same `Select a GitHub project > Add more repositories` workflow, or +* Visiting the Settings page and selecting `Configure GitHub Repositories` under the `GitHub Settings` section. diff --git a/docs/modules/usage/feedback.md b/docs/modules/usage/feedback.md index 4a6d3a78fd..e47ebdc347 100644 --- a/docs/modules/usage/feedback.md +++ b/docs/modules/usage/feedback.md @@ -36,7 +36,7 @@ At this time, we will follow the following release process: 1. All people who contributed public feedback will receive an email describing the data release and being given an opportunity to opt out. 2. The person or people in charge of the data release will perform quality control of the data, removing low-quality feedback, removing email submitter email addresses, and attempting to remove any sensitive information. -3. The data will be released publicly under the MIT license through commonly used sites such as github or Hugging Face. +3. The data will be released publicly under the MIT license through commonly used sites such as GitHub or Hugging Face. ### What if I want my data deleted? diff --git a/docs/modules/usage/how-to/github-action.md b/docs/modules/usage/how-to/github-action.md index a734a8b70a..3023ba1f9c 100644 --- a/docs/modules/usage/how-to/github-action.md +++ b/docs/modules/usage/how-to/github-action.md @@ -39,7 +39,7 @@ You can provide custom directions for OpenHands by following the [README for the ### Custom configurations -Github resolver will automatically check for valid [repository secrets](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions?tool=webui#creating-secrets-for-a-repository) or [repository variables](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#creating-configuration-variables-for-a-repository) to customize its behavior. +GitHub resolver will automatically check for valid [repository secrets](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions?tool=webui#creating-secrets-for-a-repository) or [repository variables](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#creating-configuration-variables-for-a-repository) to customize its behavior. The customization options you can set are: | **Attribute name** | **Type** | **Purpose** | **Example** | diff --git a/docs/modules/usage/installation.mdx b/docs/modules/usage/installation.mdx index 47bed7a7df..b068091f5c 100644 --- a/docs/modules/usage/installation.mdx +++ b/docs/modules/usage/installation.mdx @@ -76,7 +76,7 @@ You'll find OpenHands running at http://localhost:3000! You can also [connect OpenHands to your local filesystem](https://docs.all-hands.dev/modules/usage/runtimes#connecting-to-your-filesystem), run OpenHands in a scriptable [headless mode](https://docs.all-hands.dev/modules/usage/how-to/headless-mode), interact with it via a [friendly CLI](https://docs.all-hands.dev/modules/usage/how-to/cli-mode), -or run it on tagged issues with [a github action](https://docs.all-hands.dev/modules/usage/how-to/github-action). +or run it on tagged issues with [a GitHub action](https://docs.all-hands.dev/modules/usage/how-to/github-action). ## Setup