Group Graal

Let's group these pages and we'll update them later!

Signed-off-by: Igor Zubiaurre García <[email protected]>

Author: fioddor

graal/cocom.md docs/graal/cocom.mdgraal/cocom.md renamed to docs/graal/cocom.md

@@ -1,3 +1,13 @@
+---
+layout: default
+title: Cocom
+nav_order: 2
+parent: Graal
+has_children: false
+has_toc: false
+---
+
+
 # Retrieving Code Complexity via CoCom Backend
 
 - [CoCom](https://github.com/chaoss/grimoirelab-graal/blob/master/graal/backends/core/cocom.py) ( Code Complexity ) Backend based on supported languages and with the help of [Lizard](https://github.com/terryyin/lizard) retrieves various source code related analysis such as:

docs/graal/index.md

@@ -0,0 +1,23 @@
+---
+layout: default
+title: Graal
+permalink: /graal
+nav_order: 14
+has_children: true
+has_toc: true
+---
+
+# Graal: a Generic Reporitory AnALyzer
+
+Graal leverages on the Git backend of Perceval and enhances it to set
+up ad-hoc source code analysis. Thus, it fetches the commits from a
+Git repository and provides a mechanism to plug third party
+tools/libraries focused on source code analysis.
+
+
+GrimoireELK is the component of GrimoireLab that interacts with the
+underlying (OpenSearch) database. Its goal is two-fold, first it aims
+at offering a convenient way to store the data coming from Perceval,
+second it processes and enriches the data in a format that can be
+used by the Dashboards.
+

docs/graal/intro.md

@@ -0,0 +1,28 @@
+---
+layout: default
+title: Intro
+nav_order: 1
+parent: Graal
+has_children: false
+has_toc: false
+---
+
+# Graal
+
+  - [Graal](https://github.com/chaoss/grimoirelab-graal)
+    ( Generic Repository AnALyzer ) with the help of Perceval's
+    [Git backend](https://github.com/chaoss/grimoirelab-perceval/blob/master/perceval/backends/core/git.py)
+    fetches commits from a Git repository and provides a mechanism to
+    plug third party tools/libraries focused on source code analysis.
+    As of now, Graal produces analysis related to code complexity,
+    quality, dependencies, vulnerability and licensing. In this chapter,
+    you will learn the basics of working with Graal, including how to
+    retrieve source code related analysis with the help of some of it's
+    backends.
+
+  - Before starting, ensure that you have Python3 ready, and the Graal
+    module installed, as detailed in
+    [Installing GrimoireLab Python modules](../basics/install.md).
+
+**Note:** As of now, Graal is not integrated in Grimoirelab toolchain,
+it will soon be added to support source code related metrics.