Project

General

Profile

PluginArchDecisions » History » Version 2

Timothy High, 2010-03-01 06:30

1 1 Timothy High
h1. Redmine Arch Decisions Plugin
2
3
{{>toc}}
4
5
A plugin for tracking technical (AKA Architecture, or "Arch") decisions for a project.
6
7
h2. Author
8
9
* timothy.high
10
11
h2. Changelog
12
13
For the complete changelog see the @README@ file in the Redmine Arch Decisions plugin directory.
14
15
h2. Latest release
16
17 2 Timothy High
The latest release of the plugin is version *0.0.9* (Redmine 0.9.2 compatibility release).
18 1 Timothy High
19
h2. Description
20
21
The Redmine Arch Decisions plugin can be used to track technical decisions (architecture, or "arch" decisions) made as part of a project. It encourages collaboration by the whole team, helps make assumptions and rationale explicit, and helps keep track of which options are being or have been considered. For a more in-depth discussion of the benefits and features of this plugin, see: http://timhigh.wordpress.com/2010/02/23/announcing-the-arch-decisions-plugin-for-redmine/
22
23
h2. Compatibility
24
25 2 Timothy High
This plugin was originally made for Redmine 0.8.4, and up through release 0.0.8 it is best used with that version. 
26
As of release 0.0.9, the "master" branch is certified for use with Redmine 0.9.2 (and is probably not compatible with 0.8.x). 
27
A separate branch ("redmine-0.8.4") has been created for those that wish to use that version. No promises are being made as to whether or not
28
new functionality will be merged to this branch, although bug fixes will for the time being be supported.
29 1 Timothy High
30
h2. Obtaining 
31
32
bq. URL of the GitHub repository: http://github.com/bigokro/redmine_arch_decisions/tree/master
33
34
The source of this plugin can be "cloned" from the GitHub-repo using:<pre>
35
$ cd {RAILS_ROOT}/vendor/plugins
36
$ git clone git://github.com/bigokro/redmine_arch_decisions.git
37
</pre>
38
39
h2. Installation
40
41
# Download the plugin from the available source (see "[[PluginArchDecisions#Obtaining|obtaining]]")
42
# Install the plugin as described at: http://www.redmine.org/wiki/redmine/Plugins (this plugin requires a plugin database migration)
43
# Restart Redmine
44
45
h2. Setup
46
47
After you have completed the installation of the plugin you can select which projects will actually be able to use the feature brought by the plugin by activating the plugin's module in the "project settings":
48
49
In the preferred Redmine project, go to the "Project settings":
50
51
# On the "Modules" tab: enable the plugin-module by checking "Arch Decisions".
52
53
After that, two new tabs named "Arch Decisions" and "Factors" will show up in the project menu.
54
55
You also must configure permissions for users to be able to see, create and modify Arch Decisions and Factors.
56
57
h2. Upgrading
58
59
# Backup the currently deployed Arch Decisions plugin (@cp -r /vendor/plugins/redmine_arch_decisions /vendor/plugins/redmine_arch_decisions-backup@)
60
# Reinstall the updated plugin:
61
** using the command: @git pull@
62
# Migrate the database
63
** using @rake db:migrate_plugins@
64
# Restart your Redmine
65
66
h2. Uninstalling
67
68
# Remove the directory _"redmine_arch_decisions"_ from the plugin-directory _"../vendor/plugins"_
69
# Restart Redmine
70
71
h2. Licensing
72
73
This plugin is open-source and licensed under the MIT License. See the included @LICENSE.txt@ file for details.
74
75
* ©2009-2010, Timothy High (http://timhigh.wordpress.com/)
76
77
h2. Support
78
79
If you would like to report a bug or request a new feature you can open a new issue at the issue-tracking section of the plugin's Redmine site: http://opensource.integritas.com.br/projects/redmine-ad/issues
80
You can also post about the plugin in the dedicated plugin-section of the "Redmine forums": http://www.redmine.org/boards/3/topics/11664