PluginBudget » History » Version 1

Eric Davis, 2008-09-10 19:31
Adding first draft of the plugin docs based on it's README

1 1 Eric Davis
h1. Budget Plugin
2 1 Eric Davis
3 1 Eric Davis
Budget is a plugin to manage the set of deliverables for each project, automatically calculating key performance indicators.
4 1 Eric Davis
5 1 Eric Davis
h2. Features
6 1 Eric Davis
7 1 Eric Davis
* Add new deliverable to a project - Fixed bid or Time Based
8 1 Eric Davis
** New issues appended using JavaScript to the top of the deliverables list
9 1 Eric Davis
** Clearing the New Deliverable form after a successful save using JavaScript
10 1 Eric Davis
* Listing of deliverables on a project
11 1 Eric Davis
** Column sorting by: ID, Score, Subject, Budget, Spent, Due date, Progress
12 1 Eric Davis
* JavaScript drop down panel for each deliverable displaying
13 1 Eric Davis
** Deliverable details
14 1 Eric Davis
** Link to edit the deliverable
15 1 Eric Davis
** Link to see the issues assigned to the deliverable, using a issue filter
16 1 Eric Davis
** Mass assignment of all issues on a specific version to a deliverable
17 1 Eric Davis
** Button to Delete the deliverable
18 1 Eric Davis
* Edit a deliverable on a project
19 1 Eric Davis
* Automatic calculations for deliverables based on the existing Redmine issue and timelog data
20 1 Eric Davis
* Calculations for the whole project, based on the deliverables
21 1 Eric Davis
* Flexible role based permissions using Redmine's permissions and roles system
22 1 Eric Davis
** (none) - Can assign issues to a deliverable and filter on them. 
23 1 Eric Davis
** View - Can see the Budget tab and specific deliverable data: name, dates, progress, total budget 
24 1 Eric Davis
** Manage - Can do everything 
25 1 Eric Davis
* Company defaults for:
26 1 Eric Davis
** Non billable overhead - in dollars or as a %
27 1 Eric Davis
** Materials - in dollars or as a %
28 1 Eric Davis
** Deliverable profit - in dollars or as a %
29 1 Eric Davis
* Ability to add the Deliverable column to the Main Issues list, including sorting and filtering by Deliverable name
30 1 Eric Davis
* Adding the billable rate to project members on a per project basis
31 1 Eric Davis
32 1 Eric Davis
h2. Install
33 1 Eric Davis
34 1 Eric Davis
# Before installing, make sure you are running Redmine after r1796.
35 1 Eric Davis
# Follow the Redmine plugin installation steps at: http://www.redmine.org/wiki/redmine/Plugins
36 1 Eric Davis
# Login to your Redmine install as an Administrator
37 1 Eric Davis
# Enable the permissions for your Roles
38 1 Eric Davis
# Setup your companies defaults in the Plugins' configuration panel
39 1 Eric Davis
# Add the "Budget module" to the enabled modules for the projects you want to manage
40 1 Eric Davis
# The link to the plugin should appear on that project's navigation
41 1 Eric Davis
42 1 Eric Davis
h2. Usage
43 1 Eric Davis
44 1 Eric Davis
h3.  Adding deliverables
45 1 Eric Davis
46 1 Eric Davis
# Use the "New Deliverable" link on sidebar of the Budget page to add a new deliverable
47 1 Eric Davis
# The deliverable can be a Fixed Bid or an Hourly deliverable.  The type can be changed later.
48 1 Eric Davis
# Saving the deliverable will add it to the Deliverable list.
49 1 Eric Davis
50 1 Eric Davis
h3.  Viewing deliverables
51 1 Eric Davis
52 1 Eric Davis
# Clicking the pencil icon will drop down the deliverable details, with summary and calculations about the deliverable.
53 1 Eric Davis
# Links on the left can be used to edit or delete a deliverable and well as view the issue list for the deliverable.
54 1 Eric Davis
55 1 Eric Davis
h3.  Assignment of an issue to a deliverable
56 1 Eric Davis
57 1 Eric Davis
Edit an issue and select the deliverable from the dropdown
58 1 Eric Davis
59 1 Eric Davis
h3.  Bulk assignment of issues to a deliverable
60 1 Eric Davis
61 1 Eric Davis
# Select multiple issues on the issue list
62 1 Eric Davis
# Right click and select the edit option
63 1 Eric Davis
# Select the deliverable from the dropdown and save
64 1 Eric Davis
65 1 Eric Davis
h3.  Bulk Assignment of issues by Version
66 1 Eric Davis
67 1 Eric Davis
Issues can be bulk assigned to a deliverable based on a Version.
68 1 Eric Davis
69 1 Eric Davis
# Expand the Deliverable to view it
70 1 Eric Davis
# Select the Version in the drop down box
71 1 Eric Davis
# Click the Bulk Assign button
72 1 Eric Davis
# All issues for that version will now be assigned to that Deliverable
73 1 Eric Davis
74 1 Eric Davis
h2. License
75 1 Eric Davis
76 1 Eric Davis
This plugin is licensed under the GNU GPL v2.  See LICENSE.txt and GPL.txt for details.
77 1 Eric Davis
78 1 Eric Davis
h2. Project help
79 1 Eric Davis
80 1 Eric Davis
If you need help you can contact the maintainer at his email address (See CREDITS.txt) or create an issue in the Bug Tracker.
81 1 Eric Davis
82 1 Eric Davis
h3.  Bug tracker
83 1 Eric Davis
84 1 Eric Davis
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