Skip to content

docs(jira): add a setup TL;DR to the integration guide #6847

Description

@ralphbean

It is difficult to get a high-level picture of Jira setup before reading the implementation details in the integration guide.

I think the beginning of the guide should give readers a short overview covering:

  1. Create a Jira service account.
  2. Grant it the Developer project role so it can operate on issues, and the Administrator project role so it can inspect other users’ roles when authorizing slash commands.
  3. Install fullsend in the target GitHub repository.
  4. Copy the Jira poller GitHub Actions workflow into the repository.
  5. Set the Jira project and JQL expression in that workflow.
  6. Configure the agents that should handle Jira events with matching trigger expressions.

The role step should call out that giving one service account both sets of access is more power than we want long-term and needs a follow-up design.

The trigger-expression step is temporary too: it can go away once the default agent suite has native Jira trigger expressions. #6672 tracks the current gap.

A reader should be able to scan this section and understand the whole setup before choosing which detailed sections they need.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions