RedmineProjectSettings » History » Version 20

Mischa The Evil, 2010-11-15 01:18
Added note about message#19306.

1 1 Jean-Philippe Lang
h1. Project Settings
2 1 Jean-Philippe Lang
3 10 Mischa The Evil
{{>toc}}
4 1 Jean-Philippe Lang
5 10 Mischa The Evil
h2. Information
6 1 Jean-Philippe Lang
7 1 Jean-Philippe Lang
In this screen you can configure the basic (though important) settings for the selected project.
8 1 Jean-Philippe Lang
9 14 Jean-Philippe Lang
!project-settings_information-tab.jpg!
10 14 Jean-Philippe Lang
11 10 Mischa The Evil
h3. General settings
12 10 Mischa The Evil
13 10 Mischa The Evil
The following general settings are available:
14 1 Jean-Philippe Lang
* *Name*: project display name (must be unique).
15 10 Mischa The Evil
16 19 Mischa The Evil
* *Subproject of*: lets you define a parent project to the project being created. Projects can be unlimitedly nested.
17 10 Mischa The Evil
18 7 Jean-Philippe Lang
* *Description*: description that appears on the project overview.
19 10 Mischa The Evil
20 1 Jean-Philippe Lang
* *Identifier*: used by the application for various things (eg. in URLs). It must be unique. Once the project is created, this identifier cannot be modified.
21 1 Jean-Philippe Lang
22 15 Tom Rochette
* *Homepage*: homepage-link that appears on the [[RedmineProjectOverview|project overview]].
23 1 Jean-Philippe Lang
24 1 Jean-Philippe Lang
* *Public*: if checked, the project can be viewed by all the users, including those who are not members of the project. If unchecked, only the project members have access to it, according to their [[RedmineRoles|role]].
25 1 Jean-Philippe Lang
26 19 Mischa The Evil
If there are any [[RedmineCustomFields#Fields-for-Projects|projects custom fields]] configured by the administrator, they'll show up behind the "Public"-setting noted above.
27 10 Mischa The Evil
28 10 Mischa The Evil
h3. Trackers
29 10 Mischa The Evil
30 15 Tom Rochette
Redmine lets you define which of the [[RedmineIssueTrackingSetup#Trackers|configured trackers]] (thus also their respective [[RedmineIssueTrackingSetup#Workflow|workflows]]) you are able to use within this specific project.
31 10 Mischa The Evil
32 1 Jean-Philippe Lang
* *Trackers*: select the trackers that you want to use for issues of the project. Only the administrator can define new trackers.
33 10 Mischa The Evil
34 10 Mischa The Evil
h3. Custom fields
35 10 Mischa The Evil
36 19 Mischa The Evil
* *Custom fields*: select the [[RedmineCustomFields#Fields-for-Issues|issues custom fields]] that you want to use for issues of the project. Only the administrator can define new [[RedmineCustomFields|custom fields]].
37 10 Mischa The Evil
38 10 Mischa The Evil
Note that some of these custom fields can be only configured (e.g. unchecked) if the issue custom field is _not_ defined as a _global_ issue custom field (which can be done by the administrator by checking the "For all projects" checkbox in the custom field create/edit view).
39 10 Mischa The Evil
40 1 Jean-Philippe Lang
h2. Modules
41 1 Jean-Philippe Lang
42 1 Jean-Philippe Lang
This screen lets you choose the modules you want to use for the project. 
43 1 Jean-Philippe Lang
44 1 Jean-Philippe Lang
Disabling a module doesn't delete the associated data. It only prevents users from accessing it. After a module was disabled, it can be re-enabled with all its data.
45 1 Jean-Philippe Lang
You can for example disable 'Issue tracking' module for a single project. Existing issues are not deleted, you will be able to access them if you re-enable the module.
46 1 Jean-Philippe Lang
47 19 Mischa The Evil
h3. Core modules
48 19 Mischa The Evil
49 19 Mischa The Evil
* Issue tracking: provides [[RedmineIssues|Issue tracking]] feature, including [[RedmineProjectSettings#Issue-categories|issue categories]], [[RedmineProjectSettings#Versions|versions]], the [[RedmineRoadmap|Roadmap]] and [[RedmineVersion|version overviews]]
50 19 Mischa The Evil
* Time tracking: provides [[RedmineTimeTracking|Time tracking]] feature
51 19 Mischa The Evil
* News: provides [[RedmineNews|News]] feature
52 19 Mischa The Evil
* Documents: provides [[RedmineDocuments|Documents]] feature
53 19 Mischa The Evil
* Files: provides [[RedmineFiles|Files]] feature
54 19 Mischa The Evil
* Wiki: provides [[RedmineWikis|Wiki]] feature
55 19 Mischa The Evil
* Repository: provides [[RedmineRepository|Repository]] feature
56 19 Mischa The Evil
* Boards: provides [[RedmineForums|Forum]] feature
57 19 Mischa The Evil
* Calendar: provides [[RedmineCalendar|Calendar]] feature
58 19 Mischa The Evil
* Gantt: provides [[RedmineGantt|Gantt]] feature
59 19 Mischa The Evil
60 10 Mischa The Evil
Additional modules can be added to the system using [[Plugins|Redmine plugins]]. Plugins can only be installed by the administrator.
61 1 Jean-Philippe Lang
62 1 Jean-Philippe Lang
h2. Members
63 13 Jean-Philippe Lang
64 10 Mischa The Evil
This screen lets you define project members and their roles. You can add a user or a group, with one or multiple role(s) in a given project.
65 1 Jean-Philippe Lang
66 8 Mischa The Evil
h2. Versions
67 10 Mischa The Evil
68 10 Mischa The Evil
Projects versions allow you to track and plan changes. You can assign issues to versions and then view the list of assigned issues for each version on the [[RedmineRoadmap|roadmap]].
69 9 Felix Dominguez
You can also assign a wikipage to a version which will be added to the [[RedmineRoadmap|roadmap]] and the [[RedmineVersion|version overview]].
70 1 Jean-Philippe Lang
71 20 Mischa The Evil
_Note: before the [[RedmineRoadmap|roadmap]] menu-item shows up in the project-menu you need to have at least one version configured here for each project._
72 20 Mischa The Evil
73 10 Mischa The Evil
The following properties are configurable for (each of the) versions:
74 1 Jean-Philippe Lang
* *Name*: The text you want to be displayed to identify the version. _This field is required._
75 10 Mischa The Evil
76 1 Jean-Philippe Lang
* *Description*: A short description to describe the version. _This field is optional._
77 12 Jean-Philippe Lang
78 19 Mischa The Evil
* *Status*: the status lets you control how issues can be assigned to the version:
79 12 Jean-Philippe Lang
80 12 Jean-Philippe Lang
  * open: no restriction (default)
81 12 Jean-Philippe Lang
  * locked: can not assign new issues to the version
82 1 Jean-Philippe Lang
  * closed: can not assign new issues and can not reopen assigned issues
83 12 Jean-Philippe Lang
84 10 Mischa The Evil
85 1 Jean-Philippe Lang
* *Wiki Page*: The name of a wikipage assigned to the version. _This field is optional._
86 10 Mischa The Evil
87 1 Jean-Philippe Lang
* *Date*: The due date for the version to be completed. _This field is optional._
88 1 Jean-Philippe Lang
89 19 Mischa The Evil
* *Sharing*: this option lets you share the version with other projects, so that issues from these other projects can be assigned to the shared versions. Each version can be shared with:
90 1 Jean-Philippe Lang
91 1 Jean-Philippe Lang
  * subprojects: all the descendant projects
92 1 Jean-Philippe Lang
  * projects in the project hierarchy: ancestors + descendants (needs versions management permission on the root project)
93 1 Jean-Philippe Lang
  * projects in the project tree: root project + all its descendants (same as above)
94 1 Jean-Philippe Lang
  * all projects (can be set by admin users only)
95 19 Mischa The Evil
<pre>
96 19 Mischa The Evil
---------------------------------------------------------------------------------
97 19 Mischa The Evil
| None          | Subprojects   | Hierarchy     | Tree          | All projects  |
98 19 Mischa The Evil
|               |               |               |               |               |
99 19 Mischa The Evil
|      X     X  |      X     X  |      o     X  |      o     X  |      o     o  |
100 19 Mischa The Evil
|      |     |  |      |     |  |      |     |  |      |     |  |      |     |  |
101 19 Mischa The Evil
|    --X--   X  |    --X--   X  |    --o--   X  |    --o--   X  |    --o--   o  |
102 19 Mischa The Evil
|   /  |  \     |   /  |  \     |   /  |  \     |   /  |  \     |   /  |  \     |
103 19 Mischa The Evil
|  X   O   X    |  X   O   X    |  X   O   X    |  o   O   o    |  o   O   o    |
104 19 Mischa The Evil
|     / \       |     / \       |     / \       |     / \       |     / \       |
105 19 Mischa The Evil
|    X   X      |    o   o      |    o   o      |    o   o      |    o   o      |
106 19 Mischa The Evil
|   /           |   /           |   /           |   /           |   /           |
107 19 Mischa The Evil
|  X            |  o            |  o            |  o            |  o            |
108 19 Mischa The Evil
---------------------------------------------------------------------------------
109 12 Jean-Philippe Lang
110 19 Mischa The Evil
O = project with the shared version
111 19 Mischa The Evil
o = projects that can assign issues to the shared version
112 19 Mischa The Evil
X = projects that can't assigne issues to the shared version
113 19 Mischa The Evil
</pre> Sharing a version of a private project with public projects will make its name visible to everyone.
114 1 Jean-Philippe Lang
115 1 Jean-Philippe Lang
From the versions list, you can click on *Close completed versions* to automatically set the status of all the completed versions (due date reached and no open issues) to _closed_.
116 9 Felix Dominguez
117 1 Jean-Philippe Lang
h2. Issue categories
118 15 Tom Rochette
119 10 Mischa The Evil
Issue categories let you to organize issues. Categories can for example correspond to the different components of your project.
120 10 Mischa The Evil
121 1 Jean-Philippe Lang
You are able to configure your own set of issue categories for each individual project. It is also possible to auto-assign new issues to a specific user based on the chosen category of the newly created issues.
122 10 Mischa The Evil
123 1 Jean-Philippe Lang
The following properties are configurable for (each of the) issue categories:
124 10 Mischa The Evil
* *Name*: The text you want to be displayed to identify the issue category. _This field is required._
125 10 Mischa The Evil
126 3 Jean-Philippe Lang
* *Assigned to*: The project member to who you want to auto-assign newly created issues in this category. _This field is optional._
127 4 Jean-Philippe Lang
128 18 Mischa The Evil
h2. Wiki
129 1 Jean-Philippe Lang
130 19 Mischa The Evil
Each project can have its own wiki. Enable the [[RedmineProjectSettings#Modules|module]] on the desired project to activate it.
131 18 Mischa The Evil
132 19 Mischa The Evil
* *Start page*: This page is used as the start page for the wiki in both the project menu wiki link as well as in the start page link in the [[RedmineWikis#Sidebar|wiki sidebar]] (default: 'Wiki'). _This field is required._
133 1 Jean-Philippe Lang
134 3 Jean-Philippe Lang
h2. Repository
135 10 Mischa The Evil
136 10 Mischa The Evil
A SCM repository can be associated with each project. Once the repository is configured, you can browse it and view the changesets. The changesets also appear in the [[RedmineProjectActivity|Activity view]].
137 3 Jean-Philippe Lang
See [[RedmineRepositories|the following page]] for details about how to configure your repository in Redmine.
138 3 Jean-Philippe Lang
139 4 Jean-Philippe Lang
h2. Forums
140 10 Mischa The Evil
141 10 Mischa The Evil
Each project can have one or more discussion forums. Each forum has the following properties:
142 10 Mischa The Evil
* *Name*: The text you want to be displayed to identify the discussion forum. _This field is required._
143 10 Mischa The Evil
144 16 Mischa The Evil
* *Description*: A short description to describe the subject of the specific forum. _This field is required._
145 16 Mischa The Evil
146 16 Mischa The Evil
h2. Activities (time tracking)
147 17 Mischa The Evil
148 1 Jean-Philippe Lang
TODO