add tooltips to create feature page
[opensuse:openfate.git] / app / views / documentation / index.html.erb
1 <% @page_title = "Documentation" %>
2
3
4 <h2><%= @appname %> documentation</h2>
5
6 <p>
7 <%= @appname %> is the community interface to the SUSE Linux feature database. Everyone who 
8 wants to request a feature for the SUSE Linux common codebase should use <%= @appname %> to submit the proposed feature for evaluation and planning. 
9 If the feature is approved for inclusion in the release, Fate tracks the development and testing of that feature.
10 </p><p>
11 Please also read our <%= link_to 'FAQ', {:controller => "documentation", :action => "faq"} %> page. 
12 </p>
13
14
15
16 <h2>Using <%= @appname %></h2>
17
18
19 <h3>What is a Feature? </h3>
20
21 <p>
22 A feature is a well-defined part or aspect of the openSUSE system that
23 should be added, changed, or even removed.  For example, features are
24 change proposals concerning
25
26 <ul><li> the colors of the desktop theme and the wallpaper, </li>
27 <li> the default editor, or </li>
28 <li> isolated improvements of the system installation process. </li></ul>
29
30 In other words, features are proposals you would like to see implemented
31 to make openSUSE a better openSUSE.  Of course, many of these features 
32 are a matter of taste -- thus don't be disappointed if your feature gets
33 rejected. To avoid this you should describe the requested feature as 
34 understandable as possible and always talk about the benefit of the
35 feature for the user.
36
37 Do not confuse features with bugs.  Bugs are defects in existing products. 
38 They are  existing features that do not work as intended.  Bugs should be 
39 reported in the openSUSE Bugzilla at <%= link_to "https://bugzilla.novell.com", "https://bugzilla.novell.com" %>.
40 </p>
41
42 <h3>Creating a Feature</h3>
43
44 <p>
45 All openSUSE members are empowered to create feature.  Proceed as
46 follows:
47
48 <ul>
49 <li> At <a href="http://features.opensuse.org">http://features.opensuse.org</a>, click Create.</li>
50 <li> Enter a short Title such as ''Adjust Colors of the Default Desktop Wallpaper''.</li>
51 <li> Select the Product, for example openSUSE-11.2</li>
52 <li> You can leave the Priority untouched.</li>
53 <li> Add a concise Description, for example:
54   <pre>In GNOME, the color of the default desktop theme and the colors of the default wallpaper do not fit.  Especially look at the title bar of the active window.</pre></li>
55 <li> Depending on the kind of the feature, add a Usecase and a Testcase by clicking on Add a Usecase and Add a Testcase.</li>
56 <li> Finally click Save feature.</li>
57 </ul>
58 </p>
59
60
61
62 <h3>How Does the Feature Process Work? </h3>
63
64 <p>
65 Creating a Feature usually is the initial step.  Then a discussion and
66 decision round starts.  All people who can contribute input to the topic
67 are asked to add comments. Important persons are for example teamleads
68 and developer who have to add technical details and development time
69 estimates. Interested people can add themself to the feature to stay
70 in the loop. Fate knows about all these roles.</p>
71
72 <p>The discussion and feature refinement phase is meant to give the
73 responsible people, that is the product and the technical project
74 manager for the product, the base for a good decision about the
75 feature. They give the result of their decision a so called 
76 priority.</p>
77
78 <p>
79 These are the available priorities:
80
81
82 <ul><li><b>Neutral:</b> No opinion for any reason.</li>
83 <li><b>Desirable</b>: The feature should be in the product if it is a low-hanging fruit.</li>
84 <li><b>Important:</b> The product would lack important functionality without this feature.</li>
85 <li><b>Mandatory:</b> Missing this feature is a showstopper.</li></ul>
86
87
88 There is the field state that reflects the actual state of the feature
89 in the process. The feature starts in the NEW or UNCONFIRMNED state
90 until somebody adds a bunch of responsible people to it and puts it into
91 one of the evaluation states. The evaluation states give people time to
92 come to a decision.  Finally the feature goes into the status either
93 "Candidate" which means it is accepted and worked on or "Rejected" which
94 means that the feature is not considered for that product.
95 </p><p>
96 It is important to understand that priorities and status<!--with a long "u";
97 "stati" is not properly Latin ;) --> are set on 
98 a per-product base. That means that even if a feature is rejected for
99 product A it might show up in product B. This is one of the big benefits of
100 Fate over other methods to track these requests like in Bugzilla.
101 </p>
102
103 <h3>How is the Process Opened?</h3>
104
105 <p>
106 The feature core data, discussions and status values are browseable.
107 Comments can be added by everybody with an openSUSE login.
108 </p>
109
110 <h2>Browsing and Commenting the Feature Database</h2>
111
112 <h3>Finding a Feature</h3>
113
114 <ul><li> At <%= link_to "http://features.opensuse.org", "http://features.opensuse.org" %>, click Browse.</li>
115 <li> Specify search criteria.  For example, a keyword such as "color" in the Title/Description contains field.  Or, if you are interested in all done features for a product, for example select "openSUSE-11.2" in the Product(s) list and "done" in the Status field.</li>
116 <li> Click Search.</li></ul>
117 <p>
118 If you know the feature ID, enter the ID in the upper right field and
119 click the search symbol.
120 </p>
121
122 <h3>Commenting a Feature</h3>
123 <p>
124 Below Discussion click "add comment" to open a text edit box.  To save
125 your comment click "Add comment" below the edit box.  Finally click Save
126 feature to store your comment in the feature database.
127 </p><p>
128 Once comments are available, you can refer to a comment directly by
129 clicking reply.
130 </p>
131
132 <% if !isPartnerFate %>
133 <h3>Voting for features</h3>
134 <table><tr><td>
135 <p>
136 The voting widget is displayed on the upper right side of a feature. 
137 It shows the current score of a feature, and you can see a history of the votes on "toggle statistics". 
138 To give a vote, please login, and you will have the three options "down", "neutral" and "up" when 
139 hovering over the voting applet. 
140 Please use the voting to show your favourite features, and don't misuse the comments for that, as that only makes 
141 the feature view confusing. 
142 </p>
143 </td><td>
144 <%= image_tag("help/vote_widget.png") %>
145 </td></tr></table>
146 <% end %>
147
148 <h2>References</h2>
149
150 <ul>
151 <li>Read more about <%= @appname %>, see <%= link_to "http://en.opensuse.org/Proposals/openFate", "http://en.opensuse.org/Proposals/openFate" %>.</li>
152 <li>Submit <%= @appname %> bug reports in <a href="https://bugzilla.novell.com/enter_bug.cgi?classification=&product=SUSE+Feature+Tracking&component=web.fate">Novell bugzilla</a>.</li>
153 </ul>
154
155
156 <h2>Detailed definition of feature attributes</h2>
157 <p>A feature is described by a number of attributes. What the attributes mean and how they
158 should be filled in is described below.</p>
159
160 <!-- docstart:title -->
161 <div id="docpart_title">
162 <a name="title"></a><h4>Title</h4>
163 <blockquote>
164 <p>A very brief one-line description of the feature request. <i>(Example: "Improved argument handling for zypper")</i></p>
165 </blockquote>
166 </div>
167 <!-- docend:title -->
168
169
170 <!-- docstart:tags -->
171 <a name="tags"></a><h4>Tags</h4>
172 <blockquote>
173 <p>Tags are keywords associated with a feature (see also 
174 <a href="http://en.wikipedia.org/wiki/Tag_(metadata)">http://en.wikipedia.org/wiki/Tag_(metadata)</a>).
175 The tag cloud is created from all feature tags, the more often a tag is used, the bigger it will 
176 be rendered in the tag cloud.</p>
177 </blockquote>
178 <!-- docend:tags -->
179
180
181 <!-- docstart:products -->
182 <div id="docpart_products">
183 <a name="products"></a><h4>Products</h4>
184 <blockquote>
185 <p>One or more products for which the feature is requested. Each product is tracked by a seperate state, 
186 so maybe your feature gets rejected for openSUSE 11.2, but implemented for 11.3, for example.</p>
187 </blockquote>
188 </div>
189 <!-- docend:products -->
190
191
192 <!-- docstart:priority -->
193 <a name="priority"></a><h4>Priority</h4>
194 <blockquote>
195 <p>Specifies the priority this feature has for the corresponding actor.</p>
196
197 <ul>
198  <li><strong>Mandatory:</strong> This feature is absolutely needed. 
199  The product cannot be shipped with non-implemented mandatory features</li>
200  <li><strong>Important:</strong> The feature has a significant benefit and should be implemented if feasible.</li>
201  <li><strong>Desirable:</strong> The feature adds value to the product, but can be dropped from the list
202      of requirements or moved to a later release if necessary.</li>
203  <li><strong>Neutral:</strong> This feature is of low priority.</li>
204 </ul>
205 <p>Please note that giving a feature request a high priority does not entitle you to actually insist on openSUSE
206    implementing the feature for the next release of the product.</p>
207 </blockquote>
208 <!-- docend:priority -->
209
210
211 <!-- docstart:actors -->
212 <a name="actors"></a><h4>Actors</h4>
213 <blockquote>
214 <ul>
215  <li><strong>Requester: </strong>The contact for openSUSE when needing further details or clarification about
216 the feature request. When creating a new feature, the requester is automatically set to the authenticated user.</li>
217 <li><strong>Interested Person: </strong>Add yourself as "Interested Person" when you want to have the feature be available in your 
218 watchlist.</li>
219 <li><strong>Developer: </strong>The developer is responsible for implementing the feature. This can be a Novell person, 
220 or an external community member. </li>
221 </ul>
222 </blockquote>
223 <!-- docend:actors -->
224
225
226 <!-- docstart:description -->
227 <a name="description"></a><h4>Description</h4>
228 <blockquote>
229 <p>Describe the feature request clearly enough so the intent of
230 the request can be understood without any additional context information.</p>
231 <p>If possible, add a short use-case scenario.</p>
232 <p><strong>Don't</strong> include multi-page specifications, code snippets, or kernel patches here. Better provide
233 URL hyperlinks for such kind of data.</p>
234 <p>Please mention if you know about an existing implementation for the request or can provide a patch.</p>
235 </blockquote>
236 <!-- docend:description -->
237
238
239 <% if isPartnerFate %>
240 <!-- docstart:nda_date -->
241 <a name="nda_date"></a><h4>NDA expire Date</h4>
242 <blockquote>
243 <p>The date on which the NDA with the set partner company expires.</p>
244 </blockquote>
245 <!-- docend:nda_date -->
246
247
248 <!-- docstart:external_id -->
249 <a name="external_id"></a><h4>External ID</h4>
250 <blockquote>
251 <p>External tracking ID in the system of the partner organization.</p>
252 </blockquote>
253 <!-- docend:external_id -->
254 <% end %>
255
256 <!-- docstart:partner_benefit -->
257 <a name="partner_benefit"></a><h4>Stakeholder benefit</h4>
258 <blockquote>
259 <p>Which benefit has the feature stakeholder from implementing this feature.</p>
260 </blockquote>
261 <!-- docend:partner_benefit -->
262
263
264 <!-- docstart:richtext -->
265 <a name="richtext"></a><h3>Richtext</h3>
266 <blockquote>
267 <p>Data for the fields description, comment, usecase can be entered as richtext. 
268 <%= @appname %> supports the following richtext elements: </p>
269
270 <ul>
271
272 <li>&lt;p&gt;...&lt;/p&gt;<br>
273 New paragraph</li>
274 <li>&lt;pre&gt;...&lt;/pre&gt;<br>
275 Preformated text. All contained text is printed as typed.</li>
276 <li>&lt;h3&gt;...&lt;/h3&gt;<br>
277 Headline</li>
278
279 <li>&lt;ul&gt;...&lt;/ul&gt;<br>
280 Bulleted (unordered) list. Needs to contain &lt;li&gt;...&lt;/li&gt; elements</li>
281 <li>&lt;ol&gt;...&lt;/ol&gt;<br>
282 Ordered list. Also needs to contain &lt;li&gt;...&lt;/li&gt; elements</li>
283
284 <li>&lt;a href="http://host.domain/path/"&gt;...&lt;/a&gt;<br>
285 <a target="_blank" href="http://en.wikipedia.org/wiki/Hyperlink">Hyperlink</a> to another ressource in the internet</li>
286 <li>&lt;b&gt;...&lt;/b&gt;<br>
287 <b>Bold</b> text</li>
288 <li>&lt;em&gt;...&lt;/em&gt;<br>
289
290 <i>Italic</i> text</li>
291 <li>&lt;tt&gt;...&lt;/tt&gt;<br>
292 <tt>Typewriter</tt> font</li>
293 </ul>
294
295 </blockquote>
296 <!-- docend:richtext -->
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327