Download as
Browse Code »

Commit 8fe67893569cd35c8987d0dca58ccc88e6ce894a

Authored by Rafael Manzo
1 parent 03e60525
Exists in colab and in 4 other branches master, spb-master, spb-stable, stable

Configuration tutorial

Showing 3 changed files with 80 additions and 1 deletions   Show diff stats
app/views/layouts/application.html.erb
  Diff comments   View file @8fe6789
... ... @@ -84,6 +84,7 @@
84 84 <% end %>
85 85 <li class="nav-header">Tutorials</li>
86 86 <li><%= link_to 'Analysis', tutorials_path('analyzing') %></li>
  87 + <li><%= link_to 'Configuration', tutorials_path('configuring') %></li>
87 88 <% if content_for?(:sidebar) %>
88 89 <%= yield :sidebar %>
89 90 <% else %>
... ...
app/views/tutorials/analyzing.html.erb
  Diff comments   View file @8fe6789
... ... @@ -24,7 +24,7 @@ In order to create a Project, you must:
24 24 <ol>
25 25 <li>Fill in the form with a name that must be unique</li>
26 26 <li>Fill in the form with a description which is not required</li>
27   - <li>Click in "Save" and you should be at the project page now, congratualitions!</li>
  27 + <li>Click in "Save" and you should be at the project page now, congratulations!</li>
28 28 </ol>
29 29 </ol>
30 30 <li>Repository creation</li>
... ...
app/views/tutorials/configuring.html.erb 0 → 100644
  Diff comments   View file @8fe6789
... ... @@ -0,0 +1,78 @@
  1 +<h1>Tutorial</h1>
  2 +<h2>Processing configuration</h2>
  3 +
  4 +<hr />
  5 +
  6 +<h3>Requisites</h3>
  7 +
  8 +In order to create a Project, you must:
  9 +<ul>
  10 + <li>Have <%= link_to("signed up", new_user_registration_path) %> to the platform</li>
  11 + <li>Be <%= link_to("signed in", new_user_session_path) %></li>
  12 + <li>Have already created at least one Reading Group</li>
  13 +</ul>
  14 +
  15 +<hr />
  16 +
  17 +<h3>Introduction</h3>
  18 +
  19 +In order to process a repository, Mezuro uses configurations which you specify on the <%= link_to "repository creation", tutorials_path('analyzing') %>. Here you will be briefly introduced to all the components of a configuration and then guided through the steps to create one.
  20 +
  21 +<h4>Configuration components</h4>
  22 +<ul>
  23 + <li><b>Configuration</b>: just a high level container for the remaining components association</li>
  24 + <li><b>Metrics</b>: specification of which metric will be collected during the processing and how to interpret its results</li>
  25 + <ul>
  26 + <li>Weight: for each module is given a grade which is a weighted average of all the metrics collected for the module. This is the weight of this given metric on the final grade</li>
  27 + <li>Aggregation Form: Not all the metrics can be collected for every module. So, if this metric can't get collected for one module, it will aggregate the children values accordingly to what this field specifies</li>
  28 + <li>Reading Group: specifies which set of interpretations (called readings) will be available for this metric</li>
  29 + </ul>
  30 + <li><b>Reading Group</b>: just a high level container for the readings (interpretations)</li>
  31 + <ul>
  32 + <li>Reading: interpretation for a given value providing label, grade (this is the grade used for the weighted average mentioned above) and colour</li>
  33 + </ul>
  34 + <li><b>Range</b>: Associates number intervals to the readings of a given metric</li>
  35 +</ul>
  36 +
  37 +<hr />
  38 +
  39 +<h3>Steps</h3>
  40 +
  41 +<ol>
  42 + <li>Configuration creation</li>
  43 + <ol>
  44 + <li>Click in "Configuration" on the upper menu</li>
  45 + <li>Click in "New Configuration" on the upper menu</li>
  46 + <ol>
  47 + <li>Fill in the form with a name that must be unique</li>
  48 + <li>Fill in the form with a description which is not required</li>
  49 + <li>Click in "Save" and you should be at the configuration page now</li>
  50 + </ol>
  51 + </ol>
  52 + <li>Metric addition</li>
  53 + <ol>
  54 + <li>From the configuration page</li>
  55 + <li>Click in "Add Metric"</li>
  56 + <li>Select one collector from the accordions, and click in the metric that you want to add</li>
  57 + <ol>
  58 + <li>Fill in the form with a "Weight", used to calculate the final grade</li>
  59 + <li>Select the "Aggregation Form" that will be used for this metric</li>
  60 + <li>Select the "Reading Group" which will provide the interpretations for this metric</li>
  61 + <li>Click in "Save" and you should be at the configuration page now with the new metric added</li>
  62 + </ol>
  63 + </ol>
  64 + <li>Ranges creation</li>
  65 + <ol>
  66 + <li>From the configuration page</li>
  67 + <li>Click in "Show" for the metric which you want to create ranges to</li>
  68 + <li>Click in "Add Range"</li>
  69 + <ol>
  70 + <li>Fill in the form with the "Beginning" and "End" values for the interval</li>
  71 + <li>Fill in the form with the "Comments" which will be displayed if the metric value matches the interval</li>
  72 + <li>Select the "Reading" which will be used to calculate the grade, set the label and colour for this metric</li>
  73 + <li>Click in "Save" and you should be at the metric page now with the new range added, congratulations!</li>
  74 + </ol>
  75 + </ol>
  76 +</ol>
  77 +
  78 +<hr />
0 79 \ No newline at end of file
... ...