How to read these guides
How the pages are organised and what to expect on each one.
Every app has its own set of pages. They always follow the same order, so you can jump straight to what you need.
- Overview and setup
- What the app does, who is allowed to configure it, and the steps to get it working. Start here for any app.
- One page per feature
- Each major feature gets its own page. Each page tells you where the screen is, what every setting does, and what we recommend setting it to.
- Permissions, data and limits
- The technical reference: what the app can access, what it stores, and a troubleshooting list. Useful when something does not work, and when your security team asks questions.
- FAQ
- Short answers to the questions people ask before installing, and the ones a security review always asks.
The screenshots are drawings, not photos
The app screens in these guides are recreations, built in HTML. Each one is marked Illustration in its top-right corner, and the grey bar at the top tells you the exact menu path to reach that screen in Jira or Confluence.
We do it this way because real screenshots go out of date silently. A drawing that uses the app's real labels stays useful for longer. If a label in the app does not match a label here, trust the app and tell us.
How instructions are written
- Bold text
- The exact name of a button, a menu item or a setting. If it is bold, look for those words on your screen.
- Arrows, like Jira → Settings → Issues
- A path. Click each item in order.
Code style- Something you type or paste, such as a JQL query, a scope name or a field ID.
- Numbered steps
- Do them in order. Skipping one is the most common reason something does not work.
If you get stuck
Every app page ends with a link to our support portal. When you write to us, include three things: the app name, your Jira site address, and what you expected to happen. That is usually enough for us to reproduce the problem without a back-and-forth.