Skip to content

Commit 911757f

Browse files
committed
[docs] Add CoCom & CoLic documentation
Signed-off-by: inishchith <inishchith@gmail.com>
1 parent 4fb11fa commit 911757f

4 files changed

Lines changed: 65 additions & 0 deletions

File tree

docs/_panels/cocom.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: CoCom
3+
description: metrics focused on source code analysis
4+
author: Nishchith Shetty
5+
screenshot: sigils/cocom.gif
6+
created_at:
7+
grimoirelab_version: 0.2.0
8+
layout: panel
9+
---
10+
11+
The CoCom panel is focused on analyzing source code information obtained
12+
from Graal. [Graal](https://github.com/chaoss/grimoirelab-graal) is a tool
13+
which uses a wide range of Backends for specific tasks, one of them
14+
being **`Code Complexity(CoCom)`** which provides source code related
15+
information such as Code Complexity, Lines of Code, Functions and many
16+
more from a given software repository.
17+
18+
## Metrics
19+
From left to right and top to bottom, some of the metrics provided are:
20+
21+
* **Repositories Overview**: Overview of all the repositories and overall metrics
22+
per project.
23+
* **Evolution: Code Complexity & Functions**: Evolution of Code Complexity and
24+
Functions over a given period of time.
25+
* **Evolution: LOC & Comments**: Evolution of Lines of Code and Comment Lines
26+
over a given period of time.
27+
* **All Files: Code complexity, LOC and ratios**: Shows metrics such as Code
28+
Complexity, LOC, Functions, and others for every file in a project. It can be
29+
delegated for a module with the help of the Selector.
30+
31+
Additionally, the visualizations can be delegated with the help of Selector at the Top(left);
32+
which provides filters such as **`Module Path`**, **`Interval`**, **`Repository`** and many more
33+
for specific purposes.

docs/_panels/colic.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: CoLic
3+
description: metrics focused on license analysis
4+
author: Nishchith Shetty
5+
screenshot: sigils/colic.gif
6+
created_at:
7+
grimoirelab_version: 0.2.0
8+
layout: panel
9+
---
10+
11+
The CoLic panel is focused on analyzing the License & Copyright related
12+
information obtained from Graal. [Graal](https://github.com/chaoss/grimoirelab-graal)
13+
is a tool which uses a wide range of Backends for specific tasks, one of them
14+
being **`Code License(CoLic)`** which provides License & Copyright related
15+
information from a given software repository.
16+
17+
## Metrics
18+
From left to right and top to bottom, some of the metrics provided are:
19+
20+
* **Repositories Overview**: Overview of all the repositories with the number of
21+
licensed and copyrighted files.
22+
* **Evolution: Licensed & Copyrighted Files**: Evolution of Total Files vs Licensed and
23+
Copyrighted files.
24+
* **License & Copyright Definition**: A Pie-Chart showing the top Copyright and License
25+
definitions in the project.
26+
* **All Files: License & Copyright Definition**: Shows license & copyright definition
27+
for every file in a project. It can be delegated for a module with the help of the
28+
Selector.
29+
30+
Additionally, the visualizations can be delegated with the help of Selector at the Top(left);
31+
which provides filters such as **`Module Path`**, **`Interval`**, **`Repository`** and many more
32+
for specific purposes.
3.95 MB
Loading
3.06 MB
Loading

0 commit comments

Comments
 (0)