From 3ab71c4268ee0254b605ed5813df2a855d6dce35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Zubiaurre=20Garc=C3=ADa?= Date: Wed, 25 Oct 2023 00:31:53 +0200 Subject: [PATCH 01/10] Group Installation alternatives MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let's group these pages and we'll update them later! Signed-off-by: Igor Zubiaurre García --- {basics => docs/install}/dockerhub.md | 9 +++++++++ .../figs/bitergia_analytics_screenshot.png | Bin .../install}/figs/dashboard-grimoirelab.png | Bin .../install}/figs/kibana_welcome.png | Bin docs/install/index.md | 16 ++++++++++++++++ {basics => docs/install}/install.md | 9 +++++++++ {basics => docs/install}/quick.md | 9 +++++++++ {basics => docs/install}/supporting.md | 9 +++++++++ 8 files changed, 52 insertions(+) rename {basics => docs/install}/dockerhub.md (97%) rename {basics => docs/install}/figs/bitergia_analytics_screenshot.png (100%) rename {basics => docs/install}/figs/dashboard-grimoirelab.png (100%) rename {basics => docs/install}/figs/kibana_welcome.png (100%) create mode 100644 docs/install/index.md rename {basics => docs/install}/install.md (98%) rename {basics => docs/install}/quick.md (95%) rename {basics => docs/install}/supporting.md (98%) diff --git a/basics/dockerhub.md b/docs/install/dockerhub.md similarity index 97% rename from basics/dockerhub.md rename to docs/install/dockerhub.md index 476eabfd..37535ce8 100644 --- a/basics/dockerhub.md +++ b/docs/install/dockerhub.md @@ -1,3 +1,12 @@ +--- +layout: default +title: Deploying from DockerHub +nav_order: 2 +parent: Installation alternatives +has_children: false +has_toc: false +--- + ## Deploying from DockerHub GrimoireLab can be found, already installed and ready to use, as Docker container images. The image which is likely most useful for a start is [grimoirelab/full](https://hub.docker.com/r/grimoirelab/full), available from DockerHub. It includes all GrimoireLab components, along with the services needed to produce a fully functional GrimoireLab dashboard: Elasticsearch, MariaDB, and Kibiter. By default, the container produces a dashboard for the GrimoireLab project. diff --git a/basics/figs/bitergia_analytics_screenshot.png b/docs/install/figs/bitergia_analytics_screenshot.png similarity index 100% rename from basics/figs/bitergia_analytics_screenshot.png rename to docs/install/figs/bitergia_analytics_screenshot.png diff --git a/basics/figs/dashboard-grimoirelab.png b/docs/install/figs/dashboard-grimoirelab.png similarity index 100% rename from basics/figs/dashboard-grimoirelab.png rename to docs/install/figs/dashboard-grimoirelab.png diff --git a/basics/figs/kibana_welcome.png b/docs/install/figs/kibana_welcome.png similarity index 100% rename from basics/figs/kibana_welcome.png rename to docs/install/figs/kibana_welcome.png diff --git a/docs/install/index.md b/docs/install/index.md new file mode 100644 index 00000000..2afd7d8a --- /dev/null +++ b/docs/install/index.md @@ -0,0 +1,16 @@ +--- +layout: default +title: Installation alternatives +permalink: /install +nav_order: 9 +has_children: true +has_toc: true +--- + +# Installation alternatives + +If the default installation method doesn't suite your use case here's a +collection of alternative installation methods. + +The list and the details may be outdated. Feel free to contribute +updates. diff --git a/basics/install.md b/docs/install/install.md similarity index 98% rename from basics/install.md rename to docs/install/install.md index a80d6a55..1e4fb327 100644 --- a/basics/install.md +++ b/docs/install/install.md @@ -1,3 +1,12 @@ +--- +layout: default +title: Installing python modules +nav_order: 4 +parent: Installation alternatives +has_children: false +has_toc: false +--- + ## Installing GrimoireLab Python modules Most of GrimoireLab are Python modules. The easiest way of installing them is using `pip3`, diff --git a/basics/quick.md b/docs/install/quick.md similarity index 95% rename from basics/quick.md rename to docs/install/quick.md index a9179198..5a465e06 100644 --- a/basics/quick.md +++ b/docs/install/quick.md @@ -1,3 +1,12 @@ +--- +layout: default +title: Installation for the impatient +nav_order: 1 +parent: Installation alternatives +has_children: false +has_toc: false +--- + ## Installation for the impatient So you don't want to read all the details, diff --git a/basics/supporting.md b/docs/install/supporting.md similarity index 98% rename from basics/supporting.md rename to docs/install/supporting.md index 12c39259..3ec16480 100644 --- a/basics/supporting.md +++ b/docs/install/supporting.md @@ -1,3 +1,12 @@ +--- +layout: default +title: Installing supporting systems +nav_order: 3 +parent: Installation alternatives +has_children: false +has_toc: false +--- + ## Installing supporting systems GrimoireLab modules need some supporting components to work. From 0bdd22c06f808a0f95527e7c115d6ae475623bcc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Zubiaurre=20Garc=C3=ADa?= Date: Wed, 25 Oct 2023 00:48:22 +0200 Subject: [PATCH 02/10] Group SortingHat (CLI) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let's group these pages and we'll update them later! Signed-off-by: Igor Zubiaurre García --- {sortinghat => docs/sortinghat-cli}/basic.md | 8 ++++++++ {sortinghat => docs/sortinghat-cli}/data.md | 10 ++++++++++ docs/sortinghat-cli/index.md | 15 +++++++++++++++ 3 files changed, 33 insertions(+) rename {sortinghat => docs/sortinghat-cli}/basic.md (98%) rename {sortinghat => docs/sortinghat-cli}/data.md (99%) create mode 100644 docs/sortinghat-cli/index.md diff --git a/sortinghat/basic.md b/docs/sortinghat-cli/basic.md similarity index 98% rename from sortinghat/basic.md rename to docs/sortinghat-cli/basic.md index a8507e4c..7120e008 100644 --- a/sortinghat/basic.md +++ b/docs/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 diff --git a/sortinghat/data.md b/docs/sortinghat-cli/data.md similarity index 99% rename from sortinghat/data.md rename to docs/sortinghat-cli/data.md index b64d6d8b..8cf76d69 100644 --- a/sortinghat/data.md +++ b/docs/sortinghat-cli/data.md @@ -1,3 +1,13 @@ +--- +layout: default +title: SortingHat Data +nav_order: 2 +parent: SortingHat from the command line +has_children: false +has_toc: false +--- + + ## SortingHat data structure SortingHat uses a database to store data about identities. diff --git a/docs/sortinghat-cli/index.md b/docs/sortinghat-cli/index.md new file mode 100644 index 00000000..1efe75bd --- /dev/null +++ b/docs/sortinghat-cli/index.md @@ -0,0 +1,15 @@ +--- +layout: default +title: SortingHat (from the command line) +permalink: /sortinghat-cli +nav_order: 10 +has_children: true +has_toc: true +--- + +# SortingHat + +This describes the usage of SortingHat from the command line. + +SortingHat has nice, modern web interface and the command line interface +is considered legacy funcionality. From 8e27a6824a1eeed847b24a3ab316f7f31de491db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Zubiaurre=20Garc=C3=ADa?= Date: Wed, 25 Oct 2023 01:02:09 +0200 Subject: [PATCH 03/10] Group SirMordred MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let's group these pages and we'll update them later! Signed-off-by: Igor Zubiaurre García --- {sirmordred => docs/sirmordred}/container.md | 11 ++++++++++- {sirmordred => docs/sirmordred}/dashboard.md | 9 +++++++++ {sirmordred => docs/sirmordred}/files/menu.yaml | 0 .../sirmordred}/files/mordred-simple.cfg | 0 {sirmordred => docs/sirmordred}/files/projects.json | 0 docs/sirmordred/index.md | 13 +++++++++++++ {sirmordred => docs/sirmordred}/micro-mordred.md | 10 ++++++++++ {sirmordred => docs/sirmordred}/projects.md | 10 ++++++++++ 8 files changed, 52 insertions(+), 1 deletion(-) rename {sirmordred => docs/sirmordred}/container.md (98%) rename {sirmordred => docs/sirmordred}/dashboard.md (96%) rename {sirmordred => docs/sirmordred}/files/menu.yaml (100%) rename {sirmordred => docs/sirmordred}/files/mordred-simple.cfg (100%) rename {sirmordred => docs/sirmordred}/files/projects.json (100%) create mode 100644 docs/sirmordred/index.md rename {sirmordred => docs/sirmordred}/micro-mordred.md (97%) rename {sirmordred => docs/sirmordred}/projects.md (96%) diff --git a/sirmordred/container.md b/docs/sirmordred/container.md similarity index 98% rename from sirmordred/container.md rename to docs/sirmordred/container.md index 8e30cb89..901b403e 100644 --- a/sirmordred/container.md +++ b/docs/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: diff --git a/sirmordred/dashboard.md b/docs/sirmordred/dashboard.md similarity index 96% rename from sirmordred/dashboard.md rename to docs/sirmordred/dashboard.md index 9f058e9d..7d5ec6ca 100644 --- a/sirmordred/dashboard.md +++ b/docs/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) diff --git a/sirmordred/files/menu.yaml b/docs/sirmordred/files/menu.yaml similarity index 100% rename from sirmordred/files/menu.yaml rename to docs/sirmordred/files/menu.yaml diff --git a/sirmordred/files/mordred-simple.cfg b/docs/sirmordred/files/mordred-simple.cfg similarity index 100% rename from sirmordred/files/mordred-simple.cfg rename to docs/sirmordred/files/mordred-simple.cfg diff --git a/sirmordred/files/projects.json b/docs/sirmordred/files/projects.json similarity index 100% rename from sirmordred/files/projects.json rename to docs/sirmordred/files/projects.json diff --git a/docs/sirmordred/index.md b/docs/sirmordred/index.md new file mode 100644 index 00000000..1a886453 --- /dev/null +++ b/docs/sirmordred/index.md @@ -0,0 +1,13 @@ +--- +layout: default +title: Sir Mordred rules them all +permalink: /sirmordred +nav_order: 11 +has_children: true +has_toc: true +--- + +# Sir Mordred + +Mordred is the tool used to coordinate the execution of the GrimoireLab +platform. diff --git a/sirmordred/micro-mordred.md b/docs/sirmordred/micro-mordred.md similarity index 97% rename from sirmordred/micro-mordred.md rename to docs/sirmordred/micro-mordred.md index 1570d520..6a2cea95 100644 --- a/sirmordred/micro-mordred.md +++ b/docs/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? diff --git a/sirmordred/projects.md b/docs/sirmordred/projects.md similarity index 96% rename from sirmordred/projects.md rename to docs/sirmordred/projects.md index a8e489a2..9a38e721 100644 --- a/sirmordred/projects.md +++ b/docs/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. From b95ae28b85a8aaf04ddef5a498b41f24d9ef5ba5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Zubiaurre=20Garc=C3=ADa?= Date: Wed, 25 Oct 2023 01:13:56 +0200 Subject: [PATCH 04/10] Group Gelk MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let's group these pages and we'll update them later! Signed-off-by: Igor Zubiaurre García --- .../gelk}/dashboards/git-dashboard.json | 0 .../gelk}/dashboards/git-sortinghat.json | 0 .../gelk}/dashboards/github-dashboard.json | 0 .../gelk}/figs/dashboard-git-sortinghat.png | Bin .../gelk}/figs/elasticsearch-index.png | Bin {gelk => docs/gelk}/figs/kibana-dashboard.png | Bin {gelk => docs/gelk}/figs/meetup/bar-chart.png | Bin .../gelk}/figs/meetup/bubbles-chart.png | Bin .../gelk}/figs/meetup/groups-pie-chart.jpg | Bin .../gelk}/figs/meetup/index-pattern-fields.png | Bin .../gelk}/figs/meetup/kibana-metrics-viz.png | Bin .../figs/meetup/kibana-table-viz-def-1.png | Bin .../gelk}/figs/meetup/kibana_index_pattern.png | Bin .../gelk}/figs/meetup/meetings-evolution.png | Bin .../gelk}/figs/meetup/meetings-table.jpg | Bin .../meetup/meetup-stats-by-grimoirelab.jpg | Bin .../gelk}/figs/meetup/meetup-stats.jpg | Bin .../gelk}/figs/meetup/members-table.png | Bin .../gelk}/figs/meetup/pie-chart-definition.png | Bin {gelk => docs/gelk}/figs/meetup/url-field.png | Bin .../gelk}/figs/meetup/visualize-kibana.jpg | Bin .../gelk}/figs/meetup/visualize-kibana.png | Bin docs/gelk/index.md | 17 +++++++++++++++++ {gelk => docs/gelk}/intro.md | 11 ++++++++++- {gelk => docs/gelk}/kidash.md | 10 ++++++++++ {gelk => docs/gelk}/meetup.md | 0 {gelk => docs/gelk}/simple.md | 10 ++++++++++ {gelk => docs/gelk}/sortinghat.md | 9 +++++++++ 28 files changed, 56 insertions(+), 1 deletion(-) rename {gelk => docs/gelk}/dashboards/git-dashboard.json (100%) rename {gelk => docs/gelk}/dashboards/git-sortinghat.json (100%) rename {gelk => docs/gelk}/dashboards/github-dashboard.json (100%) rename {gelk => docs/gelk}/figs/dashboard-git-sortinghat.png (100%) rename {gelk => docs/gelk}/figs/elasticsearch-index.png (100%) rename {gelk => docs/gelk}/figs/kibana-dashboard.png (100%) rename {gelk => docs/gelk}/figs/meetup/bar-chart.png (100%) rename {gelk => docs/gelk}/figs/meetup/bubbles-chart.png (100%) rename {gelk => docs/gelk}/figs/meetup/groups-pie-chart.jpg (100%) rename {gelk => docs/gelk}/figs/meetup/index-pattern-fields.png (100%) rename {gelk => docs/gelk}/figs/meetup/kibana-metrics-viz.png (100%) rename {gelk => docs/gelk}/figs/meetup/kibana-table-viz-def-1.png (100%) rename {gelk => docs/gelk}/figs/meetup/kibana_index_pattern.png (100%) rename {gelk => docs/gelk}/figs/meetup/meetings-evolution.png (100%) rename {gelk => docs/gelk}/figs/meetup/meetings-table.jpg (100%) rename {gelk => docs/gelk}/figs/meetup/meetup-stats-by-grimoirelab.jpg (100%) rename {gelk => docs/gelk}/figs/meetup/meetup-stats.jpg (100%) rename {gelk => docs/gelk}/figs/meetup/members-table.png (100%) rename {gelk => docs/gelk}/figs/meetup/pie-chart-definition.png (100%) rename {gelk => docs/gelk}/figs/meetup/url-field.png (100%) rename {gelk => docs/gelk}/figs/meetup/visualize-kibana.jpg (100%) rename {gelk => docs/gelk}/figs/meetup/visualize-kibana.png (100%) create mode 100644 docs/gelk/index.md rename {gelk => docs/gelk}/intro.md (88%) rename {gelk => docs/gelk}/kidash.md (96%) rename {gelk => docs/gelk}/meetup.md (100%) rename {gelk => docs/gelk}/simple.md (97%) rename {gelk => docs/gelk}/sortinghat.md (97%) diff --git a/gelk/dashboards/git-dashboard.json b/docs/gelk/dashboards/git-dashboard.json similarity index 100% rename from gelk/dashboards/git-dashboard.json rename to docs/gelk/dashboards/git-dashboard.json diff --git a/gelk/dashboards/git-sortinghat.json b/docs/gelk/dashboards/git-sortinghat.json similarity index 100% rename from gelk/dashboards/git-sortinghat.json rename to docs/gelk/dashboards/git-sortinghat.json diff --git a/gelk/dashboards/github-dashboard.json b/docs/gelk/dashboards/github-dashboard.json similarity index 100% rename from gelk/dashboards/github-dashboard.json rename to docs/gelk/dashboards/github-dashboard.json diff --git a/gelk/figs/dashboard-git-sortinghat.png b/docs/gelk/figs/dashboard-git-sortinghat.png similarity index 100% rename from gelk/figs/dashboard-git-sortinghat.png rename to docs/gelk/figs/dashboard-git-sortinghat.png diff --git a/gelk/figs/elasticsearch-index.png b/docs/gelk/figs/elasticsearch-index.png similarity index 100% rename from gelk/figs/elasticsearch-index.png rename to docs/gelk/figs/elasticsearch-index.png diff --git a/gelk/figs/kibana-dashboard.png b/docs/gelk/figs/kibana-dashboard.png similarity index 100% rename from gelk/figs/kibana-dashboard.png rename to docs/gelk/figs/kibana-dashboard.png diff --git a/gelk/figs/meetup/bar-chart.png b/docs/gelk/figs/meetup/bar-chart.png similarity index 100% rename from gelk/figs/meetup/bar-chart.png rename to docs/gelk/figs/meetup/bar-chart.png diff --git a/gelk/figs/meetup/bubbles-chart.png b/docs/gelk/figs/meetup/bubbles-chart.png similarity index 100% rename from gelk/figs/meetup/bubbles-chart.png rename to docs/gelk/figs/meetup/bubbles-chart.png diff --git a/gelk/figs/meetup/groups-pie-chart.jpg b/docs/gelk/figs/meetup/groups-pie-chart.jpg similarity index 100% rename from gelk/figs/meetup/groups-pie-chart.jpg rename to docs/gelk/figs/meetup/groups-pie-chart.jpg diff --git a/gelk/figs/meetup/index-pattern-fields.png b/docs/gelk/figs/meetup/index-pattern-fields.png similarity index 100% rename from gelk/figs/meetup/index-pattern-fields.png rename to docs/gelk/figs/meetup/index-pattern-fields.png diff --git a/gelk/figs/meetup/kibana-metrics-viz.png b/docs/gelk/figs/meetup/kibana-metrics-viz.png similarity index 100% rename from gelk/figs/meetup/kibana-metrics-viz.png rename to docs/gelk/figs/meetup/kibana-metrics-viz.png diff --git a/gelk/figs/meetup/kibana-table-viz-def-1.png b/docs/gelk/figs/meetup/kibana-table-viz-def-1.png similarity index 100% rename from gelk/figs/meetup/kibana-table-viz-def-1.png rename to docs/gelk/figs/meetup/kibana-table-viz-def-1.png diff --git a/gelk/figs/meetup/kibana_index_pattern.png b/docs/gelk/figs/meetup/kibana_index_pattern.png similarity index 100% rename from gelk/figs/meetup/kibana_index_pattern.png rename to docs/gelk/figs/meetup/kibana_index_pattern.png diff --git a/gelk/figs/meetup/meetings-evolution.png b/docs/gelk/figs/meetup/meetings-evolution.png similarity index 100% rename from gelk/figs/meetup/meetings-evolution.png rename to docs/gelk/figs/meetup/meetings-evolution.png diff --git a/gelk/figs/meetup/meetings-table.jpg b/docs/gelk/figs/meetup/meetings-table.jpg similarity index 100% rename from gelk/figs/meetup/meetings-table.jpg rename to docs/gelk/figs/meetup/meetings-table.jpg diff --git a/gelk/figs/meetup/meetup-stats-by-grimoirelab.jpg b/docs/gelk/figs/meetup/meetup-stats-by-grimoirelab.jpg similarity index 100% rename from gelk/figs/meetup/meetup-stats-by-grimoirelab.jpg rename to docs/gelk/figs/meetup/meetup-stats-by-grimoirelab.jpg diff --git a/gelk/figs/meetup/meetup-stats.jpg b/docs/gelk/figs/meetup/meetup-stats.jpg similarity index 100% rename from gelk/figs/meetup/meetup-stats.jpg rename to docs/gelk/figs/meetup/meetup-stats.jpg diff --git a/gelk/figs/meetup/members-table.png b/docs/gelk/figs/meetup/members-table.png similarity index 100% rename from gelk/figs/meetup/members-table.png rename to docs/gelk/figs/meetup/members-table.png diff --git a/gelk/figs/meetup/pie-chart-definition.png b/docs/gelk/figs/meetup/pie-chart-definition.png similarity index 100% rename from gelk/figs/meetup/pie-chart-definition.png rename to docs/gelk/figs/meetup/pie-chart-definition.png diff --git a/gelk/figs/meetup/url-field.png b/docs/gelk/figs/meetup/url-field.png similarity index 100% rename from gelk/figs/meetup/url-field.png rename to docs/gelk/figs/meetup/url-field.png diff --git a/gelk/figs/meetup/visualize-kibana.jpg b/docs/gelk/figs/meetup/visualize-kibana.jpg similarity index 100% rename from gelk/figs/meetup/visualize-kibana.jpg rename to docs/gelk/figs/meetup/visualize-kibana.jpg diff --git a/gelk/figs/meetup/visualize-kibana.png b/docs/gelk/figs/meetup/visualize-kibana.png similarity index 100% rename from gelk/figs/meetup/visualize-kibana.png rename to docs/gelk/figs/meetup/visualize-kibana.png diff --git a/docs/gelk/index.md b/docs/gelk/index.md new file mode 100644 index 00000000..96602e69 --- /dev/null +++ b/docs/gelk/index.md @@ -0,0 +1,17 @@ +--- +layout: default +title: GrimoireELK +permalink: /gelk +nav_order: 12 +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. + diff --git a/gelk/intro.md b/docs/gelk/intro.md similarity index 88% rename from gelk/intro.md rename to docs/gelk/intro.md index d985cb6f..0d8d3ec7 100644 --- a/gelk/intro.md +++ b/docs/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. diff --git a/gelk/kidash.md b/docs/gelk/kidash.md similarity index 96% rename from gelk/kidash.md rename to docs/gelk/kidash.md index 927ae3b0..d7c646c1 100644 --- a/gelk/kidash.md +++ b/docs/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. diff --git a/gelk/meetup.md b/docs/gelk/meetup.md similarity index 100% rename from gelk/meetup.md rename to docs/gelk/meetup.md diff --git a/gelk/simple.md b/docs/gelk/simple.md similarity index 97% rename from gelk/simple.md rename to docs/gelk/simple.md index 666ed25a..83870dea 100644 --- a/gelk/simple.md +++ b/docs/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: diff --git a/gelk/sortinghat.md b/docs/gelk/sortinghat.md similarity index 97% rename from gelk/sortinghat.md rename to docs/gelk/sortinghat.md index a26fafa3..29743dff 100644 --- a/gelk/sortinghat.md +++ b/docs/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 From 6c3c802403c60a1112b0c3467fcbceb59c77e954 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Zubiaurre=20Garc=C3=ADa?= Date: Wed, 25 Oct 2023 01:25:25 +0200 Subject: [PATCH 05/10] Group Graal MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let's group these pages and we'll update them later! Signed-off-by: Igor Zubiaurre García --- {graal => docs/graal}/cocom.md | 10 +++++++ docs/graal/index.md | 23 +++++++++++++++ docs/graal/intro.md | 28 +++++++++++++++++++ .../graal}/scripts/graal_cocom_1.py | 0 graal/intro.md | 8 ------ 5 files changed, 61 insertions(+), 8 deletions(-) rename {graal => docs/graal}/cocom.md (97%) create mode 100644 docs/graal/index.md create mode 100644 docs/graal/intro.md rename {graal => docs/graal}/scripts/graal_cocom_1.py (100%) delete mode 100644 graal/intro.md diff --git a/graal/cocom.md b/docs/graal/cocom.md similarity index 97% rename from graal/cocom.md rename to docs/graal/cocom.md index b548d45e..04cf777a 100644 --- a/graal/cocom.md +++ b/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: diff --git a/docs/graal/index.md b/docs/graal/index.md new file mode 100644 index 00000000..518b9429 --- /dev/null +++ b/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. + diff --git a/docs/graal/intro.md b/docs/graal/intro.md new file mode 100644 index 00000000..111d0393 --- /dev/null +++ b/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. diff --git a/graal/scripts/graal_cocom_1.py b/docs/graal/scripts/graal_cocom_1.py similarity index 100% rename from graal/scripts/graal_cocom_1.py rename to docs/graal/scripts/graal_cocom_1.py diff --git a/graal/intro.md b/graal/intro.md deleted file mode 100644 index a2058ee1..00000000 --- a/graal/intro.md +++ /dev/null @@ -1,8 +0,0 @@ -# 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. From 74f195e355f18718a1e30810f1861675468a871c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Zubiaurre=20Garc=C3=ADa?= Date: Wed, 25 Oct 2023 01:49:02 +0200 Subject: [PATCH 06/10] Group Components MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Group components. Rename previous 'Components' section as 'Workflow'. Signed-off-by: Igor Zubiaurre García --- .../gelk/dashboards/git-dashboard.json | 0 .../gelk/dashboards/git-sortinghat.json | 0 .../gelk/dashboards/github-dashboard.json | 0 .../gelk/figs/dashboard-git-sortinghat.png | Bin .../gelk/figs/elasticsearch-index.png | Bin .../gelk/figs/kibana-dashboard.png | Bin .../gelk/figs/meetup/bar-chart.png | Bin .../gelk/figs/meetup/bubbles-chart.png | Bin .../gelk/figs/meetup/groups-pie-chart.jpg | Bin .../gelk/figs/meetup/index-pattern-fields.png | Bin .../gelk/figs/meetup/kibana-metrics-viz.png | Bin .../figs/meetup/kibana-table-viz-def-1.png | Bin .../gelk/figs/meetup/kibana_index_pattern.png | Bin .../gelk/figs/meetup/meetings-evolution.png | Bin .../gelk/figs/meetup/meetings-table.jpg | Bin .../meetup/meetup-stats-by-grimoirelab.jpg | Bin .../gelk/figs/meetup/meetup-stats.jpg | Bin .../gelk/figs/meetup/members-table.png | Bin .../gelk/figs/meetup/pie-chart-definition.png | Bin .../gelk/figs/meetup/url-field.png | Bin .../gelk/figs/meetup/visualize-kibana.jpg | Bin .../gelk/figs/meetup/visualize-kibana.png | Bin docs/{ => components}/gelk/index.md | 3 +- docs/{ => components}/gelk/intro.md | 0 docs/{ => components}/gelk/kidash.md | 0 docs/{ => components}/gelk/meetup.md | 0 docs/{ => components}/gelk/simple.md | 0 docs/{ => components}/gelk/sortinghat.md | 0 docs/{ => components}/graal/cocom.md | 0 docs/{ => components}/graal/index.md | 3 +- docs/{ => components}/graal/intro.md | 0 .../graal/scripts/graal_cocom_1.py | 0 docs/components/index.md | 43 +-------------- .../components/manuscripts}/first.md | 10 ++++ docs/components/manuscripts/index.md | 14 +++++ docs/{ => components}/sirmordred/container.md | 0 docs/{ => components}/sirmordred/dashboard.md | 0 .../sirmordred/files/menu.yaml | 0 .../sirmordred/files/mordred-simple.cfg | 0 .../sirmordred/files/projects.json | 0 docs/{ => components}/sirmordred/index.md | 3 +- .../sirmordred/micro-mordred.md | 0 docs/{ => components}/sirmordred/projects.md | 0 docs/{ => components}/sortinghat-cli/basic.md | 0 docs/{ => components}/sortinghat-cli/data.md | 0 docs/{ => components}/sortinghat-cli/index.md | 3 +- .../assets/grimoirelab-all-complete.png | Bin .../assets/grimoirelab-all-complete.svg | 0 ...board-noarthur-nomordred-nopanels-nosh.png | Bin ...board-noarthur-nomordred-nopanels-nosh.svg | 0 ...-dashboard-noarthur-nomordred-nopanels.png | Bin ...-dashboard-noarthur-nomordred-nopanels.svg | 0 ...relab-all-dashboard-noarthur-nomordred.png | Bin ...relab-all-dashboard-noarthur-nomordred.svg | 0 .../grimoirelab-all-dashboard-noarthur.png | Bin .../grimoirelab-all-dashboard-noarthur.svg | 0 .../assets/grimoirelab-all-dashboard.png | Bin .../assets/grimoirelab-all-dashboard.svg | 0 .../assets/grimoirelab-all-everything.svg | 0 .../grimoirelab-all-grimoireelk-enrich-sh.svg | 0 .../grimoirelab-all-grimoireelk-enrich.svg | 0 .../grimoirelab-all-grimoireelk-raw.png | Bin .../grimoirelab-all-grimoireelk-raw.svg | 0 .../assets/grimoirelab-all-perceval-1.png | Bin .../assets/grimoirelab-all-perceval-1.svg | 0 .../assets/grimoirelab-all-perceval-n.png | Bin .../assets/grimoirelab-all-perceval-n.svg | 0 .../assets/grimoirelab-all-reports.png | Bin .../assets/grimoirelab-all-reports.svg | 0 .../grimoirelab-fit-grimoireelk-enrich-sh.png | Bin .../grimoirelab-fit-grimoireelk-enrich-sh.svg | 0 .../grimoirelab-fit-grimoireelk-enrich.png | Bin .../grimoirelab-fit-grimoireelk-enrich.svg | 0 .../grimoirelab-fit-grimoireelk-raw.png | Bin .../grimoirelab-fit-grimoireelk-raw.svg | 0 .../assets/grimoirelab-fit-perceval-1.png | Bin .../assets/grimoirelab-fit-perceval-1.svg | 0 .../assets/grimoirelab-fit-perceval-n.png | Bin .../assets/grimoirelab-fit-perceval-n.svg | 0 docs/workflow/index.md | 50 ++++++++++++++++++ docs/{components => workflow}/scenarios.md | 2 +- docs/{components => workflow}/workflow.md | 2 +- index.md | 2 +- 83 files changed, 86 insertions(+), 49 deletions(-) rename docs/{ => components}/gelk/dashboards/git-dashboard.json (100%) rename docs/{ => components}/gelk/dashboards/git-sortinghat.json (100%) rename docs/{ => components}/gelk/dashboards/github-dashboard.json (100%) rename docs/{ => components}/gelk/figs/dashboard-git-sortinghat.png (100%) rename docs/{ => components}/gelk/figs/elasticsearch-index.png (100%) rename docs/{ => components}/gelk/figs/kibana-dashboard.png (100%) rename docs/{ => components}/gelk/figs/meetup/bar-chart.png (100%) rename docs/{ => components}/gelk/figs/meetup/bubbles-chart.png (100%) rename docs/{ => components}/gelk/figs/meetup/groups-pie-chart.jpg (100%) rename docs/{ => components}/gelk/figs/meetup/index-pattern-fields.png (100%) rename docs/{ => components}/gelk/figs/meetup/kibana-metrics-viz.png (100%) rename docs/{ => components}/gelk/figs/meetup/kibana-table-viz-def-1.png (100%) rename docs/{ => components}/gelk/figs/meetup/kibana_index_pattern.png (100%) rename docs/{ => components}/gelk/figs/meetup/meetings-evolution.png (100%) rename docs/{ => components}/gelk/figs/meetup/meetings-table.jpg (100%) rename docs/{ => components}/gelk/figs/meetup/meetup-stats-by-grimoirelab.jpg (100%) rename docs/{ => components}/gelk/figs/meetup/meetup-stats.jpg (100%) rename docs/{ => components}/gelk/figs/meetup/members-table.png (100%) rename docs/{ => components}/gelk/figs/meetup/pie-chart-definition.png (100%) rename docs/{ => components}/gelk/figs/meetup/url-field.png (100%) rename docs/{ => components}/gelk/figs/meetup/visualize-kibana.jpg (100%) rename docs/{ => components}/gelk/figs/meetup/visualize-kibana.png (100%) rename docs/{ => components}/gelk/index.md (92%) rename docs/{ => components}/gelk/intro.md (100%) rename docs/{ => components}/gelk/kidash.md (100%) rename docs/{ => components}/gelk/meetup.md (100%) rename docs/{ => components}/gelk/simple.md (100%) rename docs/{ => components}/gelk/sortinghat.md (100%) rename docs/{ => components}/graal/cocom.md (100%) rename docs/{ => components}/graal/index.md (95%) rename docs/{ => components}/graal/intro.md (100%) rename docs/{ => components}/graal/scripts/graal_cocom_1.py (100%) rename {manuscripts => docs/components/manuscripts}/first.md (90%) create mode 100644 docs/components/manuscripts/index.md rename docs/{ => components}/sirmordred/container.md (100%) rename docs/{ => components}/sirmordred/dashboard.md (100%) rename docs/{ => components}/sirmordred/files/menu.yaml (100%) rename docs/{ => components}/sirmordred/files/mordred-simple.cfg (100%) rename docs/{ => components}/sirmordred/files/projects.json (100%) rename docs/{ => components}/sirmordred/index.md (86%) rename docs/{ => components}/sirmordred/micro-mordred.md (100%) rename docs/{ => components}/sirmordred/projects.md (100%) rename docs/{ => components}/sortinghat-cli/basic.md (100%) rename docs/{ => components}/sortinghat-cli/data.md (100%) rename docs/{ => components}/sortinghat-cli/index.md (90%) rename docs/{components => workflow}/assets/grimoirelab-all-complete.png (100%) rename docs/{components => workflow}/assets/grimoirelab-all-complete.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels-nosh.png (100%) rename docs/{components => workflow}/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels-nosh.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels.png (100%) rename docs/{components => workflow}/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-all-dashboard-noarthur-nomordred.png (100%) rename docs/{components => workflow}/assets/grimoirelab-all-dashboard-noarthur-nomordred.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-all-dashboard-noarthur.png (100%) rename docs/{components => workflow}/assets/grimoirelab-all-dashboard-noarthur.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-all-dashboard.png (100%) rename docs/{components => workflow}/assets/grimoirelab-all-dashboard.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-all-everything.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-all-grimoireelk-enrich-sh.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-all-grimoireelk-enrich.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-all-grimoireelk-raw.png (100%) rename docs/{components => workflow}/assets/grimoirelab-all-grimoireelk-raw.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-all-perceval-1.png (100%) rename docs/{components => workflow}/assets/grimoirelab-all-perceval-1.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-all-perceval-n.png (100%) rename docs/{components => workflow}/assets/grimoirelab-all-perceval-n.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-all-reports.png (100%) rename docs/{components => workflow}/assets/grimoirelab-all-reports.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-fit-grimoireelk-enrich-sh.png (100%) rename docs/{components => workflow}/assets/grimoirelab-fit-grimoireelk-enrich-sh.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-fit-grimoireelk-enrich.png (100%) rename docs/{components => workflow}/assets/grimoirelab-fit-grimoireelk-enrich.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-fit-grimoireelk-raw.png (100%) rename docs/{components => workflow}/assets/grimoirelab-fit-grimoireelk-raw.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-fit-perceval-1.png (100%) rename docs/{components => workflow}/assets/grimoirelab-fit-perceval-1.svg (100%) rename docs/{components => workflow}/assets/grimoirelab-fit-perceval-n.png (100%) rename docs/{components => workflow}/assets/grimoirelab-fit-perceval-n.svg (100%) create mode 100644 docs/workflow/index.md rename docs/{components => workflow}/scenarios.md (99%) rename docs/{components => workflow}/workflow.md (99%) diff --git a/docs/gelk/dashboards/git-dashboard.json b/docs/components/gelk/dashboards/git-dashboard.json similarity index 100% rename from docs/gelk/dashboards/git-dashboard.json rename to docs/components/gelk/dashboards/git-dashboard.json diff --git a/docs/gelk/dashboards/git-sortinghat.json b/docs/components/gelk/dashboards/git-sortinghat.json similarity index 100% rename from docs/gelk/dashboards/git-sortinghat.json rename to docs/components/gelk/dashboards/git-sortinghat.json diff --git a/docs/gelk/dashboards/github-dashboard.json b/docs/components/gelk/dashboards/github-dashboard.json similarity index 100% rename from docs/gelk/dashboards/github-dashboard.json rename to docs/components/gelk/dashboards/github-dashboard.json diff --git a/docs/gelk/figs/dashboard-git-sortinghat.png b/docs/components/gelk/figs/dashboard-git-sortinghat.png similarity index 100% rename from docs/gelk/figs/dashboard-git-sortinghat.png rename to docs/components/gelk/figs/dashboard-git-sortinghat.png diff --git a/docs/gelk/figs/elasticsearch-index.png b/docs/components/gelk/figs/elasticsearch-index.png similarity index 100% rename from docs/gelk/figs/elasticsearch-index.png rename to docs/components/gelk/figs/elasticsearch-index.png diff --git a/docs/gelk/figs/kibana-dashboard.png b/docs/components/gelk/figs/kibana-dashboard.png similarity index 100% rename from docs/gelk/figs/kibana-dashboard.png rename to docs/components/gelk/figs/kibana-dashboard.png diff --git a/docs/gelk/figs/meetup/bar-chart.png b/docs/components/gelk/figs/meetup/bar-chart.png similarity index 100% rename from docs/gelk/figs/meetup/bar-chart.png rename to docs/components/gelk/figs/meetup/bar-chart.png diff --git a/docs/gelk/figs/meetup/bubbles-chart.png b/docs/components/gelk/figs/meetup/bubbles-chart.png similarity index 100% rename from docs/gelk/figs/meetup/bubbles-chart.png rename to docs/components/gelk/figs/meetup/bubbles-chart.png diff --git a/docs/gelk/figs/meetup/groups-pie-chart.jpg b/docs/components/gelk/figs/meetup/groups-pie-chart.jpg similarity index 100% rename from docs/gelk/figs/meetup/groups-pie-chart.jpg rename to docs/components/gelk/figs/meetup/groups-pie-chart.jpg diff --git a/docs/gelk/figs/meetup/index-pattern-fields.png b/docs/components/gelk/figs/meetup/index-pattern-fields.png similarity index 100% rename from docs/gelk/figs/meetup/index-pattern-fields.png rename to docs/components/gelk/figs/meetup/index-pattern-fields.png diff --git a/docs/gelk/figs/meetup/kibana-metrics-viz.png b/docs/components/gelk/figs/meetup/kibana-metrics-viz.png similarity index 100% rename from docs/gelk/figs/meetup/kibana-metrics-viz.png rename to docs/components/gelk/figs/meetup/kibana-metrics-viz.png diff --git a/docs/gelk/figs/meetup/kibana-table-viz-def-1.png b/docs/components/gelk/figs/meetup/kibana-table-viz-def-1.png similarity index 100% rename from docs/gelk/figs/meetup/kibana-table-viz-def-1.png rename to docs/components/gelk/figs/meetup/kibana-table-viz-def-1.png diff --git a/docs/gelk/figs/meetup/kibana_index_pattern.png b/docs/components/gelk/figs/meetup/kibana_index_pattern.png similarity index 100% rename from docs/gelk/figs/meetup/kibana_index_pattern.png rename to docs/components/gelk/figs/meetup/kibana_index_pattern.png diff --git a/docs/gelk/figs/meetup/meetings-evolution.png b/docs/components/gelk/figs/meetup/meetings-evolution.png similarity index 100% rename from docs/gelk/figs/meetup/meetings-evolution.png rename to docs/components/gelk/figs/meetup/meetings-evolution.png diff --git a/docs/gelk/figs/meetup/meetings-table.jpg b/docs/components/gelk/figs/meetup/meetings-table.jpg similarity index 100% rename from docs/gelk/figs/meetup/meetings-table.jpg rename to docs/components/gelk/figs/meetup/meetings-table.jpg diff --git a/docs/gelk/figs/meetup/meetup-stats-by-grimoirelab.jpg b/docs/components/gelk/figs/meetup/meetup-stats-by-grimoirelab.jpg similarity index 100% rename from docs/gelk/figs/meetup/meetup-stats-by-grimoirelab.jpg rename to docs/components/gelk/figs/meetup/meetup-stats-by-grimoirelab.jpg diff --git a/docs/gelk/figs/meetup/meetup-stats.jpg b/docs/components/gelk/figs/meetup/meetup-stats.jpg similarity index 100% rename from docs/gelk/figs/meetup/meetup-stats.jpg rename to docs/components/gelk/figs/meetup/meetup-stats.jpg diff --git a/docs/gelk/figs/meetup/members-table.png b/docs/components/gelk/figs/meetup/members-table.png similarity index 100% rename from docs/gelk/figs/meetup/members-table.png rename to docs/components/gelk/figs/meetup/members-table.png diff --git a/docs/gelk/figs/meetup/pie-chart-definition.png b/docs/components/gelk/figs/meetup/pie-chart-definition.png similarity index 100% rename from docs/gelk/figs/meetup/pie-chart-definition.png rename to docs/components/gelk/figs/meetup/pie-chart-definition.png diff --git a/docs/gelk/figs/meetup/url-field.png b/docs/components/gelk/figs/meetup/url-field.png similarity index 100% rename from docs/gelk/figs/meetup/url-field.png rename to docs/components/gelk/figs/meetup/url-field.png diff --git a/docs/gelk/figs/meetup/visualize-kibana.jpg b/docs/components/gelk/figs/meetup/visualize-kibana.jpg similarity index 100% rename from docs/gelk/figs/meetup/visualize-kibana.jpg rename to docs/components/gelk/figs/meetup/visualize-kibana.jpg diff --git a/docs/gelk/figs/meetup/visualize-kibana.png b/docs/components/gelk/figs/meetup/visualize-kibana.png similarity index 100% rename from docs/gelk/figs/meetup/visualize-kibana.png rename to docs/components/gelk/figs/meetup/visualize-kibana.png diff --git a/docs/gelk/index.md b/docs/components/gelk/index.md similarity index 92% rename from docs/gelk/index.md rename to docs/components/gelk/index.md index 96602e69..667e3789 100644 --- a/docs/gelk/index.md +++ b/docs/components/gelk/index.md @@ -2,7 +2,8 @@ layout: default title: GrimoireELK permalink: /gelk -nav_order: 12 +nav_order: 1 +parent: Components has_children: true has_toc: true --- diff --git a/docs/gelk/intro.md b/docs/components/gelk/intro.md similarity index 100% rename from docs/gelk/intro.md rename to docs/components/gelk/intro.md diff --git a/docs/gelk/kidash.md b/docs/components/gelk/kidash.md similarity index 100% rename from docs/gelk/kidash.md rename to docs/components/gelk/kidash.md diff --git a/docs/gelk/meetup.md b/docs/components/gelk/meetup.md similarity index 100% rename from docs/gelk/meetup.md rename to docs/components/gelk/meetup.md diff --git a/docs/gelk/simple.md b/docs/components/gelk/simple.md similarity index 100% rename from docs/gelk/simple.md rename to docs/components/gelk/simple.md diff --git a/docs/gelk/sortinghat.md b/docs/components/gelk/sortinghat.md similarity index 100% rename from docs/gelk/sortinghat.md rename to docs/components/gelk/sortinghat.md diff --git a/docs/graal/cocom.md b/docs/components/graal/cocom.md similarity index 100% rename from docs/graal/cocom.md rename to docs/components/graal/cocom.md diff --git a/docs/graal/index.md b/docs/components/graal/index.md similarity index 95% rename from docs/graal/index.md rename to docs/components/graal/index.md index 518b9429..bb519a1a 100644 --- a/docs/graal/index.md +++ b/docs/components/graal/index.md @@ -2,7 +2,8 @@ layout: default title: Graal permalink: /graal -nav_order: 14 +nav_order: 5 +parent: Components has_children: true has_toc: true --- diff --git a/docs/graal/intro.md b/docs/components/graal/intro.md similarity index 100% rename from docs/graal/intro.md rename to docs/components/graal/intro.md diff --git a/docs/graal/scripts/graal_cocom_1.py b/docs/components/graal/scripts/graal_cocom_1.py similarity index 100% rename from docs/graal/scripts/graal_cocom_1.py rename to docs/components/graal/scripts/graal_cocom_1.py diff --git a/docs/components/index.md b/docs/components/index.md index 850e950d..4301ca29 100644 --- a/docs/components/index.md +++ b/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 diff --git a/manuscripts/first.md b/docs/components/manuscripts/first.md similarity index 90% rename from manuscripts/first.md rename to docs/components/manuscripts/first.md index d21e315b..8db14669 100644 --- a/manuscripts/first.md +++ b/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 diff --git a/docs/components/manuscripts/index.md b/docs/components/manuscripts/index.md new file mode 100644 index 00000000..1e8edbd8 --- /dev/null +++ b/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. diff --git a/docs/sirmordred/container.md b/docs/components/sirmordred/container.md similarity index 100% rename from docs/sirmordred/container.md rename to docs/components/sirmordred/container.md diff --git a/docs/sirmordred/dashboard.md b/docs/components/sirmordred/dashboard.md similarity index 100% rename from docs/sirmordred/dashboard.md rename to docs/components/sirmordred/dashboard.md diff --git a/docs/sirmordred/files/menu.yaml b/docs/components/sirmordred/files/menu.yaml similarity index 100% rename from docs/sirmordred/files/menu.yaml rename to docs/components/sirmordred/files/menu.yaml diff --git a/docs/sirmordred/files/mordred-simple.cfg b/docs/components/sirmordred/files/mordred-simple.cfg similarity index 100% rename from docs/sirmordred/files/mordred-simple.cfg rename to docs/components/sirmordred/files/mordred-simple.cfg diff --git a/docs/sirmordred/files/projects.json b/docs/components/sirmordred/files/projects.json similarity index 100% rename from docs/sirmordred/files/projects.json rename to docs/components/sirmordred/files/projects.json diff --git a/docs/sirmordred/index.md b/docs/components/sirmordred/index.md similarity index 86% rename from docs/sirmordred/index.md rename to docs/components/sirmordred/index.md index 1a886453..66f508e5 100644 --- a/docs/sirmordred/index.md +++ b/docs/components/sirmordred/index.md @@ -2,7 +2,8 @@ layout: default title: Sir Mordred rules them all permalink: /sirmordred -nav_order: 11 +nav_order: 2 +parent: Components has_children: true has_toc: true --- diff --git a/docs/sirmordred/micro-mordred.md b/docs/components/sirmordred/micro-mordred.md similarity index 100% rename from docs/sirmordred/micro-mordred.md rename to docs/components/sirmordred/micro-mordred.md diff --git a/docs/sirmordred/projects.md b/docs/components/sirmordred/projects.md similarity index 100% rename from docs/sirmordred/projects.md rename to docs/components/sirmordred/projects.md diff --git a/docs/sortinghat-cli/basic.md b/docs/components/sortinghat-cli/basic.md similarity index 100% rename from docs/sortinghat-cli/basic.md rename to docs/components/sortinghat-cli/basic.md diff --git a/docs/sortinghat-cli/data.md b/docs/components/sortinghat-cli/data.md similarity index 100% rename from docs/sortinghat-cli/data.md rename to docs/components/sortinghat-cli/data.md diff --git a/docs/sortinghat-cli/index.md b/docs/components/sortinghat-cli/index.md similarity index 90% rename from docs/sortinghat-cli/index.md rename to docs/components/sortinghat-cli/index.md index 1efe75bd..a13cfc86 100644 --- a/docs/sortinghat-cli/index.md +++ b/docs/components/sortinghat-cli/index.md @@ -2,7 +2,8 @@ layout: default title: SortingHat (from the command line) permalink: /sortinghat-cli -nav_order: 10 +nav_order: 3 +parent: Components has_children: true has_toc: true --- diff --git a/docs/components/assets/grimoirelab-all-complete.png b/docs/workflow/assets/grimoirelab-all-complete.png similarity index 100% rename from docs/components/assets/grimoirelab-all-complete.png rename to docs/workflow/assets/grimoirelab-all-complete.png diff --git a/docs/components/assets/grimoirelab-all-complete.svg b/docs/workflow/assets/grimoirelab-all-complete.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-complete.svg rename to docs/workflow/assets/grimoirelab-all-complete.svg diff --git a/docs/components/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels-nosh.png b/docs/workflow/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels-nosh.png similarity index 100% rename from docs/components/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels-nosh.png rename to docs/workflow/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels-nosh.png diff --git a/docs/components/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels-nosh.svg b/docs/workflow/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels-nosh.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels-nosh.svg rename to docs/workflow/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels-nosh.svg diff --git a/docs/components/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels.png b/docs/workflow/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels.png similarity index 100% rename from docs/components/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels.png rename to docs/workflow/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels.png diff --git a/docs/components/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels.svg b/docs/workflow/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels.svg rename to docs/workflow/assets/grimoirelab-all-dashboard-noarthur-nomordred-nopanels.svg diff --git a/docs/components/assets/grimoirelab-all-dashboard-noarthur-nomordred.png b/docs/workflow/assets/grimoirelab-all-dashboard-noarthur-nomordred.png similarity index 100% rename from docs/components/assets/grimoirelab-all-dashboard-noarthur-nomordred.png rename to docs/workflow/assets/grimoirelab-all-dashboard-noarthur-nomordred.png diff --git a/docs/components/assets/grimoirelab-all-dashboard-noarthur-nomordred.svg b/docs/workflow/assets/grimoirelab-all-dashboard-noarthur-nomordred.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-dashboard-noarthur-nomordred.svg rename to docs/workflow/assets/grimoirelab-all-dashboard-noarthur-nomordred.svg diff --git a/docs/components/assets/grimoirelab-all-dashboard-noarthur.png b/docs/workflow/assets/grimoirelab-all-dashboard-noarthur.png similarity index 100% rename from docs/components/assets/grimoirelab-all-dashboard-noarthur.png rename to docs/workflow/assets/grimoirelab-all-dashboard-noarthur.png diff --git a/docs/components/assets/grimoirelab-all-dashboard-noarthur.svg b/docs/workflow/assets/grimoirelab-all-dashboard-noarthur.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-dashboard-noarthur.svg rename to docs/workflow/assets/grimoirelab-all-dashboard-noarthur.svg diff --git a/docs/components/assets/grimoirelab-all-dashboard.png b/docs/workflow/assets/grimoirelab-all-dashboard.png similarity index 100% rename from docs/components/assets/grimoirelab-all-dashboard.png rename to docs/workflow/assets/grimoirelab-all-dashboard.png diff --git a/docs/components/assets/grimoirelab-all-dashboard.svg b/docs/workflow/assets/grimoirelab-all-dashboard.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-dashboard.svg rename to docs/workflow/assets/grimoirelab-all-dashboard.svg diff --git a/docs/components/assets/grimoirelab-all-everything.svg b/docs/workflow/assets/grimoirelab-all-everything.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-everything.svg rename to docs/workflow/assets/grimoirelab-all-everything.svg diff --git a/docs/components/assets/grimoirelab-all-grimoireelk-enrich-sh.svg b/docs/workflow/assets/grimoirelab-all-grimoireelk-enrich-sh.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-grimoireelk-enrich-sh.svg rename to docs/workflow/assets/grimoirelab-all-grimoireelk-enrich-sh.svg diff --git a/docs/components/assets/grimoirelab-all-grimoireelk-enrich.svg b/docs/workflow/assets/grimoirelab-all-grimoireelk-enrich.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-grimoireelk-enrich.svg rename to docs/workflow/assets/grimoirelab-all-grimoireelk-enrich.svg diff --git a/docs/components/assets/grimoirelab-all-grimoireelk-raw.png b/docs/workflow/assets/grimoirelab-all-grimoireelk-raw.png similarity index 100% rename from docs/components/assets/grimoirelab-all-grimoireelk-raw.png rename to docs/workflow/assets/grimoirelab-all-grimoireelk-raw.png diff --git a/docs/components/assets/grimoirelab-all-grimoireelk-raw.svg b/docs/workflow/assets/grimoirelab-all-grimoireelk-raw.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-grimoireelk-raw.svg rename to docs/workflow/assets/grimoirelab-all-grimoireelk-raw.svg diff --git a/docs/components/assets/grimoirelab-all-perceval-1.png b/docs/workflow/assets/grimoirelab-all-perceval-1.png similarity index 100% rename from docs/components/assets/grimoirelab-all-perceval-1.png rename to docs/workflow/assets/grimoirelab-all-perceval-1.png diff --git a/docs/components/assets/grimoirelab-all-perceval-1.svg b/docs/workflow/assets/grimoirelab-all-perceval-1.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-perceval-1.svg rename to docs/workflow/assets/grimoirelab-all-perceval-1.svg diff --git a/docs/components/assets/grimoirelab-all-perceval-n.png b/docs/workflow/assets/grimoirelab-all-perceval-n.png similarity index 100% rename from docs/components/assets/grimoirelab-all-perceval-n.png rename to docs/workflow/assets/grimoirelab-all-perceval-n.png diff --git a/docs/components/assets/grimoirelab-all-perceval-n.svg b/docs/workflow/assets/grimoirelab-all-perceval-n.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-perceval-n.svg rename to docs/workflow/assets/grimoirelab-all-perceval-n.svg diff --git a/docs/components/assets/grimoirelab-all-reports.png b/docs/workflow/assets/grimoirelab-all-reports.png similarity index 100% rename from docs/components/assets/grimoirelab-all-reports.png rename to docs/workflow/assets/grimoirelab-all-reports.png diff --git a/docs/components/assets/grimoirelab-all-reports.svg b/docs/workflow/assets/grimoirelab-all-reports.svg similarity index 100% rename from docs/components/assets/grimoirelab-all-reports.svg rename to docs/workflow/assets/grimoirelab-all-reports.svg diff --git a/docs/components/assets/grimoirelab-fit-grimoireelk-enrich-sh.png b/docs/workflow/assets/grimoirelab-fit-grimoireelk-enrich-sh.png similarity index 100% rename from docs/components/assets/grimoirelab-fit-grimoireelk-enrich-sh.png rename to docs/workflow/assets/grimoirelab-fit-grimoireelk-enrich-sh.png diff --git a/docs/components/assets/grimoirelab-fit-grimoireelk-enrich-sh.svg b/docs/workflow/assets/grimoirelab-fit-grimoireelk-enrich-sh.svg similarity index 100% rename from docs/components/assets/grimoirelab-fit-grimoireelk-enrich-sh.svg rename to docs/workflow/assets/grimoirelab-fit-grimoireelk-enrich-sh.svg diff --git a/docs/components/assets/grimoirelab-fit-grimoireelk-enrich.png b/docs/workflow/assets/grimoirelab-fit-grimoireelk-enrich.png similarity index 100% rename from docs/components/assets/grimoirelab-fit-grimoireelk-enrich.png rename to docs/workflow/assets/grimoirelab-fit-grimoireelk-enrich.png diff --git a/docs/components/assets/grimoirelab-fit-grimoireelk-enrich.svg b/docs/workflow/assets/grimoirelab-fit-grimoireelk-enrich.svg similarity index 100% rename from docs/components/assets/grimoirelab-fit-grimoireelk-enrich.svg rename to docs/workflow/assets/grimoirelab-fit-grimoireelk-enrich.svg diff --git a/docs/components/assets/grimoirelab-fit-grimoireelk-raw.png b/docs/workflow/assets/grimoirelab-fit-grimoireelk-raw.png similarity index 100% rename from docs/components/assets/grimoirelab-fit-grimoireelk-raw.png rename to docs/workflow/assets/grimoirelab-fit-grimoireelk-raw.png diff --git a/docs/components/assets/grimoirelab-fit-grimoireelk-raw.svg b/docs/workflow/assets/grimoirelab-fit-grimoireelk-raw.svg similarity index 100% rename from docs/components/assets/grimoirelab-fit-grimoireelk-raw.svg rename to docs/workflow/assets/grimoirelab-fit-grimoireelk-raw.svg diff --git a/docs/components/assets/grimoirelab-fit-perceval-1.png b/docs/workflow/assets/grimoirelab-fit-perceval-1.png similarity index 100% rename from docs/components/assets/grimoirelab-fit-perceval-1.png rename to docs/workflow/assets/grimoirelab-fit-perceval-1.png diff --git a/docs/components/assets/grimoirelab-fit-perceval-1.svg b/docs/workflow/assets/grimoirelab-fit-perceval-1.svg similarity index 100% rename from docs/components/assets/grimoirelab-fit-perceval-1.svg rename to docs/workflow/assets/grimoirelab-fit-perceval-1.svg diff --git a/docs/components/assets/grimoirelab-fit-perceval-n.png b/docs/workflow/assets/grimoirelab-fit-perceval-n.png similarity index 100% rename from docs/components/assets/grimoirelab-fit-perceval-n.png rename to docs/workflow/assets/grimoirelab-fit-perceval-n.png diff --git a/docs/components/assets/grimoirelab-fit-perceval-n.svg b/docs/workflow/assets/grimoirelab-fit-perceval-n.svg similarity index 100% rename from docs/components/assets/grimoirelab-fit-perceval-n.svg rename to docs/workflow/assets/grimoirelab-fit-perceval-n.svg diff --git a/docs/workflow/index.md b/docs/workflow/index.md new file mode 100644 index 00000000..a58e3683 --- /dev/null +++ b/docs/workflow/index.md @@ -0,0 +1,50 @@ +--- +layout: default +title: Workflow +permalink: /workflow +nav_order: 2 +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 diff --git a/docs/components/scenarios.md b/docs/workflow/scenarios.md similarity index 99% rename from docs/components/scenarios.md rename to docs/workflow/scenarios.md index 978d20cf..6643b534 100644 --- a/docs/components/scenarios.md +++ b/docs/workflow/scenarios.md @@ -2,7 +2,7 @@ layout: default title: Scenarios nav_order: 2 -parent: Components +parent: Workflow --- # GrimoireLab scenarios diff --git a/docs/components/workflow.md b/docs/workflow/workflow.md similarity index 99% rename from docs/components/workflow.md rename to docs/workflow/workflow.md index 8ccedd8c..726f3109 100644 --- a/docs/components/workflow.md +++ b/docs/workflow/workflow.md @@ -2,7 +2,7 @@ layout: default title: Workflow nav_order: 1 -parent: Components +parent: Workflow --- # Workflow diff --git a/index.md b/index.md index 0791dfdf..0cc4b443 100644 --- a/index.md +++ b/index.md @@ -34,7 +34,7 @@ Gerrit, Launchpad, Jira, mailing lists, Confluence, Discourse, Slack, Jenkins, Meetup, Mediawiki, Phabricator, Redmine, StackOverflow, Telegram, and others. Let´s now visit the main functionalities provided by GrimoireLab. The section -[Components]({{ site.baseurl }}/components) shows how the different components +[Workflow]({{ site.baseurl }}/workflow) shows how the different components in GrimoireLab are combined to provide these functionalities. ### Data retrieval From d5f1f2796010eda76a9485c97e6e02edad28382e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Zubiaurre=20Garc=C3=ADa?= Date: Wed, 25 Oct 2023 11:44:01 +0200 Subject: [PATCH 07/10] Group Python scripting MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let's group these pages and we'll update them later! Signed-off-by: Igor Zubiaurre García --- {python => docs/python}/es-dsl.md | 10 ++++++++++ {python => docs/python}/es.md | 10 ++++++++++ docs/python/index.md | 13 +++++++++++++ {python => docs/python}/indexes.md | 10 ++++++++++ {python => docs/python}/pandas.md | 12 +++++++++++- {python => docs/python}/querying.md | 10 ++++++++++ docs/python/scripting.md | 15 +++++++++++++++ {python => docs/python}/scripts/cleanup.py | 0 .../python}/scripts/enriched_elasticsearch_1.py | 0 {python => docs/python}/scripts/pandas_1.py | 0 .../python}/scripts/perceval_elasticsearch_1.py | 0 .../python}/scripts/perceval_elasticsearch_2.py | 0 .../python}/scripts/perceval_elasticsearch_3.py | 0 .../python}/scripts/perceval_elasticsearch_4.py | 0 .../scripts/perceval_elasticsearch_git_dsl.py | 0 .../scripts/perceval_elasticsearch_git_dsl_2.py | 0 .../scripts/perceval_elasticsearch_git_dsl_3.py | 0 .../scripts/perceval_elasticsearch_mbox_1.py | 0 .../scripts/perceval_elasticsearch_mbox_2.py | 0 .../scripts/perceval_elasticsearch_mbox_3.py | 0 python/scripting.md | 3 --- 21 files changed, 79 insertions(+), 4 deletions(-) rename {python => docs/python}/es-dsl.md (97%) rename {python => docs/python}/es.md (98%) create mode 100644 docs/python/index.md rename {python => docs/python}/indexes.md (96%) rename {python => docs/python}/pandas.md (98%) rename {python => docs/python}/querying.md (96%) create mode 100644 docs/python/scripting.md rename {python => docs/python}/scripts/cleanup.py (100%) rename {python => docs/python}/scripts/enriched_elasticsearch_1.py (100%) rename {python => docs/python}/scripts/pandas_1.py (100%) rename {python => docs/python}/scripts/perceval_elasticsearch_1.py (100%) rename {python => docs/python}/scripts/perceval_elasticsearch_2.py (100%) rename {python => docs/python}/scripts/perceval_elasticsearch_3.py (100%) rename {python => docs/python}/scripts/perceval_elasticsearch_4.py (100%) rename {python => docs/python}/scripts/perceval_elasticsearch_git_dsl.py (100%) rename {python => docs/python}/scripts/perceval_elasticsearch_git_dsl_2.py (100%) rename {python => docs/python}/scripts/perceval_elasticsearch_git_dsl_3.py (100%) rename {python => docs/python}/scripts/perceval_elasticsearch_mbox_1.py (100%) rename {python => docs/python}/scripts/perceval_elasticsearch_mbox_2.py (100%) rename {python => docs/python}/scripts/perceval_elasticsearch_mbox_3.py (100%) delete mode 100644 python/scripting.md diff --git a/python/es-dsl.md b/docs/python/es-dsl.md similarity index 97% rename from python/es-dsl.md rename to docs/python/es-dsl.md index 79f9af48..03cd7eec 100644 --- a/python/es-dsl.md +++ b/docs/python/es-dsl.md @@ -1,3 +1,13 @@ +--- +layout: default +title: ElasticSearch DSL +nav_order: 2 +parent: Python scripting +has_children: false +has_toc: false +--- + + ## ElasticSearch DSL The `elasticsearch` Python module may seem good enough to query ElasticSearch via its REST API. But for using it, we need to write full JSON documents with the intended queries. And these documents may become large, complex, and a burden to maintain and understand. Here is where the [`elasticsearch_dsl` Python module](http://elasticsearch-dsl.readthedocs.io) comes to the rescue. diff --git a/python/es.md b/docs/python/es.md similarity index 98% rename from python/es.md rename to docs/python/es.md index b2e325b7..39b3e06d 100644 --- a/python/es.md +++ b/docs/python/es.md @@ -1,3 +1,13 @@ +--- +layout: default +title: Persistent storage in ElasticSearch +nav_order: 3 +parent: Python scripting +has_children: false +has_toc: false +--- + + # Persistent storage in ElasticSearch The data produced by Perceval can be stored in persistent storage. For example, it can be uploaded to (and later retrieved from) a database. In this section we'll learn to do it with ElasticSearch. diff --git a/docs/python/index.md b/docs/python/index.md new file mode 100644 index 00000000..049de870 --- /dev/null +++ b/docs/python/index.md @@ -0,0 +1,13 @@ +--- +layout: default +title: Python scripting +permalink: /python +nav_order: 11 +has_children: true +has_toc: true +--- + +# Python scripting + +This describes the usage of Python scripts for data access and +manipulation. diff --git a/python/indexes.md b/docs/python/indexes.md similarity index 96% rename from python/indexes.md rename to docs/python/indexes.md index 0792dac9..0e979fb9 100644 --- a/python/indexes.md +++ b/docs/python/indexes.md @@ -1,3 +1,13 @@ +--- +layout: default +title: Querying grimoire-elk indexes +nav_order: 6 +parent: Python scripting +has_children: false +has_toc: false +--- + + ## Querying grimoire-elk indexes As we discussed in section diff --git a/python/pandas.md b/docs/python/pandas.md similarity index 98% rename from python/pandas.md rename to docs/python/pandas.md index 99bb41bb..36d5f082 100644 --- a/python/pandas.md +++ b/docs/python/pandas.md @@ -1,3 +1,13 @@ +--- +layout: default +title: Pandas for GrimoireLab indexes +nav_order: 7 +parent: Python scripting +has_children: false +has_toc: false +--- + + ## Pandas for GrimoireLab indexes [Pandas](http://pandas.pydata.org/) is one of the most common libraries used in data analytics with Python. It can be very useful when dealing with GrimoireLab indexes. In this section, we will explore how to create dataframes (one of the most interesting data structures provided by Pandas) from GrimoireLab indexes, and how to work with them. @@ -162,4 +172,4 @@ The `to_csv` method of dataframes just dump them in a file, using the CSV conven 2015-12-31 19:16:25,Jesus M. Gonzalez-Barahona 2015-09-30 18:15:16,Alvaro del Castillo 2015-08-18 18:08:27,Santiago Dueñas -``` \ No newline at end of file +``` diff --git a/python/querying.md b/docs/python/querying.md similarity index 96% rename from python/querying.md rename to docs/python/querying.md index 4b41be6d..2ec05e69 100644 --- a/python/querying.md +++ b/docs/python/querying.md @@ -1,3 +1,13 @@ +--- +layout: default +title: Querying ElasticSearch +nav_order: 5 +parent: Python scripting +has_children: false +has_toc: false +--- + + # Querying ElasticSearch In the previous section we learned how to store Perceval data in ElasticSearch. Let's learn now how to query it. For this, we're going to use data from mailing lists. First, let's upload some messages to a fresh ElasticSearch index using the Perceval mbox backend \(script [perceval\_elasticsearch\_mbox\_1.py](scripts/perceval_elasticsearch_mbox_1.py)): diff --git a/docs/python/scripting.md b/docs/python/scripting.md new file mode 100644 index 00000000..a78be2ea --- /dev/null +++ b/docs/python/scripting.md @@ -0,0 +1,15 @@ +--- +layout: default +title: Python scripting +nav_order: 1 +parent: Python scripting +has_children: false +has_toc: false +--- + +# Python scripting +GrimoireLab is written in Python, and provides many Python modules that +can be used from your scripts. We already saw how Perceval can be used +from Python scripts. Now let's explore how we can walk that way into +more detail. + diff --git a/python/scripts/cleanup.py b/docs/python/scripts/cleanup.py similarity index 100% rename from python/scripts/cleanup.py rename to docs/python/scripts/cleanup.py diff --git a/python/scripts/enriched_elasticsearch_1.py b/docs/python/scripts/enriched_elasticsearch_1.py similarity index 100% rename from python/scripts/enriched_elasticsearch_1.py rename to docs/python/scripts/enriched_elasticsearch_1.py diff --git a/python/scripts/pandas_1.py b/docs/python/scripts/pandas_1.py similarity index 100% rename from python/scripts/pandas_1.py rename to docs/python/scripts/pandas_1.py diff --git a/python/scripts/perceval_elasticsearch_1.py b/docs/python/scripts/perceval_elasticsearch_1.py similarity index 100% rename from python/scripts/perceval_elasticsearch_1.py rename to docs/python/scripts/perceval_elasticsearch_1.py diff --git a/python/scripts/perceval_elasticsearch_2.py b/docs/python/scripts/perceval_elasticsearch_2.py similarity index 100% rename from python/scripts/perceval_elasticsearch_2.py rename to docs/python/scripts/perceval_elasticsearch_2.py diff --git a/python/scripts/perceval_elasticsearch_3.py b/docs/python/scripts/perceval_elasticsearch_3.py similarity index 100% rename from python/scripts/perceval_elasticsearch_3.py rename to docs/python/scripts/perceval_elasticsearch_3.py diff --git a/python/scripts/perceval_elasticsearch_4.py b/docs/python/scripts/perceval_elasticsearch_4.py similarity index 100% rename from python/scripts/perceval_elasticsearch_4.py rename to docs/python/scripts/perceval_elasticsearch_4.py diff --git a/python/scripts/perceval_elasticsearch_git_dsl.py b/docs/python/scripts/perceval_elasticsearch_git_dsl.py similarity index 100% rename from python/scripts/perceval_elasticsearch_git_dsl.py rename to docs/python/scripts/perceval_elasticsearch_git_dsl.py diff --git a/python/scripts/perceval_elasticsearch_git_dsl_2.py b/docs/python/scripts/perceval_elasticsearch_git_dsl_2.py similarity index 100% rename from python/scripts/perceval_elasticsearch_git_dsl_2.py rename to docs/python/scripts/perceval_elasticsearch_git_dsl_2.py diff --git a/python/scripts/perceval_elasticsearch_git_dsl_3.py b/docs/python/scripts/perceval_elasticsearch_git_dsl_3.py similarity index 100% rename from python/scripts/perceval_elasticsearch_git_dsl_3.py rename to docs/python/scripts/perceval_elasticsearch_git_dsl_3.py diff --git a/python/scripts/perceval_elasticsearch_mbox_1.py b/docs/python/scripts/perceval_elasticsearch_mbox_1.py similarity index 100% rename from python/scripts/perceval_elasticsearch_mbox_1.py rename to docs/python/scripts/perceval_elasticsearch_mbox_1.py diff --git a/python/scripts/perceval_elasticsearch_mbox_2.py b/docs/python/scripts/perceval_elasticsearch_mbox_2.py similarity index 100% rename from python/scripts/perceval_elasticsearch_mbox_2.py rename to docs/python/scripts/perceval_elasticsearch_mbox_2.py diff --git a/python/scripts/perceval_elasticsearch_mbox_3.py b/docs/python/scripts/perceval_elasticsearch_mbox_3.py similarity index 100% rename from python/scripts/perceval_elasticsearch_mbox_3.py rename to docs/python/scripts/perceval_elasticsearch_mbox_3.py diff --git a/python/scripting.md b/python/scripting.md deleted file mode 100644 index 3d8a17cb..00000000 --- a/python/scripting.md +++ /dev/null @@ -1,3 +0,0 @@ -# Python scripting -GrimoireLab is written in Python, and provides many Python modules that can be used from your scripts. We already saw how Perceval can be used from Python scripts. Now let's explore how we can walk that way into more detail. - From f1ba8d2da674bd5fb9e827d83478d604db8cb5c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Zubiaurre=20Garc=C3=ADa?= Date: Wed, 25 Oct 2023 12:11:51 +0200 Subject: [PATCH 08/10] Group Tools and Tips MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let's group these pages and we'll update them later! Signed-off-by: Igor Zubiaurre García --- .../attraction-and-retention.md | 10 ++++++++++ docs/tools-and-tips/copying-indexes.md | 14 ++++++++++++++ .../csv-from-jenkins-enriched-index.md | 12 +++++++++++- .../tools-and-tips}/elasticsearch.md | 12 +++++++++++- .../html5-app-latest-activity.md | 12 +++++++++++- .../tools-and-tips}/html5_app.png | Bin .../tools-and-tips}/html5_app_moving.gif | Bin docs/tools-and-tips/index.md | 17 +++++++++++++++++ .../tools-and-tips}/perceval.md | 14 ++++++++++++-- .../tools-and-tips}/scripts/C_dashboard.json | 0 .../tools-and-tips}/scripts/C_searches.json | 0 .../scripts/C_visualizations.json | 0 .../tools-and-tips}/scripts/elastic_cp.py | 0 .../tools-and-tips}/scripts/elastic_last.py | 0 .../scripts/elastic_projects_6.py | 0 .../enriched_elasticsearch_git_pandas7.py | 0 .../scripts/enriched_elasticsearch_jenkins.py | 0 .../enriched_elasticsearch_newcomers.py | 0 .../tools-and-tips}/scripts/events.css | 0 .../tools-and-tips}/scripts/events.js | 0 .../tools-and-tips}/scripts/events.json | 0 .../tools-and-tips}/scripts/index.html | 0 .../scripts/perceval_git_counter.py | 0 tools-and-tips/copying-indexes.md | 4 ---- tools-and-tips/intro.md | 7 ------- 25 files changed, 86 insertions(+), 16 deletions(-) rename {tools-and-tips => docs/tools-and-tips}/attraction-and-retention.md (95%) create mode 100644 docs/tools-and-tips/copying-indexes.md rename {tools-and-tips => docs/tools-and-tips}/csv-from-jenkins-enriched-index.md (95%) rename {tools-and-tips => docs/tools-and-tips}/elasticsearch.md (92%) rename {tools-and-tips => docs/tools-and-tips}/html5-app-latest-activity.md (98%) rename {tools-and-tips => docs/tools-and-tips}/html5_app.png (100%) rename {tools-and-tips => docs/tools-and-tips}/html5_app_moving.gif (100%) create mode 100644 docs/tools-and-tips/index.md rename {tools-and-tips => docs/tools-and-tips}/perceval.md (81%) rename {tools-and-tips => docs/tools-and-tips}/scripts/C_dashboard.json (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/C_searches.json (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/C_visualizations.json (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/elastic_cp.py (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/elastic_last.py (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/elastic_projects_6.py (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/enriched_elasticsearch_git_pandas7.py (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/enriched_elasticsearch_jenkins.py (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/enriched_elasticsearch_newcomers.py (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/events.css (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/events.js (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/events.json (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/index.html (100%) rename {tools-and-tips => docs/tools-and-tips}/scripts/perceval_git_counter.py (100%) delete mode 100644 tools-and-tips/copying-indexes.md delete mode 100644 tools-and-tips/intro.md diff --git a/tools-and-tips/attraction-and-retention.md b/docs/tools-and-tips/attraction-and-retention.md similarity index 95% rename from tools-and-tips/attraction-and-retention.md rename to docs/tools-and-tips/attraction-and-retention.md index a11c4aea..fafe1167 100644 --- a/tools-and-tips/attraction-and-retention.md +++ b/docs/tools-and-tips/attraction-and-retention.md @@ -1,3 +1,13 @@ +--- +layout: default +title: Attraction & retention +nav_order: 2 +parent: Tools and Tips +has_children: false +has_toc: false +--- + + # Attraction & retention [ Warning: this is work in progress, use at your own risk! ] diff --git a/docs/tools-and-tips/copying-indexes.md b/docs/tools-and-tips/copying-indexes.md new file mode 100644 index 00000000..93f79aff --- /dev/null +++ b/docs/tools-and-tips/copying-indexes.md @@ -0,0 +1,14 @@ +--- +layout: default +title: Copying indexes +nav_order: 5 +parent: Tools and Tips +has_children: false +has_toc: false +--- + + +## Copying indexes + +Python script to copy indexes: +[`elastic_cp.py`](https://github.com/jgbarah/GrimoireLab-training/blob/master/tools-and-tips/scripts/elastic_cp.py). diff --git a/tools-and-tips/csv-from-jenkins-enriched-index.md b/docs/tools-and-tips/csv-from-jenkins-enriched-index.md similarity index 95% rename from tools-and-tips/csv-from-jenkins-enriched-index.md rename to docs/tools-and-tips/csv-from-jenkins-enriched-index.md index 5dd5c4f2..5bb84d2e 100644 --- a/tools-and-tips/csv-from-jenkins-enriched-index.md +++ b/docs/tools-and-tips/csv-from-jenkins-enriched-index.md @@ -1,3 +1,13 @@ +--- +layout: default +title: Obtain CSV from Jenkins enriched indexes in ElasticSearch +nav_order: 4 +parent: Tools and Tips +has_children: false +has_toc: false +--- + + ## Obtain CSV from Jenkins enriched indexes in ElasticSearch To illustrate how to get data from an enriched index (produced using `grimoire_elk`), let's review the script [`enriched_elasticsearch_jenkins.py`](https://github.com/jgbarah/GrimoireLab-training/blob/master/tools-and-tips/scripts/enriched_elasticsearch_jenkins.py). This script will query a Jenkins enriched index, producing a CSV file with some of the fields in it, since a certain number of days. @@ -74,4 +84,4 @@ for job in response: )) ``` -Once executed, we will just loop through the result, printing one line of the CSV file for each iteration. Before that, we will write the header of the CVS file, with names for all the fields to show. \ No newline at end of file +Once executed, we will just loop through the result, printing one line of the CSV file for each iteration. Before that, we will write the header of the CVS file, with names for all the fields to show. diff --git a/tools-and-tips/elasticsearch.md b/docs/tools-and-tips/elasticsearch.md similarity index 92% rename from tools-and-tips/elasticsearch.md rename to docs/tools-and-tips/elasticsearch.md index 5c1b9815..fba3236d 100644 --- a/tools-and-tips/elasticsearch.md +++ b/docs/tools-and-tips/elasticsearch.md @@ -1,4 +1,14 @@ -## Elasticsearch +--- +layout: default +title: ElasticSearch REST API +nav_order: 1 +parent: Tools and Tips +has_children: false +has_toc: false +--- + + +## Elasticsearch REST API Some tips to work with Elasticsearch using its REST interface. diff --git a/tools-and-tips/html5-app-latest-activity.md b/docs/tools-and-tips/html5-app-latest-activity.md similarity index 98% rename from tools-and-tips/html5-app-latest-activity.md rename to docs/tools-and-tips/html5-app-latest-activity.md index b556bb8a..292d2aa3 100644 --- a/tools-and-tips/html5-app-latest-activity.md +++ b/docs/tools-and-tips/html5-app-latest-activity.md @@ -1,3 +1,13 @@ +--- +layout: default +title: HTML5 app for latest activity +nav_order: 3 +parent: Tools and Tips +has_children: false +has_toc: false +--- + + ## HTML5 app: latest activity Let's build a simple HTML5 app showing the latest activity of a project or a set of projects. For that, we will create in fact two applications: @@ -187,4 +197,4 @@ This code also decides when to call to `update()` next time: once the marquee wa So, we will see the marquee rolling until no new eevents come in `events.json`, when it will stop for at a certain number of 10 seconds periods, until new events come again, which will make the marquee to roll again. And so on. -Funnny, isn't it? \ No newline at end of file +Funnny, isn't it? diff --git a/tools-and-tips/html5_app.png b/docs/tools-and-tips/html5_app.png similarity index 100% rename from tools-and-tips/html5_app.png rename to docs/tools-and-tips/html5_app.png diff --git a/tools-and-tips/html5_app_moving.gif b/docs/tools-and-tips/html5_app_moving.gif similarity index 100% rename from tools-and-tips/html5_app_moving.gif rename to docs/tools-and-tips/html5_app_moving.gif diff --git a/docs/tools-and-tips/index.md b/docs/tools-and-tips/index.md new file mode 100644 index 00000000..6bf7fc52 --- /dev/null +++ b/docs/tools-and-tips/index.md @@ -0,0 +1,17 @@ +--- +layout: default +title: Tools and Tips +permalink: /tools-tips +nav_order: 12 +has_children: true +has_toc: true +--- + +# Tools and tips + +This describes some useful tips, including the usage minor tools. + +Through this tutorial, we are using several systems that are not part +of GrimoireLab. Find here some tips on how to profit from them. This +content is probably useful beyond GrimoireLab, but in any case is a +good context for it. diff --git a/tools-and-tips/perceval.md b/docs/tools-and-tips/perceval.md similarity index 81% rename from tools-and-tips/perceval.md rename to docs/tools-and-tips/perceval.md index ba31a035..bcb815d2 100644 --- a/tools-and-tips/perceval.md +++ b/docs/tools-and-tips/perceval.md @@ -1,4 +1,14 @@ -## Perceval +--- +layout: default +title: Perceval Git Counter +nav_order: 5 +parent: Tools and Tips +has_children: false +has_toc: false +--- + + +## Perceval Git Counter This section shows some scripts using Perceval. @@ -19,4 +29,4 @@ python perceval_git_counter.py --help There is an option to print commit hashes for all commits in the repository: `--print`. -This utility illusrates how the generator provided by Perceval classes for the different kinds of repositories can be used to run through all the items in them. \ No newline at end of file +This utility illusrates how the generator provided by Perceval classes for the different kinds of repositories can be used to run through all the items in them. diff --git a/tools-and-tips/scripts/C_dashboard.json b/docs/tools-and-tips/scripts/C_dashboard.json similarity index 100% rename from tools-and-tips/scripts/C_dashboard.json rename to docs/tools-and-tips/scripts/C_dashboard.json diff --git a/tools-and-tips/scripts/C_searches.json b/docs/tools-and-tips/scripts/C_searches.json similarity index 100% rename from tools-and-tips/scripts/C_searches.json rename to docs/tools-and-tips/scripts/C_searches.json diff --git a/tools-and-tips/scripts/C_visualizations.json b/docs/tools-and-tips/scripts/C_visualizations.json similarity index 100% rename from tools-and-tips/scripts/C_visualizations.json rename to docs/tools-and-tips/scripts/C_visualizations.json diff --git a/tools-and-tips/scripts/elastic_cp.py b/docs/tools-and-tips/scripts/elastic_cp.py similarity index 100% rename from tools-and-tips/scripts/elastic_cp.py rename to docs/tools-and-tips/scripts/elastic_cp.py diff --git a/tools-and-tips/scripts/elastic_last.py b/docs/tools-and-tips/scripts/elastic_last.py similarity index 100% rename from tools-and-tips/scripts/elastic_last.py rename to docs/tools-and-tips/scripts/elastic_last.py diff --git a/tools-and-tips/scripts/elastic_projects_6.py b/docs/tools-and-tips/scripts/elastic_projects_6.py similarity index 100% rename from tools-and-tips/scripts/elastic_projects_6.py rename to docs/tools-and-tips/scripts/elastic_projects_6.py diff --git a/tools-and-tips/scripts/enriched_elasticsearch_git_pandas7.py b/docs/tools-and-tips/scripts/enriched_elasticsearch_git_pandas7.py similarity index 100% rename from tools-and-tips/scripts/enriched_elasticsearch_git_pandas7.py rename to docs/tools-and-tips/scripts/enriched_elasticsearch_git_pandas7.py diff --git a/tools-and-tips/scripts/enriched_elasticsearch_jenkins.py b/docs/tools-and-tips/scripts/enriched_elasticsearch_jenkins.py similarity index 100% rename from tools-and-tips/scripts/enriched_elasticsearch_jenkins.py rename to docs/tools-and-tips/scripts/enriched_elasticsearch_jenkins.py diff --git a/tools-and-tips/scripts/enriched_elasticsearch_newcomers.py b/docs/tools-and-tips/scripts/enriched_elasticsearch_newcomers.py similarity index 100% rename from tools-and-tips/scripts/enriched_elasticsearch_newcomers.py rename to docs/tools-and-tips/scripts/enriched_elasticsearch_newcomers.py diff --git a/tools-and-tips/scripts/events.css b/docs/tools-and-tips/scripts/events.css similarity index 100% rename from tools-and-tips/scripts/events.css rename to docs/tools-and-tips/scripts/events.css diff --git a/tools-and-tips/scripts/events.js b/docs/tools-and-tips/scripts/events.js similarity index 100% rename from tools-and-tips/scripts/events.js rename to docs/tools-and-tips/scripts/events.js diff --git a/tools-and-tips/scripts/events.json b/docs/tools-and-tips/scripts/events.json similarity index 100% rename from tools-and-tips/scripts/events.json rename to docs/tools-and-tips/scripts/events.json diff --git a/tools-and-tips/scripts/index.html b/docs/tools-and-tips/scripts/index.html similarity index 100% rename from tools-and-tips/scripts/index.html rename to docs/tools-and-tips/scripts/index.html diff --git a/tools-and-tips/scripts/perceval_git_counter.py b/docs/tools-and-tips/scripts/perceval_git_counter.py similarity index 100% rename from tools-and-tips/scripts/perceval_git_counter.py rename to docs/tools-and-tips/scripts/perceval_git_counter.py diff --git a/tools-and-tips/copying-indexes.md b/tools-and-tips/copying-indexes.md deleted file mode 100644 index b551234a..00000000 --- a/tools-and-tips/copying-indexes.md +++ /dev/null @@ -1,4 +0,0 @@ -## Copying indexes - -Python script to copy indexes: -[`elastic_cp.py`](https://github.com/jgbarah/GrimoireLab-training/blob/master/tools-and-tips/scripts/elastic_cp.py). \ No newline at end of file diff --git a/tools-and-tips/intro.md b/tools-and-tips/intro.md deleted file mode 100644 index d0f9f7b5..00000000 --- a/tools-and-tips/intro.md +++ /dev/null @@ -1,7 +0,0 @@ -# Tools and tips - -Through this tutorial, we are using several systems that are not part of GrimoireLab. Find here some tips on how to profit from them. This content is probably useful beyond GrimoireLab, but in any case is a good context for it. - - - - From 87f3e1b7daa12ba1d025876b4afa0327444dfdbe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Zubiaurre=20Garc=C3=ADa?= Date: Wed, 25 Oct 2023 12:21:23 +0200 Subject: [PATCH 09/10] Group Use Cases MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let's group these pages and we'll update them later! Signed-off-by: Igor Zubiaurre García --- {cases-chaoss => docs/cases-chaoss}/activity.md | 10 ++++++++++ ...hboard_chaoss_community_activity-2y-perceval.png | Bin .../dashboard_chaoss_community_activity-2y.png | Bin .../dashboard_chaoss_community_activity.png | Bin .../dashboards/chaoss_community_activity.json | 0 .../cases-chaoss}/discover_indexes.png | Bin cases-chaoss/intro.md => docs/cases-chaoss/index.md | 11 ++++++++++- .../cases-chaoss}/index_patterns.png | Bin docs/{components/gelk => cases-chaoss}/meetup.md | 10 ++++++++++ .../cases-chaoss}/scripts/retrieve.py | 0 10 files changed, 30 insertions(+), 1 deletion(-) rename {cases-chaoss => docs/cases-chaoss}/activity.md (97%) rename {cases-chaoss => docs/cases-chaoss}/dashboard_chaoss_community_activity-2y-perceval.png (100%) rename {cases-chaoss => docs/cases-chaoss}/dashboard_chaoss_community_activity-2y.png (100%) rename {cases-chaoss => docs/cases-chaoss}/dashboard_chaoss_community_activity.png (100%) rename {cases-chaoss => docs/cases-chaoss}/dashboards/chaoss_community_activity.json (100%) rename {cases-chaoss => docs/cases-chaoss}/discover_indexes.png (100%) rename cases-chaoss/intro.md => docs/cases-chaoss/index.md (96%) rename {cases-chaoss => docs/cases-chaoss}/index_patterns.png (100%) rename docs/{components/gelk => cases-chaoss}/meetup.md (98%) rename {cases-chaoss => docs/cases-chaoss}/scripts/retrieve.py (100%) diff --git a/cases-chaoss/activity.md b/docs/cases-chaoss/activity.md similarity index 97% rename from cases-chaoss/activity.md rename to docs/cases-chaoss/activity.md index b4b142af..10eb2a37 100644 --- a/cases-chaoss/activity.md +++ b/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. diff --git a/cases-chaoss/dashboard_chaoss_community_activity-2y-perceval.png b/docs/cases-chaoss/dashboard_chaoss_community_activity-2y-perceval.png similarity index 100% rename from cases-chaoss/dashboard_chaoss_community_activity-2y-perceval.png rename to docs/cases-chaoss/dashboard_chaoss_community_activity-2y-perceval.png diff --git a/cases-chaoss/dashboard_chaoss_community_activity-2y.png b/docs/cases-chaoss/dashboard_chaoss_community_activity-2y.png similarity index 100% rename from cases-chaoss/dashboard_chaoss_community_activity-2y.png rename to docs/cases-chaoss/dashboard_chaoss_community_activity-2y.png diff --git a/cases-chaoss/dashboard_chaoss_community_activity.png b/docs/cases-chaoss/dashboard_chaoss_community_activity.png similarity index 100% rename from cases-chaoss/dashboard_chaoss_community_activity.png rename to docs/cases-chaoss/dashboard_chaoss_community_activity.png diff --git a/cases-chaoss/dashboards/chaoss_community_activity.json b/docs/cases-chaoss/dashboards/chaoss_community_activity.json similarity index 100% rename from cases-chaoss/dashboards/chaoss_community_activity.json rename to docs/cases-chaoss/dashboards/chaoss_community_activity.json diff --git a/cases-chaoss/discover_indexes.png b/docs/cases-chaoss/discover_indexes.png similarity index 100% rename from cases-chaoss/discover_indexes.png rename to docs/cases-chaoss/discover_indexes.png diff --git a/cases-chaoss/intro.md b/docs/cases-chaoss/index.md similarity index 96% rename from cases-chaoss/intro.md rename to docs/cases-chaoss/index.md index 20050ea9..834e4141 100644 --- a/cases-chaoss/intro.md +++ b/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. diff --git a/cases-chaoss/index_patterns.png b/docs/cases-chaoss/index_patterns.png similarity index 100% rename from cases-chaoss/index_patterns.png rename to docs/cases-chaoss/index_patterns.png diff --git a/docs/components/gelk/meetup.md b/docs/cases-chaoss/meetup.md similarity index 98% rename from docs/components/gelk/meetup.md rename to docs/cases-chaoss/meetup.md index 92039df4..f88c4998 100644 --- a/docs/components/gelk/meetup.md +++ b/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: diff --git a/cases-chaoss/scripts/retrieve.py b/docs/cases-chaoss/scripts/retrieve.py similarity index 100% rename from cases-chaoss/scripts/retrieve.py rename to docs/cases-chaoss/scripts/retrieve.py From 35d41a5049ce236c4059267fda5891386b39cd9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Zubiaurre=20Garc=C3=ADa?= Date: Wed, 25 Oct 2023 12:23:25 +0200 Subject: [PATCH 10/10] Remove obsolete summary MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Igor Zubiaurre García --- SUMMARY.md | 50 -------------------------------------------------- 1 file changed, 50 deletions(-) delete mode 100644 SUMMARY.md diff --git a/SUMMARY.md b/SUMMARY.md deleted file mode 100644 index 19cab137..00000000 --- a/SUMMARY.md +++ /dev/null @@ -1,50 +0,0 @@ -# Summary - -* [Introduction](README.md) -* [Before you start](before-you-start/intro.md) - * [What is GrimoireLab](before-you-start/what-is-grimoirelab.md) - * [Supporting systems](before-you-start/supporting-systems.md) - * [Installing GrimoireLab](before-you-start/installing-grimoirelab.md) - * [Deploying from DockerHub](before-you-start/deploying-from-dockerhub.md) -* [GrimoireLab architecture](grimoirelab/intro.md) - * [Components](grimoirelab/intro/components.md) - * [Scenarios](grimoirelab/intro/scenarios.md) -* [Perceval](perceval/intro.md) - * [Git](perceval/git.md) - * [GitHub](perceval/github.md) - * [Mail archives](perceval/mail.md) - * [Gerrit](perceval/gerrit.md) - * [Summarizing](perceval/summarizing.md) -* [Producing Kibana dashboards with GrimoireELK](grimoireelk/intro.md) - * [A simple dashboard](grimoireelk/a-simple-dashboard.md) - * [A dashboard with SortingHat](grimoireelk/a-dashboard-with-sortinghat.md) - * [Managing dashboards with kidash](grimoireelk/managing-dashboards-with-kidash.md) - * [Complete dashboard for Meetup](grimoireelk/meetup_complete.md) -* [SortingHat](sortinghat/intro.md) - * [Data structure](sortinghat/data-structure.md) - * [Basic use](sortinghat/basic-use.md) -* [Reporting with Manuscripts](manuscripts/intro.md) - * [Get your first report](manuscripts/first-report.md) -* [Mordred: orchestrating everything](mordred/intro.md) - * [A GrimoireLab dashboard in one step](mordred/a-grimoirelab-dashboard-in-one-step.md) - * [Mordred in a container](mordred/mordred-in-a-container.md) - * [The projects file](mordred/the-projects-file.md) -* [Python scripting](python/scripting.md) - * [Persistent storage in ElasticSearch](python/elasticsearch.md) - * [Querying ElasticSearch](python/quering_elasticsearch.md) - * [ElasticSearch DSL](python/elasticsearch-dsl.md) - * [Querying GrimoireELK indexes](python/querying-grimoireelk-indexes.md) - * [Pandas for GrimoireLab indexes](python/pandas-for-grimoirelab-indexes.md) -* [Cases: CHAOSS Health](cases-chaoss.md) - * [Activity](cases-chaoss/activity.md) -* [Tools and tips](tools-and-tips/intro.md) - * [Perceval](tools-and-tips/perceval.md) - * [ElasticSearch](tools-and-tips/elasticsearch.md) - * [HTML5 app: latest activity](tools-and-tips/html5-app-latest-activity.md) - * [Copying indexes](tools-and-tips/copying-indexes.md) - * [CSV from Jenkins enriched index](tools-and-tips/csv-from-jenkins-enriched-index.md) - * [Attraction & Retention](tools-and-tips/attraction-and-retention.md) -* [Internals](internals/intro.md) - * [Perceval backends](internals/perceval-backends.md) -* [Contributing](contributing.md) -