Download as
Browse Code »

Commit b608a62190048f741c401db0c3d8b793235b7108

Authored by Diego Camarinha
1 parent 5b6628a5
Exists in colab and in 4 other branches master, spb-master, spb-stable, stable

Reviewed humans.txt, index and tutorials

Showing 4 changed files with 27 additions and 25 deletions   Show diff stats
app/views/home/index.html.erb
  Diff comments   View file @b608a62
... ... @@ -3,7 +3,7 @@
3 3  
4 4 <p>This is Mezuro! A <strong>free/libre</strong> web platform for <strong>collaborative</strong> source code <strong>evaluation</strong>.</p>
5 5  
6   - <p>Here you can evaluate your source code with most of popular SCM (Git SVN), just by giving it's URL. For now you can evaluate <strong>C</strong>, <strong>C++</strong>, and <strong>Java</strong> source code, but soon we hope to support more languages!</p>
  6 + <p>Here you can evaluate your source code with the most popular SCMs (Git SVN), just by providing it's URL. For now, you can evaluate <strong>C</strong>, <strong>C++</strong>, and <strong>Java</strong> source codes, but soon we hope to support more languages!</p>
7 7  
8 8 <p> Mezuro is under development. Try it and give us your <%= link_to 'feedback', 'https://github.com/mezuro/mezuro/issues', target: '_blank' %>.</p>
9 9 </div>
... ...
app/views/tutorials/analyzing.html.erb
  Diff comments   View file @b608a62
... ... @@ -19,26 +19,26 @@ In order to create a Project, you must:
19 19 <ol>
20 20 <li>Project creation
21 21 <ol>
22   - <li>Click in "Project" on the upper menu</li>
23   - <li>Click in "New Project" on the upper menu</li>
  22 + <li>Click on "Project" on the upper menu</li>
  23 + <li>Click on "New Project"</li>
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, congratulations!</li>
  27 + <li>Click on "Save" and you should be at the project page now, congratulations!</li>
28 28 </ol>
29 29 </ol>
30 30 <li>Repository creation</li>
31 31 <ol>
32   - <li>From the project page, click in "New Repository"</li>
  32 + <li>From the project page, click on "New Repository"</li>
33 33 <li>Fill in the form</li>
34 34 <ul>
35 35 <li>"Name" must be unique</li>
36 36 <li>You should choose from one of the Open Source licenses in the platform accordingly to your code</li>
37   - <li>The "Type" field stands for the repository's source code management tool (eg: Git)</li>
38   - <li>Fill in the "Address" with a URL from which we can download your code</li>
  37 + <li>The "Type" field stands for the repository's source code management tool (Git, for example)</li>
  38 + <li>Fill in the "Address" with the URL from which we can download your code</li>
39 39 <li>If you want to analyze your project periodically, set it (you can as well run it from the interface whenever you want)</li>
40   - <li>Finally, the "Configuration", stands for the settings for metrics and interpretation that we'll use to analyze your project</li>
41   - <li>Click in "Save" and you should be at the repository page, waiting for tha analysis</li>
  40 + <li>Finally, the "Configuration", stands for the set of metrics and interpretation that we'll use to analyze your project</li>
  41 + <li>Click on "Save" and you should be at the repository page, waiting for that analysis</li>
42 42 </ul>
43 43 </ol>
44 44 </ol>
... ... @@ -61,11 +61,11 @@ The repository page is divided into four different sections:
61 61 <ol>
62 62 <li>PREPARING: the system is reserving a folder for your repository and retrieving the configuration</li>
63 63 <li>DOWNLOADING: retrieving the source code</li>
64   - <li>COLLECTING: extracting the metrics for your repository</li>
  64 + <li>COLLECTING: calculating the metrics for your repository</li>
65 65 <li>BUILDING: organizing the results into a source tree structure</li>
66 66 <li>AGGREGATING: calculating the aggregated value for parent modules in the source tree</li>
67   - <li>CALCULATING: if the choosen configuration has compund metrics, they will be calculated</li>
68   - <li>INTERPRETATING: with all the necessary results, now the system will interpretate this results in means of the reading group (labels and colors)</li>
  67 + <li>CALCULATING: if the choosen configuration has compound metrics, they will be calculated</li>
  68 + <li>INTERPRETING: with all the necessary results, the system will interpret them using reading groups (labels and colors)</li>
69 69 </ol>
70 70 </ul>
71 71 <li><b>Modules Tree</b></li>
... ... @@ -78,11 +78,11 @@ The repository page is divided into four different sections:
78 78 <li>PACKAGE</li>
79 79 <li>SOFTWARE</li>
80 80 </ul>
81   - <li>Grade of the given module accordingly to the weights of the configuration
  81 + <li>Grade of the given module accordingly to the weights of the metrics on the configuration
82 82 </ul>
83 83 <li><b>Metric Results</b></li>
84 84 <ul>
85   - <li>Displays the individual results for each metric for the current module selected in the source tree</li>
  85 + <li>Displays the individual results of each metric for the current module selected in the source tree</li>
86 86 <li>By clicking in the metric name, you will see a historic chart for that metric</li>
87 87 </ul>
88 88 </ol>
89 89 \ No newline at end of file
... ...
app/views/tutorials/configuring.html.erb
  Diff comments   View file @b608a62
... ... @@ -16,20 +16,20 @@ In order to create a Configuration, you must:
16 16  
17 17 <h3>Introduction</h3>
18 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.
  19 +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 20  
21 21 <h4>Configuration components</h4>
22 22 <ul>
23 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>
  24 + <li><b>Metrics</b>: specification of which metric will be calculated during the processing and how to interpret its results</li>
25 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>
  26 + <li>Weight: for each module is given a grade which is a weighted average of all the metrics calculated for it. This field is the weight of the metric on the final grade</li>
  27 + <li>Aggregation Form: Not all the metrics can be calculated for every module. For this type of metric, we calculate the aggregation of the children values accordingly to what this field specifies</li>
28 28 <li>Reading Group: specifies which set of interpretations (called readings) will be available for this metric</li>
29 29 </ul>
30 30 <li><b>Reading Group</b>: just a high level container for the readings (interpretations)</li>
31 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>
  32 + <li>Reading: interpretation for a given value providing label, grade (this is the grade used for the weighted average mentioned above) and color</li>
33 33 </ul>
34 34 <li><b>Range</b>: Associates number intervals to the readings of a given metric</li>
35 35 </ul>
... ... @@ -42,7 +42,7 @@ In order to process a repository, Mezuro uses configurations which you specify o
42 42 <li>Configuration creation</li>
43 43 <ol>
44 44 <li>Click on "Configuration" on the upper menu</li>
45   - <li>Click on "New Configuration" on the upper menu</li>
  45 + <li>Click on "New Configuration"</li>
46 46 <ol>
47 47 <li>Fill in the form with a name that must be unique</li>
48 48 <li>Fill in the form with a description which is not required</li>
... ... @@ -69,7 +69,7 @@ In order to process a repository, Mezuro uses configurations which you specify o
69 69 <ol>
70 70 <li>Fill in the form with the "Beginning" and "End" values for the interval</li>
71 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>
  72 + <li>Select the "Reading" which will be associated with this range</li>
73 73 <li>Click on "Save" and you should be at the metric page now with the new range added, congratulations!</li>
74 74 </ol>
75 75 </ol>
... ...
public/humans.txt
  Diff comments   View file @b608a62
... ... @@ -7,7 +7,9 @@
7 7 -------------------
8 8  
9 9 Alessandro Palmeira (alessandro.palmeira at gmail.com)
10   - Diego Araújo (diegoamc90 at gmail.com)
  10 + Daniel Paulino Alves (danpaulalves at gmail.com)
  11 + Diego de Araújo Martinez Camarinha (diegoamc90 at gmail.com)
  12 + Heitor Reis Ribeiro (marcheing at gmail.com)
11 13 Paulo Meirelles (paulo at softwarelivre.org)
12 14 Rafael Reggiani Manzo (rr.manzo at gmail.com)
13 15 Renan Fichberg (rfichberg at gmail.com)
... ... @@ -28,9 +30,9 @@
28 30  
29 31 USP Lab XP course 2014
30 32 ---------------------------------------------------------
31   - Daniel Miranda (danielkza2@gmail.com)
  33 + Daniel Miranda (danielkza2 at gmail.com)
32 34 Fellipe Souto Sampaio (fllsouto at gmail.com)
33   - Pedro Bruel (pedro.bruel@gmail.com)
  35 + Pedro Bruel (pedro.bruel at gmail.com)
34 36 Pedro Paulo (pedro at vezza.com.br)
35 37 Pedro Scocco (pedroscocco at gmail.com)
36 38 Thiago Kenji Okada <thiago.mast3r at gmail.com>
... ... @@ -55,7 +57,7 @@
55 57 Carlos Morais (carlos88morais at gmail.com)
56 58 Daniel Alves (danpaulalves at gmail.com)
57 59 Daniela Feitosa (daniela at colivre.coop.br)
58   - Diego Araújo (diegoamc90 at gmail.com)
  60 + Diego de Araújo Martinez Camarinha (diegoamc90 at gmail.com)
59 61 Everton Santos (everton2x4 at gmail.com)
60 62 Guilherme Rojas (guilhermehrojas at gmail.com)
61 63 Jefferson Fernandes (jeffs.fernandes at gmail.com)
... ...