From 72e0a9257ed40360e58fb44fd12d259d49e0eecf Mon Sep 17 00:00:00 2001 From: Rafael Reggiani Manzo Date: Thu, 7 Aug 2014 10:03:11 -0300 Subject: [PATCH] Repository analysis tutorial --- app/views/tutorials/analyzing.html.erb | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ app/views/tutorials/project_customization.html.erb | 0 2 files changed, 88 insertions(+), 0 deletions(-) create mode 100644 app/views/tutorials/analyzing.html.erb delete mode 100644 app/views/tutorials/project_customization.html.erb diff --git a/app/views/tutorials/analyzing.html.erb b/app/views/tutorials/analyzing.html.erb new file mode 100644 index 0000000..2d174b3 --- /dev/null +++ b/app/views/tutorials/analyzing.html.erb @@ -0,0 +1,88 @@ +

Tutorial

+

Analyzing a repository

+ +
+ +

Requisites

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

Steps

+ +
    +
  1. Project creation +
      +
    1. Click in "Project" on the upper menu
      2. +
    2. Click in "New Project" 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 project page now, congratualitions!
        4. +
      +
    +
  2. Repository creation
    3. +
      +
    1. From the project page, click in "New Repository"
      2. +
    2. Fill in the form
      3. +
        +
      • "Name" must be unique
        • +
      • You should choose from one of the Open Source licenses in the platform accordingly to your code
        • +
      • The "Type" field stands for the repository's source code management tool (eg: Git)
        • +
      • Fill in the "Address" with a URL from which we can download your code
        • +
      • If you want to analyze your project periodically, set it (you can as well run it from the interface whenever you want)
        • +
      • Finally, the "Configuration", stands for the settings for metrics and interpretation that we'll use to analyze your project
        • +
      • Click in "Save" and you should be at the repository page, waiting for tha analysis
        • +
      +
    +
+ +
+ +

Repository page details

+ +The repository page is divided into four different sections: + +
    +
  1. Details
    2. + +
  2. Processing information
    3. + +
  3. Modules Tree
    4. + +
  4. Metric Results
    5. + +
\ No newline at end of file diff --git a/app/views/tutorials/project_customization.html.erb b/app/views/tutorials/project_customization.html.erb deleted file mode 100644 index e69de29..0000000 --- a/app/views/tutorials/project_customization.html.erb +++ /dev/null -- libgit2 0.21.2