Book Image

JIRA Development Cookbook

Book Image

JIRA Development Cookbook

Overview of this book

JIRA provides issue tracking and project tracking for software development teams to improve code quality and the speed of development.This book is your one-stop resource to master JIRA extension and customization. You will learn how to create your own JIRA plugins, customize the look and feel of your JIRA UI, work with Workflows, Issues, Custom Fields, and much more.The book starts with recipes on simplifying the Plugin development process followed by a complete chapter dedicated to the Plugin Framework to master Plugins in JIRA.Then we will move on to writing custom field plugins to create new field types or custom searchers. We then learn how to program and customize Workflows to transform JIRA into a user-friendly system. Reporting support in an application like JIRA is inevitable! With so much data spanning across different projects, issues, etc and a lot of project planning done on it, we will cover how to work on reports and gadgets to get customized data according to our needs. We will then look at customizing the various searching aspects of JIRA such as JQL, searching in plugins, managing filters, and so on. Then the book steers towards programming Issues, i.e. creating/editing/deleting issues, creating new issue operations, managing the various other operations available on issues via the JIRA APIs etc. In the latter half of the book, you will learn how to customize JIRA by adding new tabs, menus, and web items, communicate with JIRA via the REST, SOAP or XML/RPC interfaces, and work with the JIRA database.The book ends with a chapter on useful and general JIRA recipes.
Table of Contents (19 chapters)
JIRA Development Cookbook
Credits
About the Author
Acknowledgment
About the Reviewers
www.PacktPub.com
Preface
Index

Adding help text for a custom field


As our JIRA instance grows, demanding more and more information from the users through the custom fields, it becomes a norm to let the users know what we expect from them. Apart from a bunch of tutorials that we can prepare for them, it makes sense to give them some help right there on the screen, next to the field.

Let us see the various options on how to do it.

Getting ready

Make sure you have the custom field, for which the help needs to be displayed and configured properly.

How to do it...

There are various ways to provide help. Let us see the most widely accepted ways:

  1. Link to a help page.

    This is just common sense. Just link to a documentation about the field, hosted somewhere. We can do this easily by adding few hyperlinks in the description of the custom field. We just need to reuse some of the JIRA styles to make sure the help appears consistent across the system.

    The hyperlinks again can be added in two ways. They are as follows:

    1. Open the help document...