RedmineProjectSettings » History » Version 37

Hinako Tajima, 2018-01-17 10:50

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 36 Go MAEDA
Members who have necessary permissions in the project can configure the project on the projects' settings tab.
6 36 Go MAEDA
7 10 Mischa The Evil
h2. Information
8 1 Jean-Philippe Lang
9 1 Jean-Philippe Lang
In this screen you can configure the basic (though important) settings for the selected project.
10 1 Jean-Philippe Lang
11 14 Jean-Philippe Lang
!project-settings_information-tab.jpg!
12 14 Jean-Philippe Lang
13 10 Mischa The Evil
h3. General settings
14 10 Mischa The Evil
15 10 Mischa The Evil
The following general settings are available:
16 33 Ilario Gottardello
* *Name*: project display name.
17 10 Mischa The Evil
18 7 Jean-Philippe Lang
* *Description*: description that appears on the project overview.
19 10 Mischa The Evil
20 32 Patrick O'Keeffe
* *Identifier*: used by the application for various things (eg. in URLs). It must be unique and cannot be composed of only numbers. 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 34 Ilario Gottardello
26 34 Ilario Gottardello
* *Subproject of*: lets you define a parent project to the project being created. Projects can be unlimitedly nested.
27 27 Bruce Svare
28 28 Bruce Svare
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.
29 27 Bruce Svare
30 1 Jean-Philippe Lang
h3. Trackers
31 27 Bruce Svare
32 28 Bruce Svare
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.
33 10 Mischa The Evil
34 28 Bruce Svare
* *Trackers*: select the trackers that you want to use for issues of the project. Only the administrator can define new trackers.
35 10 Mischa The Evil
36 28 Bruce Svare
h3. Custom fields
37 10 Mischa The Evil
38 28 Bruce Svare
* *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]].
39 10 Mischa The Evil
40 28 Bruce Svare
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).
41 28 Bruce Svare
42 1 Jean-Philippe Lang
h2. Modules
43 1 Jean-Philippe Lang
44 28 Bruce Svare
This screen lets you choose the modules you want to use for the project.
45 1 Jean-Philippe Lang
46 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.
47 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.
48 1 Jean-Philippe Lang
49 1 Jean-Philippe Lang
h3. Core modules
50 1 Jean-Philippe Lang
51 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]]
52 1 Jean-Philippe Lang
* Time tracking: provides [[RedmineTimeTracking|Time tracking]] feature
53 19 Mischa The Evil
* News: provides [[RedmineNews|News]] feature
54 1 Jean-Philippe Lang
* Documents: provides [[RedmineDocuments|Documents]] feature
55 1 Jean-Philippe Lang
* Files: provides [[RedmineFiles|Files]] feature
56 27 Bruce Svare
* Wiki: provides [[RedmineWikis|Wiki]] feature
57 19 Mischa The Evil
* Repository: provides [[RedmineRepository|Repository]] feature
58 28 Bruce Svare
* Boards: provides [[RedmineForums|Forum]] feature
59 27 Bruce Svare
* Calendar: provides [[RedmineCalendar|Calendar]] feature
60 27 Bruce Svare
* Gantt: provides [[RedmineGantt|Gantt]] feature
61 1 Jean-Philippe Lang
62 28 Bruce Svare
Additional modules can be added to the system using [[Plugins|Redmine plugins]]. Plugins can only be installed by the administrator.
63 28 Bruce Svare
64 13 Jean-Philippe Lang
h2. Members
65 1 Jean-Philippe Lang
66 28 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 a given project.
67 8 Mischa The Evil
68 1 Jean-Philippe Lang
h2. Versions
69 1 Jean-Philippe Lang
70 28 Bruce Svare
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]].
71 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]].
72 21 Mischa The Evil
73 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]]._
74 1 Jean-Philippe Lang
75 28 Bruce Svare
The following properties are configurable for (each of the) versions:
76 10 Mischa The Evil
* *Name*: The text you want to be displayed to identify the version. _This field is required._
77 1 Jean-Philippe Lang
78 12 Jean-Philippe Lang
* *Description*: A short description to describe the version. _This field is optional._
79 19 Mischa The Evil
80 12 Jean-Philippe Lang
* *Status*: the status lets you control how issues can be assigned to the version:
81 12 Jean-Philippe Lang
82 29 Jean-Philippe Lang
  * open: no restriction (default)
83 29 Jean-Philippe Lang
  * locked: can not assign new issues to the version
84 29 Jean-Philippe Lang
  * closed: can not assign new issues and can not reopen assigned issues
85 10 Mischa The Evil
86 1 Jean-Philippe Lang
* *Wiki Page*: The name of a wikipage assigned to the version. _This field is optional._
87 10 Mischa The Evil
88 35 Go MAEDA
* *Due date*: The due date for the version to be completed. _This field is optional._
89 1 Jean-Philippe Lang
90 1 Jean-Philippe Lang
* *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:
91 19 Mischa The Evil
92 29 Jean-Philippe Lang
  * subprojects: all the descendant projects
93 29 Jean-Philippe Lang
  * projects in the project hierarchy: ancestors + descendants (needs versions management permission on the root project)
94 29 Jean-Philippe Lang
  * projects in the project tree: root project + all its descendants (same as above)
95 29 Jean-Philippe Lang
  * all projects (can be set by admin users only)
96 29 Jean-Philippe Lang
97 1 Jean-Philippe Lang
<pre>
98 19 Mischa The Evil
---------------------------------------------------------------------------------
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 1 Jean-Philippe Lang
|      |     |  |      |     |  |      |     |  |      |     |  |      |     |  |
103 1 Jean-Philippe Lang
|    --X--   X  |    --X--   X  |    --o--   X  |    --o--   X  |    --o--   o  |
104 19 Mischa The Evil
|   /  |  \     |   /  |  \     |   /  |  \     |   /  |  \     |   /  |  \     |
105 31 Jean-Baptiste Barth
|  X   V   X    |  X   V   X    |  X   V   X    |  o   V   o    |  o   V   o    |
106 19 Mischa The Evil
|     / \       |     / \       |     / \       |     / \       |     / \       |
107 1 Jean-Philippe Lang
|    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 1 Jean-Philippe Lang
112 31 Jean-Baptiste Barth
V = project with the shared version
113 19 Mischa The Evil
o = projects that can assign issues to the shared version
114 35 Go MAEDA
X = projects that can't assign issues to the shared version
115 27 Bruce Svare
</pre> Sharing a version of a private project with public projects will make its name visible to everyone.
116 1 Jean-Philippe Lang
117 27 Bruce Svare
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_.
118 9 Felix Dominguez
119 1 Jean-Philippe Lang
h2. Issue categories
120 1 Jean-Philippe Lang
121 10 Mischa The Evil
Issue categories let you to organize issues. Categories can for example correspond to the different components of your project.
122 10 Mischa The Evil
123 28 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.
124 10 Mischa The Evil
125 28 Bruce Svare
The following properties are configurable for (each of the) issue categories:
126 10 Mischa The Evil
* *Name*: The text you want to be displayed to identify the issue category. _This field is required._
127 10 Mischa The Evil
128 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._
129 4 Jean-Philippe Lang
130 18 Mischa The Evil
h2. Wiki
131 1 Jean-Philippe Lang
132 19 Mischa The Evil
Each project can have its own wiki. Enable the [[RedmineProjectSettings#Modules|module]] on the desired project to activate it.
133 18 Mischa The Evil
134 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._
135 1 Jean-Philippe Lang
136 3 Jean-Philippe Lang
h2. Repository
137 10 Mischa The Evil
138 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]].
139 28 Bruce Svare
See [[RedmineRepositories|the following page]] for details about how to configure your repository in Redmine.
140 3 Jean-Philippe Lang
141 4 Jean-Philippe Lang
h2. Forums
142 1 Jean-Philippe Lang
143 28 Bruce Svare
Each project can have one or more discussion forums. Each forum has the following properties:
144 10 Mischa The Evil
* *Name*: The text you want to be displayed to identify the discussion forum. _This field is required._
145 10 Mischa The Evil
146 16 Mischa The Evil
* *Description*: A short description to describe the subject of the specific forum. _This field is required._
147 16 Mischa The Evil
148 16 Mischa The Evil
h2. Activities (time tracking)
149 17 Mischa The Evil
150 37 Hinako Tajima
Among the value of time tracking activities which is registered to [[RedmineEnumerations|Enumerations]] can be excluded when it is not used in the project. 
151 37 Hinako Tajima
152 37 Hinako Tajima
The value which is unchecked "Enabled" on this screen, it is not appear in activities options when entering time log.