JIRA Studio Quick Start Guide

JIRA Studio Documentation

Glossary
Index

On this page:


Welcome to JIRA Studio! JIRA Studio is a development collaboration platform designed to support software development teams of any size. Based on JIRA, the popular issue tracker and workflow management tool, JIRA Studio adds industry standard revision control, repository viewer, wiki, and code review, all in one seamless hosted experience.

Don't have an account? Get one here.

This document will walk you through the initial creation of a project in JIRA Studio, working with the different applications and creating links between applications.

Creating a New Project

Once you have logged in to JIRA Studio, your first step will be to create a new project. This process will create the project itself, as well as the wiki space and source repository.
Having trouble accessing JIRA Studio? Contact our support staff.

To create a new project in JIRA Studio:

  1. Click the 'Administration' link that can be found in the top right of the JIRA Studio header. You need to be logged in as an administrator to see the 'Administration' link.

     
  2. The 'Administration' page will appear, listing all of the projects currently set up in JIRA Studio. Click the 'Add Project' link.

     
  3. The 'Add A New Project' page will display. Try entering the example values shown in the diagram below.

     
  4. Click the 'Add' button to add your new project.
In JIRA Studio, a project integrates information from all of the applications. This allows the project's issues to automatically link to (and be linked from) their associated wiki documents, source files, changesets and code reviews.

You have now created your first JIRA Studio project!

Read more about creating projects.


Working with your New Project

One of the first things you will notice in JIRA Studio is the blue header with a 'Projects' dropdown and tabs to the four main applications of JIRA Studio — 'Issues' (JIRA), 'Wiki' (Confluence), 'Source' (FishEye) and 'Reviews' (Crucible).


 

The 'Projects' dropdown will contain the name of the project you have just created. If you choose to create more projects, you can switch between each project by selecting the appropriate project name in this dropdown.

By default, the 'Issues' dashboard will be displayed after you first create a project. You will see a portlet for the project you have just created, containing useful project information and links. The Activity Streams portlet is also included by default. Read more about customising your dashboard.

The following examples illustrate how to use each of the applications in JIRA Studio individually, and also show how they can be used together as a collaborative suite.

1. Creating an Issue

You can track and manage issues in JIRA Studio using the 'Issues' application. The following example gets you started with creating a new issue.

  1. Click the 'Create New Issue' link in the grey subheader.

     
  2. The 'Create Issue — Step 1 of 2. Choose the project and issue type' screen will be displayed. Select the project you just created and an issue type, for example, a 'Task' as displayed below. Click the 'Next' button.

     
  3. The 'Create Issue — Step 2 of 2. Enter the details of the issue' screen will be displayed. Enter the example values, as shown in the screenshot below.

     
  4. Click the 'Create' button at the bottom of the page. The new issue will be created and displayed on the 'View Issue' screen.
If notification schemes have been set up, you can also receive an email containing details and a link to your new issue whenever one is created.

You have now created your first issue in JIRA Studio!

Read more about creating issues.

2. Creating a Wiki Page

The 'Wiki' in JIRA Studio makes it easy for you to find, add and share content with other users. The first step in using your wiki is to create a new page.

  1. Navigate to the wiki space for your project by clicking on the 'Wiki' tab in the JIRA Studio header.
  2. Select 'Add Page' from the 'Add Page' menu in the grey subheader. The 'Add Page' screen will display.

     
  3. Enter a name (title) for your page and content for your page using Wiki Markup, or the Rich Text editor, as per the example below. At any time during your draft, you can see what your page will look like by clicking the 'Preview' tab.

     
  4. Click 'Save'. Your new wiki page will display.

     

You have now created your first wiki page in JIRA Studio!

Read more about creating pages in your wiki.

3. Creating Links between your Issues and Wikis

One of the most powerful features of JIRA Studio is the ability to create links between applications. To create a link from your wiki page to your issue,

  1. Edit the wiki page you have just created, by clicking the 'Edit' tab.
  2. In the content of your page, type the issue key for the issue you created previously, e.g. DEMO-2 (Note, links for issues must be in uppercase).

     
  3. Click 'Save'.

The issue key you entered in the content will display as a link in the wiki page. Click this link and you will be directed to your issue in the Issues application. Although you have switched applications, you will remain within the context of your current project.

Creating a link from your issue to your wiki page is just as simple.

  1. Edit the issue that is currently displayed, by clicking the 'Edit' link in the left hand menu.
  2. In the description of your issue, enter the name of your wiki page in square brackets, e.g. '[Demo Project Studio Stream]'. If you followed the previous example to create an issue, you can use the sample issue description shown below.

     
  3. Click 'Update'.

The wiki page name you entered will display as a link in the issue description. Click this link and you will be directed to your page in the 'Wiki' application.

You have now created your first links in JIRA Studio!

Read more about creating links.

4. Viewing your Source

You can commit or import data into your source repository by using the Subversion command-line client or by configuring an IDE to connect to your repository. Once you have added code into your Subversion repository, the 'Source' application of JIRA Studio allows you to view, track and analyse any changes to your source. You can even link a changeset to an issue and/or a wiki.

  1. Commit some code to Subversion using the Subversion command-line client or via your IDE. In the commit comment/description, enter the JIRA issue number of the JIRA issue previously created and the name of your wiki page in square brackets, e.g. '[Demo Project Studio Stream]'.
  2. In JIRA Studio, open the JIRA issue you previously created.
  3. Click the 'Source' link, in the row of links under the issue's 'Description'.
  4. An information summary of your source code commit (changeset) will be displayed.

     
  5. Click the changeset number (circled in the above image) and you will be directed to the 'Source' application, where the full details of the changeset will be displayed (see screenshot below).

     

You have now viewed your first source code change in JIRA Studio!

Read more about browsing your repository.

5. Creating a Review

Now that you have committed code to your repository, you may wish to have your changes reviewed by another person. The following example demonstrates how to create a review of your code change in the 'Reviews' application.

For simplicity, the following example sets you as the author, moderator and reviewer. Typically these roles would be assigned to separate users and the workflow would be more complex. Read more on setting up additional users.
  1. Click the create review icon in your changeset that is currently displayed.
  2. You will be directed to the 'Reviews' application. Select your project name in the 'Select Project for Review' dropdown and click 'Create Review'.
  3. The 'Review' screen will display with the review in 'draft' status. Click the 'Statement of Objectives' link to expand the review details.

     
  4. You will be set as the Author and Moderator. Ensure that there are no Reviewers assigned, which means that only you will see this review. Click 'Save'.
  5. Click the 'Approve' button to issue the review.
  6. A warning message will display, advising you to assign a reviewer. Click the 'Confirm' button to continue.
  7. The 'Review' screen will display with the review in 'under review' status.
  8. You can now add comments and flag defects in the review, as follows:
    • Click a line of code to add a revision comment and/or flag a defect specific to that section.
    • Click the 'Add a new general comment' link to add a comment and/or flag a defect that is applicable to the whole review.

       
      In a review where the author is a different user to the reviewer, the author can respond to any comments by clicking the 'Reply' button on a posted comment.
  9. Click the 'Summarize' button to summarise the review outcomes. The 'Summarize the Review Outcomes' text box will appear with the review in 'summarize' status. This optional step would normally be performed by the review moderator to collate all the review feedback.
  10. Click the 'Close' button on 'Summarize the Review Outcomes' text box to close the review. Your review will also appear as a link in the original issue, if you navigate to the 'Reviews' tab on the issue.

     

You have created your first review in JIRA Studio!

Read more about creating a review and performing a review.


What next?

Now that you have created a project and worked with each of the applications in JIRA Studio, here are a few suggestions of what to do next:


Additional Resources

Looking for more information?

  • Try our online documentation which has more information on all the steps above, plus links to in-depth documentation for each of the JIRA Studio applications.
  • Browse the JIRA Studio general forum.
  • Feel free to contact our support staff, if you need help with a specific problem.

Labels