Last updatedApr 21, 2019

Tutorials and guides

Our tutorials and guides are split into topics to help you learn to develop for different parts of Jira. Tutorials provide complete step-by-step instructions for working through an example, while guides explore information about a particular topic in depth.

If you're getting started with developing on Atlassian products we recommend you work through some tutorials.

Issues

An issue in Jira can represent different things, depending on how your organization is using Jira. For example, an issue could represent a software bug, a project task, a helpdesk ticket, a leave request form, etc. The resources in this section will help you extend issues in Jira. For example, you could add content to the View Issue page or action issues programmatically.

Tutorials

Guides

Fields

An issue is a collection of fields. Jira provides a standard set of fields, but administrators can also add custom fields. The resources in this section will help you extend fields in Jira. For example, you could create your own custom field type.

Tutorials

Guides

Workflow

A Jira workflow is the set of statuses and transitions that an issue goes through during its lifecycle. The resources in this section will help you extend workflows in Jira. For example, you could create custom elements (functions, validators, etc) that can be added to workflows.

Tutorials

Guides

Projects

A project is a collection of issues. The resources in this section will help you extend projects in Jira. For example, you could add links to the sidebar, create custom project templates, tweak the project configuration options, and more.

Tutorials

Guides

Boards

A board is used to display the progress of issues through their workflow. The resources in this section will help you work with boards. For example, you could add a board configuration page.

Tutorials

Jira provides a powerful issue search facility with three different search methods: advanced searching, basic searching and quick search. Advanced searching is done using Jira Query language (JQL). The resources in this section will help you extend the issue search in Jira. For example, you could add your own JQL function to Jira.

Tutorials

Email

Jira can create issues based on incoming emails as well as send notifications to users via email. The resources in this section will help you extend email handling in Jira. For example, you could build your own mail handler (in addition to the built-in ones).

Tutorials

Dashboards

A dashboard can be customized by adding gadgets or dashboard items. You can extend this by building your own gadgets or dashboard items. The resources in this section will help you work with gadgets in Jira. For example, you could write a Jira gadget that shows the days remaining in a version on a dashboard.

Tutorials

Guides

Remote issue links create a connection between an object in your application and an issue in Jira. The resources in this section will show you how to create these links.

Tutorials

Guides

Editor

The editor is used when entering text into Jira in places like the issue summary and commenting on issues. The resources in this section will show you how the editor can be extended in various ways.

Tutorials

Other

This section lists tutorials that are not related to the major components of Jira (projects, issues, fields, etc). For example, how to internationalize your plugin, how to write tests for your plugin, etc.

Tutorials

Guides