Skip to content

For the complete documentation index, see llms.txt.

Jira

Connect Jira as a context source so Promptless documents what a feature is meant to do. Your team records those requirements and acceptance criteria on its Jira issues. Promptless reads Jira in three ways:

  • When a GitHub PR or another trigger references a Jira issue, such as PROJ-123, Promptless reads that issue. This starts as soon as Jira is connected.
  • Promptless runs JQL (Jira Query Language) searches for related issues, epics, and dependencies.
  • When a task names a Jira version by its numeric ID, Promptless reads that version before it searches the version’s issues. For example, a release-notes request can name a fix version. Promptless gets the version’s name, project, release state, dates, and counts of the issues fixed in or affected by it.

From each issue, Promptless reads:

  • Summary and description
  • Status, type, priority, and resolution
  • Labels, components, and affected and fix versions
  • Parent, subtasks, and linked issues
  • Comments
  • Organization-defined custom fields, such as a Documentation field

Promptless reads only what the connected Jira account can see. It queries Jira in real time when a documentation task needs it, and doesn’t store your Jira data. Reading context never creates, updates, or deletes an issue.

A developer merges a GitHub PR whose description references PROJ-412, the Jira issue for a new bulk-import feature. The issue records the business requirements: the supported file formats and a 10,000-row import cap. It also records that imports run asynchronously and send an email notification on completion.

When Promptless picks up the merged PR, it reads PROJ-412 and runs a JQL search for related issues in the same epic. Its suggestion carries the acceptance criteria into the docs: the supported formats, the row limit, and the asynchronous import with its email notification. The docs then describe what the feature is meant to do, beyond what the diff shows.

  • An admin role in your Promptless organization, to connect Atlassian and edit the Configuration page.

Promptless connects to Jira through Atlassian. Skip this section if Atlassian is already connected on the Integrations page.

One Atlassian Cloud connection covers Jira, Confluence, or both. You need an admin role in your Promptless organization to connect it. Promptless reads Jira and Confluence with the permissions of the Atlassian account that approves the connection. If you attach an Atlassian service account, Promptless uses it for Jira instead. To connect a dedicated Atlassian account, log in to Atlassian as that account first.

  1. On the Promptless Integrations page, select Connect Atlassian.

  2. Select Jira, Confluence, or both, and select Continue to Atlassian. Promptless requests only the permissions for the products you select.

  3. If Atlassian shows its login screen, log in with the account you want Promptless to use.

    Atlassian Login Screen
  4. On the OAuth consent screen, review the permissions Promptless requests. For what each scope is for, see Permissions required.

    Jira OAuth Consent Screen
  5. Select Accept. If the consent screen shows no Accept option, your Atlassian account might not have the required permissions. Ask your Jira administrator to connect, or invite them to Promptless.

  6. On the Promptless Integrations page, confirm the connection on the Atlassian card.

To manage Promptless’s access later, open Atlassian and go to your avatar > Account settings > Connected apps.

Atlassian Connected Apps Management

Promptless can read every project the connected Jira account can see. To keep it to the projects that hold relevant work, scope the Jira context source:

  1. On the Context sources tab of the Configuration page, expand the Jira source. If it isn’t listed, select Add a context source, and then select Jira.

  2. In Which Jira projects should Promptless read?, add the key of each project.

  3. Select Save changes. For a new source, select Add context source.

In YAML, the scope is the project_keys list on a jira entry:

context_sources:
jira:
source_type: jira
project_keys:
- DOCS
- PLATFORM
- ENG

An entry with no project keys, or no entry, gives Promptless every project the account can see. For every context source field, see the Configuration Reference.

  • Jira trigger, to start documentation work from Jira issues
  • Atlassian integration, for the OAuth scopes Promptless requests and how to connect a dedicated Atlassian account
  • Confluence, to search your team’s Confluence spaces through the same Atlassian connection