Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

[#4665] Adding docs

  • Loading branch information...
commit 957c7e6b2949cb9b728954a73737d9411f14e545 1 parent 2ed73c8
Eric Davis authored

Showing 2 changed files with 14 additions and 11 deletions. Show diff stats Hide diff stats

  1. +8 5 README.rdoc
  2. +6 6 init.rb
13 README.rdoc
Source Rendered
@@ -4,22 +4,25 @@ Automatically close old issues
4 4
5 5 == Features
6 6
7   -TODO: fill in features
  7 +* Automatically close dormant issues
  8 +* Warn when issues are becoming dormant
  9 +* Scriptable rake task to close and warn issues (usable through cron)
  10 +* Configurable warning and closing messages
8 11
9 12 == Getting the plugin
10 13
11 14 A copy of the plugin can be downloaded from {Little Stream Software}[https://projects.littlestreamsoftware.com/projects/chiliproject_auto_close/files] or from {GitHub}[http://github.com/edavis10/chiliproject_auto_close]
12 15
13   -
14 16 == Installation and Setup
15 17
16 18 1. Follow the Redmine plugin installation steps at: http://www.redmine.org/wiki/redmine/Plugins
17   -2. Run the plugin migrations +rake db:migrate_plugins+
18   -3. Restart your Redmine web servers (e.g. mongrel, thin, mod_rails)
  19 +2. Restart your Redmine web servers (e.g. mongrel, thin, mod_rails)
19 20
20 21 == Usage
21 22
22   -TODO: Add usage
  23 +Configure your warning and closing messages in the plugin configuration panel (Admin > Plugins > Configure). These will be the notes that are posted to an issue when it is about to be closed and when it's closed.
  24 +
  25 +Run (or schedule) the "auto_close:close" rake task to check every issue if it needs to be closed. You can pass in options to control the number of days before a warning or closure as well as limit the issue statuses affected. Run "rake -D auto_close:close" for the full documentation, default options, and more examples.
23 26
24 27 == License
25 28
12 init.rb
... ... @@ -1,12 +1,12 @@
1 1 require 'redmine'
2 2
3 3 Redmine::Plugin.register :chiliproject_auto_close do
4   - name 'Chiliproject Auto Close plugin'
5   - author 'Author name'
6   - description 'This is a plugin for ChiliProject'
7   - version '0.0.1'
8   - url 'http://example.com/path/to/plugin'
9   - author_url 'http://example.com/about'
  4 + name 'Auto Close'
  5 + author 'Eric Davis'
  6 + url 'https://projects.littlestreamsoftware.com/projects/chiliproject_auto_close'
  7 + author_url 'http://www.littlestreamsoftware.com'
  8 + description 'Automatically close old issues'
  9 + version '0.1.0'
10 10
11 11 settings(:partial => 'settings/auto_close',
12 12 :default => {

0 comments on commit 957c7e6

Please sign in to comment.
Something went wrong with that request. Please try again.