|
JIRA Studio Documentation
|
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:
- 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.

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

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

- 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.
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.
- Navigate to the wiki space for your project by clicking on the 'Wiki' tab in the JIRA Studio header.
- Select 'Add Page' from the 'Add Page' menu in the grey subheader. The 'Add Page' screen will display.

- 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.

- 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,
- Edit the wiki page you have just created, by clicking the 'Edit' tab.
- 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).

- 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.
- Edit the issue that is currently displayed, by clicking the 'Edit' link in the left hand menu.
- 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.

- 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.
- 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]'.
- In JIRA Studio, open the JIRA issue you previously created.
- Click the 'Source' link, in the row of links under the issue's 'Description'.
- An information summary of your source code commit (changeset) will be displayed.

- 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.
|
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.
|
|