##// END OF EJS Templates
Doc files updated for 0.5.0 release...
Jean-Philippe Lang -
r440:6a8ddc954f05
parent child
Show More
@@ -1,146 +1,172
1 == redMine changelog
1 == redMine changelog
2
2
3 redMine - project management software
3 redMine - project management software
4 Copyright (C) 2006-2007 Jean-Philippe Lang
4 Copyright (C) 2006-2007 Jean-Philippe Lang
5 http://redmine.rubyforge.org/
5 http://redmine.rubyforge.org/
6
6
7
7
8 == xx/xx/2007 v0.4.3
8 == 04/11/2007 v0.5.0
9
9
10 * japanese translation added (thanks to Satoru Kurashiki)
10 * added per project Wiki
11 * added rss/atom feeds at project level (custom queries can be used as feeds)
12 * added search engine (search in issues, news, commits, wiki pages, documents)
13 * simple time tracking functionality added
14 * added version due dates on calendar and gantt
15 * added subprojects issue count on project Reports page
16 * added the ability to copy an existing workflow when creating a new tracker
17 * added the ability to include subprojects on calendar and gantt
18 * added the ability to select trackers to display on calendar and gantt (Jeffrey Jones)
19 * added side by side svn diff view (Cyril Mougel)
20 * added back subproject filter on issue list
21 * added permissions report in admin area
22 * added a status filter on users list
23 * support for password-protected SVN repositories
24 * SVN commits are now stored in the database
25 * added simple svn statistics SVG graphs
26 * progress bars for roadmap versions (Nick Read)
27 * issue history now shows file uploads and deletions
28 * #id patterns are turned into links to issues in descriptions and commit messages
29 * japanese translation added (Satoru Kurashiki)
30 * chinese simplified translation added (Andy Wu)
31 * italian translation added (Alessio Spadaro)
32 * added scripts to manage SVN repositories creation and user access control using ssh+svn (Nicolas Chuche)
33 * better calendar rendering time
34 * fixed migration scripts to work with mysql 5 running in strict mode
11 * fixed: error when clicking "add" with no block selected on my/page_layout
35 * fixed: error when clicking "add" with no block selected on my/page_layout
36 * fixed: hard coded links in navigation bar
37 * fixed: table_name pre/suffix support
12
38
13
39
14 == 02/18/2007 v0.4.2
40 == 02/18/2007 v0.4.2
15
41
16 * Rails 1.2 is now required
42 * Rails 1.2 is now required
17 * settings are now stored in the database and editable through the application in: Admin -> Settings (config_custom.rb is no longer used)
43 * settings are now stored in the database and editable through the application in: Admin -> Settings (config_custom.rb is no longer used)
18 * added project roadmap view
44 * added project roadmap view
19 * mail notifications added when a document, a file or an attachment is added
45 * mail notifications added when a document, a file or an attachment is added
20 * tooltips added on Gantt chart and calender to view the details of the issues
46 * tooltips added on Gantt chart and calender to view the details of the issues
21 * ability to set the sort order for roles, trackers, issue statuses
47 * ability to set the sort order for roles, trackers, issue statuses
22 * added missing fields to csv export: priority, start date, due date, done ratio
48 * added missing fields to csv export: priority, start date, due date, done ratio
23 * added total number of issues per tracker on project overview
49 * added total number of issues per tracker on project overview
24 * all icons replaced (new icons are based on GPL icon set: "KDE Crystal Diamond 2.5" -by paolino- and "kNeu! Alpha v0.1" -by Pablo Fabregat-)
50 * all icons replaced (new icons are based on GPL icon set: "KDE Crystal Diamond 2.5" -by paolino- and "kNeu! Alpha v0.1" -by Pablo Fabregat-)
25 * added back "fixed version" field on issue screen and in filters
51 * added back "fixed version" field on issue screen and in filters
26 * project settings screen split in 4 tabs
52 * project settings screen split in 4 tabs
27 * custom fields screen split in 3 tabs (one for each kind of custom field)
53 * custom fields screen split in 3 tabs (one for each kind of custom field)
28 * multiple issues pdf export now rendered as a table
54 * multiple issues pdf export now rendered as a table
29 * added a button on users/list to manually activate an account
55 * added a button on users/list to manually activate an account
30 * added a setting option to disable "password lost" functionality
56 * added a setting option to disable "password lost" functionality
31 * added a setting option to set max number of issues in csv/pdf exports
57 * added a setting option to set max number of issues in csv/pdf exports
32 * fixed: subprojects count is always 0 on projects list
58 * fixed: subprojects count is always 0 on projects list
33 * fixed: locked users are proposed when adding a member to a project
59 * fixed: locked users are proposed when adding a member to a project
34 * fixed: setting an issue status as default status leads to an sql error with SQLite
60 * fixed: setting an issue status as default status leads to an sql error with SQLite
35 * fixed: unable to delete an issue status even if it's not used yet
61 * fixed: unable to delete an issue status even if it's not used yet
36 * fixed: filters ignored when exporting a predefined query to csv/pdf
62 * fixed: filters ignored when exporting a predefined query to csv/pdf
37 * fixed: crash when french "issue_edit" email notification is sent
63 * fixed: crash when french "issue_edit" email notification is sent
38 * fixed: hide mail preference not saved (my/account)
64 * fixed: hide mail preference not saved (my/account)
39 * fixed: crash when a new user try to edit its "my page" layout
65 * fixed: crash when a new user try to edit its "my page" layout
40
66
41
67
42 == 01/03/2007 v0.4.1
68 == 01/03/2007 v0.4.1
43
69
44 * fixed: emails have no recipient when one of the project members has notifications disabled
70 * fixed: emails have no recipient when one of the project members has notifications disabled
45
71
46
72
47 == 01/02/2007 v0.4.0
73 == 01/02/2007 v0.4.0
48
74
49 * simple SVN browser added (just needs svn binaries in PATH)
75 * simple SVN browser added (just needs svn binaries in PATH)
50 * comments can now be added on news
76 * comments can now be added on news
51 * "my page" is now customizable
77 * "my page" is now customizable
52 * more powerfull and savable filters for issues lists
78 * more powerfull and savable filters for issues lists
53 * improved issues change history
79 * improved issues change history
54 * new functionality: move an issue to another project or tracker
80 * new functionality: move an issue to another project or tracker
55 * new functionality: add a note to an issue
81 * new functionality: add a note to an issue
56 * new report: project activity
82 * new report: project activity
57 * "start date" and "% done" fields added on issues
83 * "start date" and "% done" fields added on issues
58 * project calendar added
84 * project calendar added
59 * gantt chart added (exportable to pdf)
85 * gantt chart added (exportable to pdf)
60 * single/multiple issues pdf export added
86 * single/multiple issues pdf export added
61 * issues reports improvements
87 * issues reports improvements
62 * multiple file upload for issues, documents and files
88 * multiple file upload for issues, documents and files
63 * option to set maximum size of uploaded files
89 * option to set maximum size of uploaded files
64 * textile formating of issue and news descritions (RedCloth required)
90 * textile formating of issue and news descritions (RedCloth required)
65 * integration of DotClear jstoolbar for textile formatting
91 * integration of DotClear jstoolbar for textile formatting
66 * calendar date picker for date fields (LGPL DHTML Calendar http://sourceforge.net/projects/jscalendar)
92 * calendar date picker for date fields (LGPL DHTML Calendar http://sourceforge.net/projects/jscalendar)
67 * new filter in issues list: Author
93 * new filter in issues list: Author
68 * ajaxified paginators
94 * ajaxified paginators
69 * news rss feed added
95 * news rss feed added
70 * option to set number of results per page on issues list
96 * option to set number of results per page on issues list
71 * localized csv separator (comma/semicolon)
97 * localized csv separator (comma/semicolon)
72 * csv output encoded to ISO-8859-1
98 * csv output encoded to ISO-8859-1
73 * user custom field displayed on account/show
99 * user custom field displayed on account/show
74 * default configuration improved (default roles, trackers, status, permissions and workflows)
100 * default configuration improved (default roles, trackers, status, permissions and workflows)
75 * language for default configuration data can now be chosen when running 'load_default_data' task
101 * language for default configuration data can now be chosen when running 'load_default_data' task
76 * javascript added on custom field form to show/hide fields according to the format of custom field
102 * javascript added on custom field form to show/hide fields according to the format of custom field
77 * fixed: custom fields not in csv exports
103 * fixed: custom fields not in csv exports
78 * fixed: project settings now displayed according to user's permissions
104 * fixed: project settings now displayed according to user's permissions
79 * fixed: application error when no version is selected on projects/add_file
105 * fixed: application error when no version is selected on projects/add_file
80 * fixed: public actions not authorized for members of non public projects
106 * fixed: public actions not authorized for members of non public projects
81 * fixed: non public projects were shown on welcome screen even if current user is not a member
107 * fixed: non public projects were shown on welcome screen even if current user is not a member
82
108
83
109
84 == 10/08/2006 v0.3.0
110 == 10/08/2006 v0.3.0
85
111
86 * user authentication against multiple LDAP (optional)
112 * user authentication against multiple LDAP (optional)
87 * token based "lost password" functionality
113 * token based "lost password" functionality
88 * user self-registration functionality (optional)
114 * user self-registration functionality (optional)
89 * custom fields now available for issues, users and projects
115 * custom fields now available for issues, users and projects
90 * new custom field format "text" (displayed as a textarea field)
116 * new custom field format "text" (displayed as a textarea field)
91 * project & administration drop down menus in navigation bar for quicker access
117 * project & administration drop down menus in navigation bar for quicker access
92 * text formatting is preserved for long text fields (issues, projects and news descriptions)
118 * text formatting is preserved for long text fields (issues, projects and news descriptions)
93 * urls and emails are turned into clickable links in long text fields
119 * urls and emails are turned into clickable links in long text fields
94 * "due date" field added on issues
120 * "due date" field added on issues
95 * tracker selection filter added on change log
121 * tracker selection filter added on change log
96 * Localization plugin replaced with GLoc 1.1.0 (iconv required)
122 * Localization plugin replaced with GLoc 1.1.0 (iconv required)
97 * error messages internationalization
123 * error messages internationalization
98 * german translation added (thanks to Karim Trott)
124 * german translation added (thanks to Karim Trott)
99 * data locking for issues to prevent update conflicts (using ActiveRecord builtin optimistic locking)
125 * data locking for issues to prevent update conflicts (using ActiveRecord builtin optimistic locking)
100 * new filter in issues list: "Fixed version"
126 * new filter in issues list: "Fixed version"
101 * active filters are displayed with colored background on issues list
127 * active filters are displayed with colored background on issues list
102 * custom configuration is now defined in config/config_custom.rb
128 * custom configuration is now defined in config/config_custom.rb
103 * user object no more stored in session (only user_id)
129 * user object no more stored in session (only user_id)
104 * news summary field is no longer required
130 * news summary field is no longer required
105 * tables and forms redesign
131 * tables and forms redesign
106 * Fixed: boolean custom field not working
132 * Fixed: boolean custom field not working
107 * Fixed: error messages for custom fields are not displayed
133 * Fixed: error messages for custom fields are not displayed
108 * Fixed: invalid custom fields should have a red border
134 * Fixed: invalid custom fields should have a red border
109 * Fixed: custom fields values are not validated on issue update
135 * Fixed: custom fields values are not validated on issue update
110 * Fixed: unable to choose an empty value for 'List' custom fields
136 * Fixed: unable to choose an empty value for 'List' custom fields
111 * Fixed: no issue categories sorting
137 * Fixed: no issue categories sorting
112 * Fixed: incorrect versions sorting
138 * Fixed: incorrect versions sorting
113
139
114
140
115 == 07/12/2006 - v0.2.2
141 == 07/12/2006 - v0.2.2
116
142
117 * Fixed: bug in "issues list"
143 * Fixed: bug in "issues list"
118
144
119
145
120 == 07/09/2006 - v0.2.1
146 == 07/09/2006 - v0.2.1
121
147
122 * new databases supported: Oracle, PostgreSQL, SQL Server
148 * new databases supported: Oracle, PostgreSQL, SQL Server
123 * projects/subprojects hierarchy (1 level of subprojects only)
149 * projects/subprojects hierarchy (1 level of subprojects only)
124 * environment information display in admin/info
150 * environment information display in admin/info
125 * more filter options in issues list (rev6)
151 * more filter options in issues list (rev6)
126 * default language based on browser settings (Accept-Language HTTP header)
152 * default language based on browser settings (Accept-Language HTTP header)
127 * issues list exportable to CSV (rev6)
153 * issues list exportable to CSV (rev6)
128 * simple_format and auto_link on long text fields
154 * simple_format and auto_link on long text fields
129 * more data validations
155 * more data validations
130 * Fixed: error when all mail notifications are unchecked in admin/mail_options
156 * Fixed: error when all mail notifications are unchecked in admin/mail_options
131 * Fixed: all project news are displayed on project summary
157 * Fixed: all project news are displayed on project summary
132 * Fixed: Can't change user password in users/edit
158 * Fixed: Can't change user password in users/edit
133 * Fixed: Error on tables creation with PostgreSQL (rev5)
159 * Fixed: Error on tables creation with PostgreSQL (rev5)
134 * Fixed: SQL error in "issue reports" view with PostgreSQL (rev5)
160 * Fixed: SQL error in "issue reports" view with PostgreSQL (rev5)
135
161
136
162
137 == 06/25/2006 - v0.1.0
163 == 06/25/2006 - v0.1.0
138
164
139 * multiple users/multiple projects
165 * multiple users/multiple projects
140 * role based access control
166 * role based access control
141 * issue tracking system
167 * issue tracking system
142 * fully customizable workflow
168 * fully customizable workflow
143 * documents/files repository
169 * documents/files repository
144 * email notifications on issue creation and update
170 * email notifications on issue creation and update
145 * multilanguage support (except for error messages):english, french, spanish
171 * multilanguage support (except for error messages):english, french, spanish
146 * online manual in french (unfinished) No newline at end of file
172 * online manual in french (unfinished)
@@ -1,72 +1,71
1 == redMine installation
1 == redMine installation
2
2
3 redMine - project management software
3 redMine - project management software
4 Copyright (C) 2006-2007 Jean-Philippe Lang
4 Copyright (C) 2006-2007 Jean-Philippe Lang
5 http://redmine.rubyforge.org/
5 http://redmine.rubyforge.org/
6
6
7
7
8 == Requirements
8 == Requirements
9
9
10 * Ruby on Rails 1.2.2
10 * Ruby on Rails 1.2.2
11 * Iconv
12 * A database (see compatibility below)
11 * A database (see compatibility below)
13
12
14 Optional:
13 Optional:
15 * RedCloth (to enable textile formatting)
14 * RedCloth (to enable textile formatting)
16 * SVN binaries (needed for repository browsing, must be available in PATH)
15 * SVN binaries (needed for repository browsing, must be available in PATH)
17
16
18 Supported databases:
17 Supported databases:
19 * MySQL (tested with MySQL 5)
18 * MySQL (tested with MySQL 5)
20 * PostgreSQL (tested with PostgreSQL 8.1)
19 * PostgreSQL (tested with PostgreSQL 8.1)
21 * Oracle (tested with Oracle 10g)
20 * Oracle (tested with Oracle 10g)
22 * SQL Server (tested with SQL Server 2005)
21 * SQL Server (tested with SQL Server 2005)
23 * SQLite (tested with SQLite 3)
22 * SQLite (tested with SQLite 3)
24
23
25
24
26 == Installation
25 == Installation
27
26
28 1. Uncompress program archive:
27 1. Uncompress program archive:
29 tar zxvf <filename>
28 tar zxvf <filename>
30
29
31 2. Create an empty database: "redmine" for example
30 2. Create an empty database: "redmine" for example
32
31
33 3. Configure database parameters in config/database.yml
32 3. Configure database parameters in config/database.yml
34 for "production" environment (default database is MySQL)
33 for "production" environment (default database is MySQL)
35
34
36 4. Create the database structure. Under the application main directory:
35 4. Create the database structure. Under the application main directory:
37 rake db:migrate RAILS_ENV="production"
36 rake db:migrate RAILS_ENV="production"
38 It will create tables and an administrator account.
37 It will create tables and an administrator account.
39
38
40 5. Insert default configuration data in database:
39 5. Insert default configuration data in database:
41 rake load_default_data RAILS_ENV="production"
40 rake load_default_data RAILS_ENV="production"
42 It will load default roles, trackers, statuses, workflows and enumerations.
41 It will load default roles, trackers, statuses, workflows and enumerations.
43 This step is optional (but recommended), as you can define your
42 This step is optional (but recommended), as you can define your
44 own configuration from sratch.
43 own configuration from sratch.
45
44
46 6. Test the installation by running WEBrick web server:
45 6. Test the installation by running WEBrick web server:
47 ruby script/server -e production
46 ruby script/server -e production
48
47
49 Once WEBrick has started, point your browser to http://localhost:3000/
48 Once WEBrick has started, point your browser to http://localhost:3000/
50 You should now see the application welcome page
49 You should now see the application welcome page
51
50
52 7. Use default administrator account to log in:
51 7. Use default administrator account to log in:
53 login: admin
52 login: admin
54 password: admin
53 password: admin
55
54
56 8. You can go to "Admin -> Settings" to modify application settings.
55 8. You can go to "Admin -> Settings" to modify application settings.
57
56
58 9. Setup Apache or Lighttpd with fastcgi for best performance.
57 9. Setup Apache or Lighttpd with fastcgi for best performance.
59
58
60
59
61 == SMTP server Configuration
60 == SMTP server Configuration
62
61
63 In config/environment.rb, you can set parameters for your SMTP server:
62 In config/environment.rb, you can set parameters for your SMTP server:
64 config.action_mailer.smtp_settings: SMTP server configuration
63 config.action_mailer.smtp_settings: SMTP server configuration
65 config.action_mailer.perform_deliveries: set to false to disable mail delivering
64 config.action_mailer.perform_deliveries: set to false to disable mail delivering
66
65
67 Don't forget to restart the application after any change.
66 Don't forget to restart the application after any change.
68
67
69
68
70 == Upgrading
69 == Upgrading
71
70
72 See UPGRADING
71 See UPGRADING
@@ -1,63 +1,68
1 == redMine
1 == redMine
2
2
3 redMine - project management software
3 redMine - project management software
4 Copyright (C) 2006-2007 Jean-Philippe Lang
4 Copyright (C) 2006-2007 Jean-Philippe Lang
5 http://redmine.rubyforge.org/
5 http://redmine.rubyforge.org/
6
6
7 == License
7 == License
8
8
9 This program is free software; you can redistribute it and/or
9 This program is free software; you can redistribute it and/or
10 modify it under the terms of the GNU General Public License
10 modify it under the terms of the GNU General Public License
11 as published by the Free Software Foundation; either version 2
11 as published by the Free Software Foundation; either version 2
12 of the License, or (at your option) any later version.
12 of the License, or (at your option) any later version.
13
13
14 This program is distributed in the hope that it will be useful,
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
17 GNU General Public License for more details.
18
18
19 You should have received a copy of the GNU General Public License
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22
22
23
23
24 == Main features
24 == Main features
25
25
26 redMine is a project management software written using Ruby on Rails.
26 redMine is a flexible project management web application written using Ruby on Rails.
27
27
28 * Multiple users/multiple projects
28 * Multiple users/multiple projects
29 * Fully customizable role based access control
29 * Fully customizable role based access control
30 * Issue tracking system
30 * Issue tracking system
31 * Fully customizable workflow
31 * Fully customizable workflow
32 * Documents/files repository
32 * Documents/files repository
33 * News management
33 * News management
34 * Per project Wiki
35 * Time tracking
34 * SVN browser and diff viewer
36 * SVN browser and diff viewer
35 * Email notifications
37 * Email notifications
36 * Custom fields for projects, users and issues
38 * Custom fields for projects, users and issues
37 * Multiple LDAP authentication support
39 * Multiple LDAP authentication support
38 * User self-registration support
40 * User self-registration support
39 * Multilanguage support (english, french, german, spanish)
41 * Multilanguage support
40 * Multiple databases support: MySQL, PostgreSQL, Oracle, SQL Server, SQLite
42 * Multiple databases support
41
43
42
44
43 == User documentation
45 == User documentation
44
46
45 User documentation for redMine is written using DocBook XML format.
47 User documentation for redMine is written using DocBook XML format.
46 It's also avaible as HTML files in /public/manual (contextual help)
48 It's also avaible as HTML files in /public/manual (contextual help)
47
49
48
50
49 == Versioning
51 == Versioning
50
52
51 redMine versioning scheme is major.minor.revision
53 redMine versioning scheme is major.minor.revision
52 Versions before 1.0.0 must be considered as beta versions and upgrading support
54 Versions before 1.0.0 must be considered as beta versions and upgrading support
53 may not be provided for these versions.
55 may not be provided for these versions.
54
56
55
57
56 == Credits
58 == Credits
57
59
58 * Jean-Francois Boutier (spanish translation)
60 * Jean-Francois Boutier (spanish translation)
59 * Andreas Viklund (open source XHTML layout, http://andreasviklund.com/)
61 * Andreas Viklund (open source XHTML layout, http://andreasviklund.com/)
60 * Karim Trott (german translation)
62 * Karim Trott (german translation)
61 * Todd McGrath (help with english translation)
63 * Todd McGrath (help with english translation)
62 * Satoru Kurashiki (japanese translation)
64 * Satoru Kurashiki (japanese translation)
63 * Alessio Spadaro (italian translation)
65 * Alessio Spadaro (italian translation)
66 * Andy Wu (chinese simplified translation)
67 * Thomas L�ber (german translation)
68 * Daniel Weinand (german translation)
General Comments 0
You need to be logged in to leave comments. Login now