RedmineProjectSettings » History » Version 27

Bruce Svare, 2012-11-13 16:48

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 27 Bruce Svare
* *Name*: project display name. It must be unique.
15 10 Mischa The Evil
16 27 Bruce Svare
* *Subproject of*: lets you define a parent project to the project being created. Projects can be nested. You can only assign a project parent if you also have access to that parent.
17 10 Mischa The Evil
18 7 Jean-Philippe Lang
* *Description*: description that appears on the project overview.
19 10 Mischa The Evil
20 27 Bruce Svare
* *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. This autofills in when the project is created and a name is given.
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 27 Bruce Svare
* *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]]. By default, all projects are private.
25 1 Jean-Philippe Lang
26 27 Bruce Svare
* *Project Number*: the project number for easy storage and remembering.
27 1 Jean-Philippe Lang
28 27 Bruce Svare
* *Default Assignee*: if there's only going to be one person working on the project, they can be listed here to have all issues automatically assigned to them.
29 27 Bruce Svare
30 15 Tom Rochette
h3. Trackers
31 10 Mischa The Evil
32 27 Bruce Svare
* *Trackers*: select the trackers that you want to use for issues of the project. Only administrators can define new trackers.
33 10 Mischa The Evil
34 27 Bruce Svare
h3. Custom Fields
35 10 Mischa The Evil
36 27 Bruce Svare
* *Custom fields*: select the custom fields that you want to use for issues of the project. Only the administrator can define new custom fields.
37 10 Mischa The Evil
38 27 Bruce Svare
Note that some of these custom fields can not be removed as they are set to global scope.
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 22 Dave Clements
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 1 Jean-Philippe Lang
h3. Core modules
48 1 Jean-Philippe Lang
49 1 Jean-Philippe Lang
* Issue tracking: provides [[RedmineIssues|Issue tracking]] feature, including [[RedmineProjectSettings#Issue-categories|issue categories]], [[RedmineProjectSettings#Versions|versions]], the [[RedmineRoadmap|Roadmap]] and [[RedmineVersion|version overviews]]
50 1 Jean-Philippe Lang
* Time tracking: provides [[RedmineTimeTracking|Time tracking]] feature
51 1 Jean-Philippe Lang
* News: provides [[RedmineNews|News]] feature
52 1 Jean-Philippe Lang
* 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 1 Jean-Philippe Lang
* Repository: provides [[RedmineRepository|Repository]] feature
56 27 Bruce Svare
* Forums: 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 27 Bruce Svare
* Banner: provides [[RedmineBanner|Banner]] feature
60 27 Bruce Svare
* Groups: provides [[RedmineGroups|Groups]] feature
61 27 Bruce Svare
* Redmine timetracker plugin settings: provides [[RedmineTaskTimer|Task Timing]] feature
62 27 Bruce Svare
* Stuff to do: provides [[RedmineStuffToDo|Stuff to Do]] feature
63 27 Bruce Svare
* System notification: provides [[RedmineSystemNotification|System Notification]] feature
64 1 Jean-Philippe Lang
65 13 Jean-Philippe Lang
h2. Members
66 1 Jean-Philippe Lang
67 27 Bruce Svare
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 the project.
68 8 Mischa The Evil
69 10 Mischa The Evil
h2. Versions
70 10 Mischa The Evil
71 27 Bruce Svare
Projects versions allow you to track and plan changes. They are listed alphabetically. You can assign issues to versions and then view the list of assigned issues for each version on the [[RedmineRoadmap|roadmap]].
72 1 Jean-Philippe Lang
You can also assign a wikipage to a version which will be added to the [[RedmineRoadmap|roadmap]] and the [[RedmineVersion|version overview]].
73 21 Mischa The Evil
74 10 Mischa The Evil
_Note: the [[RedmineRoadmap|roadmap]] menu-item shows up in the project-menu only when the issue tracking [[RedmineProjectSettings#Core-modules|module]] is enabled for the project and at least one [[RedmineProjectSettings#Versions|version]] is configured in the [[RedmineProjectSettings|projects settings]]._
75 1 Jean-Philippe Lang
76 27 Bruce Svare
The following properties are configurable for each version:
77 10 Mischa The Evil
* *Name*: The text you want to be displayed to identify the version. _This field is required._
78 1 Jean-Philippe Lang
79 12 Jean-Philippe Lang
* *Description*: A short description to describe the version. _This field is optional._
80 19 Mischa The Evil
81 12 Jean-Philippe Lang
* *Status*: the status lets you control how issues can be assigned to the version:
82 12 Jean-Philippe Lang
83 12 Jean-Philippe Lang
  * open: no restriction (default)
84 1 Jean-Philippe Lang
  * locked: can not assign new issues to the version
85 27 Bruce Svare
  * closed: can not assign new issues and can not reopen assigned issues. Appears as a closed issue on the [[RedmineRoadmap|roadmap]].
86 10 Mischa The Evil
87 1 Jean-Philippe Lang
* *Wiki Page*: The name of a wikipage assigned to the version. _This field is optional._
88 10 Mischa The Evil
89 1 Jean-Philippe Lang
* *Date*: The due date for the version to be completed. _This field is optional._
90 1 Jean-Philippe Lang
91 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:
92 1 Jean-Philippe Lang
93 1 Jean-Philippe Lang
  * subprojects: all the descendant projects
94 1 Jean-Philippe Lang
  * projects in the project hierarchy: ancestors + descendants (needs versions management permission on the root project)
95 27 Bruce Svare
  * projects in the project tree: root project + all its descendants (needs versions management permission on the root project)
96 1 Jean-Philippe Lang
  * all projects (can be set by admin users only)
97 1 Jean-Philippe Lang
<pre>
98 1 Jean-Philippe Lang
---------------------------------------------------------------------------------
99 19 Mischa The Evil
| None          | Subprojects   | Hierarchy     | Tree          | All projects  |
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--   X  |    --X--   X  |    --o--   X  |    --o--   X  |    --o--   o  |
104 1 Jean-Philippe Lang
|   /  |  \     |   /  |  \     |   /  |  \     |   /  |  \     |   /  |  \     |
105 1 Jean-Philippe Lang
|  X   O   X    |  X   O   X    |  X   O   X    |  o   O   o    |  o   O   o    |
106 19 Mischa The Evil
|     / \       |     / \       |     / \       |     / \       |     / \       |
107 19 Mischa The Evil
|    X   X      |    o   o      |    o   o      |    o   o      |    o   o      |
108 19 Mischa The Evil
|   /           |   /           |   /           |   /           |   /           |
109 19 Mischa The Evil
|  X            |  o            |  o            |  o            |  o            |
110 19 Mischa The Evil
---------------------------------------------------------------------------------
111 19 Mischa The Evil
112 19 Mischa The Evil
O = project with the shared version
113 12 Jean-Philippe Lang
o = projects that can assign issues to the shared version
114 19 Mischa The Evil
X = projects that can't assigne issues to the shared version
115 19 Mischa The Evil
</pre> Sharing a version of a private project with public projects will make its name visible to everyone.
116 19 Mischa The Evil
117 27 Bruce Svare
* *ECO#*: The ECO Number assigned to this version. _This field is optional._
118 27 Bruce Svare
119 9 Felix Dominguez
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_.
120 1 Jean-Philippe Lang
121 1 Jean-Philippe Lang
h2. Issue categories
122 15 Tom Rochette
123 10 Mischa The Evil
Issue categories let you to organize issues. Categories can for example correspond to the different components of your project.
124 10 Mischa The Evil
125 27 Bruce Svare
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. Categories are listed alphabetically.
126 10 Mischa The Evil
127 27 Bruce Svare
The following properties are configurable for each issue category:
128 10 Mischa The Evil
* *Name*: The text you want to be displayed to identify the issue category. _This field is required._
129 10 Mischa The Evil
130 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._
131 4 Jean-Philippe Lang
132 18 Mischa The Evil
h2. Wiki
133 1 Jean-Philippe Lang
134 19 Mischa The Evil
Each project can have its own wiki. Enable the [[RedmineProjectSettings#Modules|module]] on the desired project to activate it.
135 18 Mischa The Evil
136 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._
137 1 Jean-Philippe Lang
138 3 Jean-Philippe Lang
h2. Repository
139 10 Mischa The Evil
140 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]].
141 27 Bruce Svare
See [[RedmineRepositories|Repositories]] for details about how to configure your repository in Redmine.
142 3 Jean-Philippe Lang
143 4 Jean-Philippe Lang
h2. Forums
144 10 Mischa The Evil
145 27 Bruce Svare
Each project can have one or more discussion forums. The forums can be arranged in any order. Each forum has the following properties:
146 10 Mischa The Evil
* *Name*: The text you want to be displayed to identify the discussion forum. _This field is required._
147 10 Mischa The Evil
148 16 Mischa The Evil
* *Description*: A short description to describe the subject of the specific forum. _This field is required._
149 16 Mischa The Evil
150 16 Mischa The Evil
h2. Activities (time tracking)
151 17 Mischa The Evil
152 1 Jean-Philippe Lang
TODO