Redmine

h1. Redmine Arch Decisions Plugin

{{>toc}}

A plugin for tracking technical (AKA Architecture, or "Arch") decisions for a project.

h2. Author

* timothy.high

h2. Changelog

For the complete changelog see the @README@ file in the Redmine Arch Decisions plugin directory.

h2. Latest release

The latest release of the plugin is version *0.0.9* (Redmine 0.9.2 compatibility release).

h2. Description

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/

h2. Compatibility

This plugin was originally made for Redmine 0.8.4, and up through release 0.0.8 it is best used with that version. 

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). 

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

new functionality will be merged to this branch, although bug fixes will for the time being be supported.

h2. Obtaining 

bq. URL of the GitHub repository: http://github.com/bigokro/redmine_arch_decisions/tree/master

The source of this plugin can be "cloned" from the GitHub-repo using:<pre>

$ cd {RAILS_ROOT}/vendor/plugins

$ git clone git://github.com/bigokro/redmine_arch_decisions.git

</pre>

h2. Installation

# Download the plugin from the available source (see "[[PluginArchDecisions#Obtaining|obtaining]]")

# Install the plugin as described at: http://www.redmine.org/wiki/redmine/Plugins (this plugin requires a plugin database migration)

# Restart Redmine

h2. Setup

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":

In the preferred Redmine project, go to the "Project settings":

# On the "Modules" tab: enable the plugin-module by checking "Arch Decisions".

After that, two new tabs named "Arch Decisions" and "Factors" will show up in the project menu.

You also must configure permissions for users to be able to see, create and modify Arch Decisions and Factors.

h2. Upgrading

# Backup the currently deployed Arch Decisions plugin (@cp -r /vendor/plugins/redmine_arch_decisions /vendor/plugins/redmine_arch_decisions-backup@)

# Reinstall the updated plugin:

** using the command: @git pull@

# Migrate the database

** using @rake db:migrate_plugins@

# Restart your Redmine

h2. Uninstalling

# Remove the directory _"redmine_arch_decisions"_ from the plugin-directory _"../vendor/plugins"_

# Restart Redmine

h2. Licensing

This plugin is open-source and licensed under the MIT License. See the included @LICENSE.txt@ file for details.

* ©2009-2010, Timothy High (http://timhigh.wordpress.com/)

h2. Support

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

You can also post about the plugin in the dedicated plugin-section of the "Redmine forums": http://www.redmine.org/boards/3/topics/11664