diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb index 3e853eb..59dc126 100644 --- a/app/views/layouts/application.html.erb +++ b/app/views/layouts/application.html.erb @@ -84,6 +84,7 @@ <% end %>
  • Tutorials
  • <%= link_to 'Analysis', tutorials_path('analyzing') %>
    • +
  • <%= link_to 'Configuration', tutorials_path('configuring') %>
    • <% if content_for?(:sidebar) %> <%= yield :sidebar %> <% else %> diff --git a/app/views/tutorials/analyzing.html.erb b/app/views/tutorials/analyzing.html.erb index 2d174b3..754b606 100644 --- a/app/views/tutorials/analyzing.html.erb +++ b/app/views/tutorials/analyzing.html.erb @@ -24,7 +24,7 @@ In order to create a Project, you must:
    1. Fill in the form with a name that must be unique
    2. Fill in the form with a description which is not required
      3. -
    3. Click in "Save" and you should be at the project page now, congratualitions!
      4. +
    4. Click in "Save" and you should be at the project page now, congratulations!
  • Repository creation
    • diff --git a/app/views/tutorials/configuring.html.erb b/app/views/tutorials/configuring.html.erb new file mode 100644 index 0000000..d3b373c --- /dev/null +++ b/app/views/tutorials/configuring.html.erb @@ -0,0 +1,78 @@ +

    Tutorial

    +

    Processing configuration

    + +
    + +

    Requisites

    + +In order to create a Project, you must: + + +
    + +

    Introduction

    + +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. + +

    Configuration components

    + + +
    + +

    Steps

    + +
      +
    1. Configuration creation
      2. +
        +
      1. Click in "Configuration" on the upper menu
        2. +
      2. Click in "New Configuration" on the upper menu
        3. +
          +
        1. Fill in the form with a name that must be unique
          2. +
        2. Fill in the form with a description which is not required
          3. +
        3. Click in "Save" and you should be at the configuration page now
          4. +
        +
      +
    2. Metric addition
      3. +
        +
      1. From the configuration page
        2. +
      2. Click in "Add Metric"
        3. +
      3. Select one collector from the accordions, and click in the metric that you want to add
        4. +
          +
        1. Fill in the form with a "Weight", used to calculate the final grade
          2. +
        2. Select the "Aggregation Form" that will be used for this metric
          3. +
        3. Select the "Reading Group" which will provide the interpretations for this metric
          4. +
        4. Click in "Save" and you should be at the configuration page now with the new metric added
          5. +
        +
      +
    3. Ranges creation
      4. +
        +
      1. From the configuration page
        2. +
      2. Click in "Show" for the metric which you want to create ranges to
        3. +
      3. Click in "Add Range"
        4. +
          +
        1. Fill in the form with the "Beginning" and "End" values for the interval
          2. +
        2. Fill in the form with the "Comments" which will be displayed if the metric value matches the interval
          3. +
        3. Select the "Reading" which will be used to calculate the grade, set the label and colour for this metric
          4. +
        4. Click in "Save" and you should be at the metric page now with the new range added, congratulations!
          5. +
        +
      +
    + +
    \ No newline at end of file -- libgit2 0.21.2