Difference between revisions of "Tracker"
Digitalpipe (Talk | contribs) |
Digitalpipe (Talk | contribs) |
||
| Line 52: | Line 52: | ||
Just as with the home page outlined above, all the same icons are available here with the same functionality. Unlike the home page, however, this screen provides the actual tracking of your projects through the use of two sections. The first section we will cover is located in the top half of the screen just under the title bar. If you've ever entered a new issue, the fields in this section will look familiar. Upon changing any of these field values and clicking the 'Save' button ([[Image:save.png]]), the adjustments will be displayed in the table to the right so that people can track the progress of each issue with the most details possible. A more comprehensive overview of each field will be given below. | Just as with the home page outlined above, all the same icons are available here with the same functionality. Unlike the home page, however, this screen provides the actual tracking of your projects through the use of two sections. The first section we will cover is located in the top half of the screen just under the title bar. If you've ever entered a new issue, the fields in this section will look familiar. Upon changing any of these field values and clicking the 'Save' button ([[Image:save.png]]), the adjustments will be displayed in the table to the right so that people can track the progress of each issue with the most details possible. A more comprehensive overview of each field will be given below. | ||
| − | '''Project''' The name of the project that the issue corresponds to. This field is actually non-editable and is displayed for information purposes only. | + | * '''Project''' The name of the project that the issue corresponds to. This field is actually non-editable and is displayed for information purposes only. |
| − | '''Project Version''' This value should pertain to the earliest version of the project that first experienced the issue. | + | * '''Project Version''' This value should pertain to the earliest version of the project that first experienced the issue. |
| − | '''Add-on''' An optional field that indicates the issue pertains to an add-on and not neccessarily with the parent project. | + | * '''Add-on''' An optional field that indicates the issue pertains to an add-on and not neccessarily with the parent project. |
| − | '''Add-on Version''' Another optional field, obviously, that corresponds to the earliest version of the add-on that first experienced the issue. | + | * '''Add-on Version''' Another optional field, obviously, that corresponds to the earliest version of the add-on that first experienced the issue. |
| − | '''Device''' Since user interfaces among various devices typically differ, this field allows identification of the specific device type that is experiencing the issue. Of course, there can be some issues that are independent of the device and as such, there is an 'Independent' value that can be used. | + | * '''Device''' Since user interfaces among various devices typically differ, this field allows identification of the specific device type that is experiencing the issue. Of course, there can be some issues that are independent of the device and as such, there is an 'Independent' value that can be used. |
| − | '''OS''' Just as with the 'Device' field, this value allows the idenfitication of an issue specific with certain operating systems. And also, just like the 'Device' field, there is an 'Independent' value as well. | + | * '''OS''' Just as with the 'Device' field, this value allows the idenfitication of an issue specific with certain operating systems. And also, just like the 'Device' field, there is an 'Independent' value as well. |
| − | '''OS Edition''' Similar to the 'Project Version' and 'Add-on Version' fields, this value should pertain to the earliest edition of the operating system that experiences this issue. | + | * '''OS Edition''' Similar to the 'Project Version' and 'Add-on Version' fields, this value should pertain to the earliest edition of the operating system that experiences this issue. |
| − | '''OS Version''' This field allows for specific versions of an operating system to be identified as having the issue. For example, if 'OS' has a value as 'Windows' and 'OS Edition' contains 'XP', this field can contain something like 'SP3' indicating an overall applicable OS installation of 'Windows XP SP4' is the only version of the operating system that is affected. It is important to note that this field can also be numeric values too. | + | * '''OS Version''' This field allows for specific versions of an operating system to be identified as having the issue. For example, if 'OS' has a value as 'Windows' and 'OS Edition' contains 'XP', this field can contain something like 'SP3' indicating an overall applicable OS installation of 'Windows XP SP4' is the only version of the operating system that is affected. It is important to note that this field can also be numeric values too. |
| + | |||
| + | * '''Kernel''' Included as an optional field, this value indicates that the issue can actually be caused by a bug in the underlying operating system kernel. Just as with all the other version fields, this value needs to identify the earliest version of the kernel that first experienced the issue. | ||
| + | |||
| + | * '''Type''' Use this field to mark the type of issue. While 'bug' and 'feature request' are self explainatory, the 'adjustment' value has been included to indicate that some type of adjustment needs to occur with something that currently exists in the project. | ||
| + | |||
| + | * '''Status''' You will find that this will most likely be one of the most adjusted values per issue with the right-hand table, containing the issues history, having at least four of the six values listed before the issue is resolved. | ||
| + | |||
| + | * '''Severity''' While this is pretty self explainatory, this field contains the level of severity that the issue holds. | ||
| + | |||
| + | * '''Assigned''' This field can be used by a signed-in member to accept responsibilty to resolve the issue or the ability for a superior staff member to assign the issue to a particular person. In either case, an email will be sent to the person listed in this field. | ||
| − | |||
* NOTE for the below section - clicking on the title will allow more viewable area for the bottom part of the screen. | * NOTE for the below section - clicking on the title will allow more viewable area for the bottom part of the screen. | ||
Revision as of 08:36, 11 October 2012
Tracker provides developers an easy way to manage the various aspects of a projects' creation and evolution. Unlike our competition, a single installation of tracker can be used for all projects desired by the development team, all in an easy-to-use interface! As an added benefit, this software can also be used as a way to create and maintain knowledge base (KB) articles for your projects. Below we will outline the functionality of this project so that users and administrators can find answers to any questions they may have.
Contents
Terms
This projects' codebase is licensed under the AGPLv3 unless a valid CPL has been purchased. More information about both of these licenses can be found under the "Our Licenses" link of our homepage.
Installation
Define steps for installation...
User Interface
The user interface of Tracker is broken down into three main screens - home, issue, and administration. Users can only interact with two of the three screens whereas administrators will have access to all. Keeping the number of accessible areas to minimum reduces the complexity of Tracker without compromising the capabilities offered. For an indepth overview of each page, please see the desired section(s) below. It is important to note that if you have any questions about something on any of these pages, try placing the mouse cursor over the desired object to have a brief overview shown.
HOME
The home page allows the user to select which project they would like to investigate by using the listbox in the upper left-hand corner. Upon changing that value, the issues list will populate to show all related issues. To show the details of an issue, click its associated number and another screen will be shown (see ISSUE below). Other functionality is also available on this page and is located in the top, right-hand area. Each will be covered below based on their associated icon.
This icon will ONLY appear for accounts that have logged in successfully and have been marked as an administrator account for the Tracker installation. The information on this page is discussed in more detail in the ADMINISTRATION section below.
Clicking this icon displays a popup box that asks for your account credentials and upon entering the correct information, additional functionality will become available. This icon will also change, after a successful login, to 
.
If you do not have an account, clicking this icon will display a popup that allows you to create one by filling out all of the information on the form and clicking the 'Create' button. As a confirmation step, an email will be sent to the provided address with a link that will need to be accessed in order to complete the creation of the account.
If you do already have an account, and are logged in, the same popup is displayed, but with populated information. You can update any field on that page by replacing the current value with the new one and then clicking the 'Save' button.
Use this icon if you want to inform someone you know about the Tracker project. Simply fill out the name, email address, and optional comment of the person you would like to have contacted on your behalf. It is important to note that none of this information is stored!
If you would like to request a new feature for inclusion into the Tracker project, click this icon to be presented with a popup box requesting the appropriate information to fulfill that request. Not all fields are required, so fill out as much information as you can and then click the 'Save' button.
It's bound to happen, occasionally a bug will appear that needs to be fixed. Use this icon to report such an incident to have our staff look into it as soon as possible. Not all fields are required, so fill out as much information as you can and then click the 'Save' button.
Included with all of our projects, this screen will navigate you to our wiki in order to provide users with the information they need in order to use our products and services. Our wiki will also provide a link to access the related knowledge base articles that discuss and resolve problems associated with the product.
This icon is ONLY shown for logged in users and will allow them to create a new issue for the project currently selected in the upper left-hand corner of the screen. Not all fields are required, so fill out as much information as you can and then click the 'Save' button.
ISSUE
Just as with the home page outlined above, all the same icons are available here with the same functionality. Unlike the home page, however, this screen provides the actual tracking of your projects through the use of two sections. The first section we will cover is located in the top half of the screen just under the title bar. If you've ever entered a new issue, the fields in this section will look familiar. Upon changing any of these field values and clicking the 'Save' button (
), the adjustments will be displayed in the table to the right so that people can track the progress of each issue with the most details possible. A more comprehensive overview of each field will be given below.
- Project The name of the project that the issue corresponds to. This field is actually non-editable and is displayed for information purposes only.
- Project Version This value should pertain to the earliest version of the project that first experienced the issue.
- Add-on An optional field that indicates the issue pertains to an add-on and not neccessarily with the parent project.
- Add-on Version Another optional field, obviously, that corresponds to the earliest version of the add-on that first experienced the issue.
- Device Since user interfaces among various devices typically differ, this field allows identification of the specific device type that is experiencing the issue. Of course, there can be some issues that are independent of the device and as such, there is an 'Independent' value that can be used.
- OS Just as with the 'Device' field, this value allows the idenfitication of an issue specific with certain operating systems. And also, just like the 'Device' field, there is an 'Independent' value as well.
- OS Edition Similar to the 'Project Version' and 'Add-on Version' fields, this value should pertain to the earliest edition of the operating system that experiences this issue.
- OS Version This field allows for specific versions of an operating system to be identified as having the issue. For example, if 'OS' has a value as 'Windows' and 'OS Edition' contains 'XP', this field can contain something like 'SP3' indicating an overall applicable OS installation of 'Windows XP SP4' is the only version of the operating system that is affected. It is important to note that this field can also be numeric values too.
- Kernel Included as an optional field, this value indicates that the issue can actually be caused by a bug in the underlying operating system kernel. Just as with all the other version fields, this value needs to identify the earliest version of the kernel that first experienced the issue.
- Type Use this field to mark the type of issue. While 'bug' and 'feature request' are self explainatory, the 'adjustment' value has been included to indicate that some type of adjustment needs to occur with something that currently exists in the project.
- Status You will find that this will most likely be one of the most adjusted values per issue with the right-hand table, containing the issues history, having at least four of the six values listed before the issue is resolved.
- Severity While this is pretty self explainatory, this field contains the level of severity that the issue holds.
- Assigned This field can be used by a signed-in member to accept responsibilty to resolve the issue or the ability for a superior staff member to assign the issue to a particular person. In either case, an email will be sent to the person listed in this field.
- NOTE for the below section - clicking on the title will allow more viewable area for the bottom part of the screen.
ADMINISTRATION
administration
Knowledge Base (KB)
There are currently no KB articles for this project.
FAQ
There are currently no frequently asked questions.
