PluginBudget » History » Version 1
Eric Davis, 2008-09-10 19:31
Adding first draft of the plugin docs based on it's README
h1. Budget Plugin
Budget is a plugin to manage the set of deliverables for each project, automatically calculating key performance indicators.
* Add new deliverable to a project - Fixed bid or Time Based
* Listing of deliverables on a project
** Column sorting by: ID, Score, Subject, Budget, Spent, Due date, Progress
** Deliverable details
** Link to edit the deliverable
** Link to see the issues assigned to the deliverable, using a issue filter
** Mass assignment of all issues on a specific version to a deliverable
** Button to Delete the deliverable
* Edit a deliverable on a project
* Automatic calculations for deliverables based on the existing Redmine issue and timelog data
* Calculations for the whole project, based on the deliverables
* Flexible role based permissions using Redmine's permissions and roles system
** (none) - Can assign issues to a deliverable and filter on them.
** View - Can see the Budget tab and specific deliverable data: name, dates, progress, total budget
** Manage - Can do everything
* Company defaults for:
** Non billable overhead - in dollars or as a %
** Materials - in dollars or as a %
** Deliverable profit - in dollars or as a %
* Ability to add the Deliverable column to the Main Issues list, including sorting and filtering by Deliverable name
* Adding the billable rate to project members on a per project basis
# Before installing, make sure you are running Redmine after r1796.
# Follow the Redmine plugin installation steps at: http://www.redmine.org/wiki/redmine/Plugins
# Login to your Redmine install as an Administrator
# Enable the permissions for your Roles
# Setup your companies defaults in the Plugins' configuration panel
# Add the "Budget module" to the enabled modules for the projects you want to manage
# The link to the plugin should appear on that project's navigation
h3. Adding deliverables
# Use the "New Deliverable" link on sidebar of the Budget page to add a new deliverable
# The deliverable can be a Fixed Bid or an Hourly deliverable. The type can be changed later.
# Saving the deliverable will add it to the Deliverable list.
h3. Viewing deliverables
# Clicking the pencil icon will drop down the deliverable details, with summary and calculations about the deliverable.
# Links on the left can be used to edit or delete a deliverable and well as view the issue list for the deliverable.
h3. Assignment of an issue to a deliverable
Edit an issue and select the deliverable from the dropdown
h3. Bulk assignment of issues to a deliverable
# Select multiple issues on the issue list
# Right click and select the edit option
# Select the deliverable from the dropdown and save
h3. Bulk Assignment of issues by Version
Issues can be bulk assigned to a deliverable based on a Version.
# Expand the Deliverable to view it
# Select the Version in the drop down box
# Click the Bulk Assign button
# All issues for that version will now be assigned to that Deliverable
This plugin is licensed under the GNU GPL v2. See LICENSE.txt and GPL.txt for details.
h2. Project help
If you need help you can contact the maintainer at his email address (See CREDITS.txt) or create an issue in the Bug Tracker.
h3. Bug tracker
If you would like to report a bug or request a new feature the bug tracker is located at https://projects.littlestreamsoftware.com/projects/show/redmine-budget