This page last changed on Mar 29, 2010 by glionetti.

Welcome to FishEye 101, an introductory guide to FishEye and a tour of the most interesting FishEye features. Use this page to guide your evaluation process or quickly get up to speed with FishEye.

FishEye 101

Thanks for taking the time to try FishEye. To help you make the most of your time, we've taken the liberty of compiling some easy instructions for configuring and using FishEye. 

Software developers are the intended audience for this document.

Getting FishEye up and running

Want to get up and running quickly? Follow these simple steps and you should have FishEye ready to go in no time. Setting up FishEye can take less than half an hour.

Install

First things first, if you haven't already got FishEye up and running carry out the relevant steps below:

For Windows: (click to expand)
For Linux and Mac OS X: (click to expand)

Scan

FishEye's fast performance is built on the way it scans repositories. (click to expand)

Add Users

You can automatically import users from an LDAP directory or similar. (click to expand)

Configure Mail (optional)

Email notifications are a great way to keep up with FishEye activity. (click to expand)

Configure JIRA (optional)

FishEye integrates with JIRA, Atlassian's enterprise issue tracker. (click to expand)

Setup Complete!

Your FishEye instance is now established. (click to expand)


Learning the Basics

FishEye is a tool that lets you view the contents of your Source Code Management (SCM) repository as a web page. In this section you will learn more about understanding the FishEye UI, search options, and notifications.

Browsing your Code Repository

Browsing & History

Power-browse your repository. (click to expand)

Full Source View

View the full source of any file revision. (click to expand)

Changesets & Diffs

See every change and collaborate anywhere on the web. (click to expand)

Filtering the changes made to the source code

Quickly find what you're looking for. (click to expand)


Activity and People

Activity Streams

You can see commits and updates from the users in FishEye rolling by. (click to expand)

Your Personal Dashboard

See your own work at a glance and a stream of work items that are relevant to you. (click to expand)

People Lists

In FishEye, you can view useful updates and statistics from your team. (click to expand)

People Pages

Each person who makes code changes has a page. (click to expand)

Subscribe to SCM Updates

Keep track of FishEye activity when your FishEye session is closed. (click to expand)


Sharing your source

Send Links to Your Code

Everything in FishEye can be linked. (click to expand)


Search

Quick Nav

When you type in the search box, matches are instantly shown below. (click to expand)

Quick Search

FishEye supports some powerful search commands. (click to expand)

Running Queries & EyeQL

You can create complex queries with FishEye's own query language. (click to expand)


Advanced Features

FishEye will allow you to learn more about your code beyond just reading the source. Produce useful reports and charts, integrate with other systems, and much more.

Reports and Charts

Embedded Charts

FishEye now shows charts in various locations. (click to expand)

Custom Charts

You can define specific metrics to be charted within FishEye. (click to expand)

Plugin Reports

FishEye is extensible, allowing you to create your own reports. (click to expand)

Leveraging CSV and the REST API

You can export data and extend FishEye programmatically. (click to expand)


Integrate with other systems

Integrate with JIRA issue tracker

Link your source code to your JIRA issues

Integrate with your favorite IDE

Acess FishEye information from Eclipse, IntelliJ, and Visual Studio


Advanced Features to Try

Advanced Configuration Options

FishEye has bucketloads of configuration options. (click to expand)


Thanks for taking the time to evaluate FishEye using this guide. To help continue your journey, our support staff are always ready to answer your questions in the FishEye Forum, or solve specific problems at our support portal http://support.atlassian.com.

Document generated by Confluence on Jul 29, 2010 02:16