Merge branch 'izubiaurre-group-pages' of 'https://github.com/fioddor/…

…grimoirelab-tutorial'

Merges #227
Closes #227

cases-chaoss/activity.md → docs/cases-chaoss/activity.md

@@ -1,3 +1,13 @@
+---
+layout: default
+title: Community Activity
+nav_order: 1
+parent: Use Cases
+has_children: false
+has_toc: false
+---
+
+
 ## Community Activity
 
 Once we have the indexes, let's create the first panel, for community activity.

cases-chaoss/intro.md → docs/cases-chaoss/index.md

@@ -1,4 +1,13 @@
-# Cases: CHAOSS Health Model
+---
+layout: default
+title: Use Cases
+permalink: /cases
+nav_order: 13
+has_children: true
+has_toc: true
+---
+
+# Use Cases: CHAOSS Health Model
 
 The [CHAOSS Metrics Technical Committee](https://chaoss.community) is working on defining metrics for assessing open source communities' health and sustainability. In this chapter we use some of their definitions, as of September 2017, to produce visualizations based on the GrimoireLab stack. They will be used to compose a "CHAOSS Metrics Dashboard" produced with GrimoireLab technology.
 

gelk/meetup.md → docs/cases-chaoss/meetup.md

@@ -1,3 +1,13 @@
+---
+layout: default
+title: Meetup dashboard
+nav_order: 2
+parent: Use Cases
+has_children: false
+has_toc: false
+---
+
+
 ## Create a complete dashboard for Meetup
 
 [Meetup](http://meetup.com) is one of the platforms used by many communities to organize meetings. It is popular among some development communities, and can be a good example of how to build a dashboard from scratch. The result that you'll get after going through this section will be similar to this screenshot:

docs/components/gelk/index.md

@@ -0,0 +1,18 @@
+---
+layout: default
+title: GrimoireELK
+permalink: /gelk
+nav_order: 1
+parent: Components
+has_children: true
+has_toc: true
+---
+
+# GrimoireELK (Gelk)
+
+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.
+

gelk/intro.md → docs/components/gelk/intro.md

@@ -1,4 +1,13 @@
-# Producing Kibana dashboards with GrimoireELK
+---
+layout: default
+title: Producing dashboards with GrimoireELK
+nav_order: 1
+parent: GrimoireELK
+has_children: false
+has_toc: false
+---
+
+# Producing dashboards with GrimoireELK
 
 [GrimoireELK](http://github.com/chaoss/grimoirelab-elk)
 is an interim system oriented to produce Kibana-based dashboards with Perceval and friends.

gelk/kidash.md → docs/components/gelk/kidash.md

@@ -1,3 +1,13 @@
+---
+layout: default
+title: Managing dashboards with kidash
+nav_order: 4
+parent: GrimoireELK
+has_children: false
+has_toc: false
+---
+
+
 ## Managing dashboards with kidash
 
 Kibana (or Kibiter, for that matter) offers a nice user interface to create and edit visualizations and dashboards. It allows to save and restore them as well. But if you're interested in backing up all the elements needed to produce a dashboard, you need some tools. That's why we developed Kidash. Then, we added some other features to it. And now Kidash is our tool of choice to back and restore dashboards with all their elements (visualizations, searches, and index patterns), in the same or in a different Kibana instance.

gelk/simple.md → docs/components/gelk/simple.md

@@ -1,3 +1,13 @@
+---
+layout: default
+title: Creating a simple dashboard
+nav_order: 2
+parent: GrimoireELK
+has_children: false
+has_toc: false
+---
+
+
 ## Creating a simple dashboard
 
 Creating a dashboard using the tools we just installed is not difficult:

gelk/sortinghat.md → docs/components/gelk/sortinghat.md

@@ -1,3 +1,12 @@
+---
+layout: default
+title: A dashboard with SortingHat
+nav_order: 3
+parent: GrimoireELK
+has_children: false
+has_toc: false
+---
+
 ## A dashboard with SortingHat
 
 The simple dashboard we just produced uses indexes which

graal/cocom.md → docs/components/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/components/graal/index.md

@@ -0,0 +1,24 @@
+---
+layout: default
+title: Graal
+permalink: /graal
+nav_order: 5
+parent: Components
+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/components/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.

docs/components/index.md

@@ -2,49 +2,8 @@
 layout: default
 title: Components
 permalink: /components
-nav_order: 2
+nav_order: 10
 has_children: true
 has_toc: true
 ---
 
-# GrimoireLab Components
-
-The following figure summarizes the different tools used in GrimoreLab.
-
-![](../../assets/grimoirelab-all-details.png)
-
-GrimoireLab is composed of different tools, which are listed below:
-
-### Data retrieval related components:
-  - [Perceval](https://github.com/chaoss/grimoirelab-perceval): retrieval of
-    data from data sources
-  - [Graal](https://github.com/chaoss/grimoirelab-graal): source data analysis
-    with external tools
-  - [KingArthur](https://github.com/chaoss/grimoirelab-kingarthur): batch
-    processing for massive retrieval
-
-### Data enrichment related components:
-  - [GrimoireELK](https://github.com/chaoss/grimoirelab-elk): storage and
-    enrichment of data
-  - [Cereslib](https://github.com/chaoss/grimoirelab-cereslib): generic data
-    processor
-  - [SortingHat](https://github.com/chaoss/grimoirelab-sortinghat): identity
-    management
-
-### Data consumption related components:
-  - [Kibiter](https://github.com/chaoss/grimoirelab-kibiter): dashboard,
-    downstream version of Kibana
-  - [Sigils](https://github.com/chaoss/grimoirelab-sigils): visualizations and
-    dashboards
-  - [Kidash](https://github.com/chaoss/grimoirelab-kidash): visualizations and
-    dashboards manager
-  - [Manuscripts](https://github.com/chaoss/grimoirelab-manuscripts): reporting
-
-### Platform management, orchestration, and common utils:
-  - [Mordred](https://github.com/chaoss/grimoirelab-mordred): orchestration
-  - [GrimoireLab Toolkit](https://github.com/chaoss/grimoirelab-toolkit): common
-    utilities
-  - [Bestiary](https://github.com/chaoss/grimoirelab-bestiary): web-based user
-    interface to manage repositories and projects for Mordred
-  - [Hatstall](https://github.com/chaoss/grimoirelab-hatstall): web-based user
-    interface to manage SortingHat identities

manuscripts/first.md → docs/components/manuscripts/first.md

@@ -1,3 +1,13 @@
+---
+layout: default
+title: Reporting with Manuscripts
+nav_order: 1
+parent: Manuscripts
+has_children: false
+has_toc: false
+---
+
+
 ## Reporting with Manuscripts
 
 [Manuscripts](https://github.com/chaoss/grimoirelab-manuscripts) is the GrimoireLab tool

docs/components/manuscripts/index.md

@@ -0,0 +1,14 @@
+---
+layout: default
+title: Manuscripts
+permalink: /manuscripts
+nav_order: 4
+parent: Components
+has_children: true
+has_toc: true
+---
+
+# Manuscripts
+
+Production of PDF documents reporting on the main characteristics of a
+project.

sirmordred/container.md → docs/components/sirmordred/container.md

@@ -1,4 +1,13 @@
-## SirMordred in a container
+---
+layout: default
+title: Mordred in a container
+nav_order: 3
+parent: Sir Mordred rules them all
+has_children: false
+has_toc: false
+---
+
+## Mordred in a container
 
 To produce a dashboard with SirMordred, you can also use some containers, available from DockerHub, ready to work:
 

sirmordred/dashboard.md → docs/components/sirmordred/dashboard.md

@@ -1,3 +1,12 @@
+---
+layout: default
+title: A GrimoireLab dashboard in a single step
+nav_order: 1
+parent: Sir Mordred rules them all
+has_children: false
+has_toc: false
+---
+
 ## A GrimoireLab dashboard in one step
 
 [SirMordred](https://github.com/chaoss/grimoirelab-sirmordred)

docs/components/sirmordred/index.md

@@ -0,0 +1,14 @@
+---
+layout: default
+title: Sir Mordred rules them all
+permalink: /sirmordred
+nav_order: 2
+parent: Components
+has_children: true
+has_toc: true
+---
+
+# Sir Mordred
+
+Mordred is the tool used to coordinate the execution of the GrimoireLab
+platform.

sirmordred/micro-mordred.md → docs/components/sirmordred/micro-mordred.md

@@ -1,3 +1,13 @@
+---
+layout: default
+title: Micro-mordred via Docker-Compose
+nav_order: 2
+parent: Sir Mordred rules them all
+has_children: false
+has_toc: false
+---
+
+
 ### Micro-mordred via Docker-Compose
 
 ### What is Mordred?

sirmordred/projects.md → docs/components/sirmordred/projects.md

@@ -1,3 +1,13 @@
+---
+layout: default
+title: The projects file
+nav_order: 4
+parent: Sir Mordred rules them all
+has_children: false
+has_toc: false
+---
+
+
 ## The projects file
 
 An important part of the information provided to Mordred is the list of projects to analyze, and how they are structured in repositories. This is done in the projects file.

sortinghat/basic.md → docs/components/sortinghat-cli/basic.md

@@ -1,3 +1,11 @@
+---
+layout: default
+title: Basic use of SortingHat from the command line
+nav_order: 1
+parent: SortingHat from the command line
+has_children: false
+has_toc: false
+---
 
 
 ## Basic use