Expand Jira integration docs with use case and examples#428
Expand Jira integration docs with use case and examples#428jpelletier1 wants to merge 2 commits intomainfrom
Conversation
- Added Overview section explaining the main use case - Documented how to trigger OpenHands (label or @mention) - Included example ticket structure with repository specification - Applied to both Jira Cloud and Jira Data Center docs Fixes #427 Co-authored-by: openhands <openhands@all-hands.dev>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
Good addition of usage docs. Verified against source code. Found a few inaccuracies around repository provider naming and mention syntax that should be corrected.
|
|
||
| 2. **Trigger OpenHands**: Activate the agent using one of these methods: | ||
| - Add an `openhands` label to the ticket | ||
| - Comment with: `@openhands please review these requirements, generate a plan, and then proceed with implementation` |
There was a problem hiding this comment.
🟠 Important: This is misleading. The exact text after @openhands doesn't matter.
I verified in the source code (enterprise/integrations/jira/jira_payload.py) that it uses has_exact_mention() which only checks for the presence of @openhands (case-insensitive) in the comment. The specific wording after it is irrelevant.
Suggested fix:
| - Comment with: `@openhands please review these requirements, generate a plan, and then proceed with implementation` | |
| - Comment with `@openhands` (you can include any text describing what you want done) |
Or provide a more accurate example like:
Comment with: @openhands implement this ticket
But clarify that the text after @openhands can be anything.
There was a problem hiding this comment.
I'm on it! all-hands-bot can track my progress at all-hands.dev
|
|
||
| 2. **Trigger OpenHands**: Activate the agent using one of these methods: | ||
| - Add an `openhands` label to the ticket | ||
| - Comment with: `@openhands please review these requirements, generate a plan, and then proceed with implementation` |
There was a problem hiding this comment.
🟠 Important: Same issue as jira-integration.mdx line 22. The exact text after @openhands doesn't matter - any comment containing the mention will trigger OpenHands.
See my comment on the other file for details and suggested fixes.
There was a problem hiding this comment.
I'm on it! all-hands-bot can track my progress at all-hands.dev
| ``` | ||
| As an administrator for my web app, I want to configure SAML so I can provide secure access to my system. | ||
|
|
||
| GitHub repository: AcmeCo/WebApp |
There was a problem hiding this comment.
🟡 Suggestion: Same as jira-integration.mdx line 36. Should say "Repository:" or "Git repository:" instead of "GitHub repository:" since it supports multiple providers.
See my comment on the other file for details.
|
|
||
| Once configured, you can request OpenHands to work on a Jira ticket by: | ||
|
|
||
| 1. **Specify the Repository**: Include the repository location in either: |
There was a problem hiding this comment.
🟢 Acceptable: The documentation says "either the ticket body itself, or a comment" which is clear enough. The implementation (enterprise/integrations/jira/jira_view.py) searches both the issue description and comments for repository patterns, so this is technically accurate.
Might optionally clarify that both are searched together (not mutually exclusive), but not critical.
Co-authored-by: OpenHands Bot <contact@all-hands.dev>
3 participants
Summary of changes
This PR expands the Jira integration documentation to include a comprehensive overview section explaining the main use case for the integration.
Changes made:
openhandslabel or@openhandsmention)Files modified:
openhands/usage/cloud/project-management/jira-integration.mdx(Jira Cloud)openhands/usage/cloud/project-management/jira-dc-integration.mdx(Jira Data Center)Both files now provide clear guidance to users on how to use the Jira integration for automated development workflows.
Fixes #427
@jpelletier1 can click here to continue refining the PR