From 4269be8ffe9100aec7ad3956644b581646d9c9c2 Mon Sep 17 00:00:00 2001
From: Boris Baldassari <boris@chrysalice.org>
Date: Wed, 10 Feb 2021 13:25:46 +0100
Subject: [PATCH] #5 Add Alambic info + links.
Signed-off-by: Boris Baldassari <boris@chrysalice.org>
---
report/datasets_report.Rmarkdown | 6 +++++-
website/content/_index.md | 2 ++
2 files changed, 7 insertions(+), 1 deletion(-)
diff --git a/report/datasets_report.Rmarkdown b/report/datasets_report.Rmarkdown
index 07045af..b73360c 100644
--- a/report/datasets_report.Rmarkdown
+++ b/report/datasets_report.Rmarkdown
@@ -50,7 +50,7 @@ file_sq_metrics <- "sq_metrics.csv"
This document is a [R notebook](https://rmarkdown.rstudio.com/), dynamically created from the numbers extracted on the project. It lists all datasets published for the project, providing basic numbers, figures and a quick summary, and serves as a test case to make sure that all the required data is present and roughly consistent with requirements. All plots and tables are computed from the actual data as provided in the downloads.
-To re-execute the document, simply render it with the project ID as a parameter:
+To re-execute the document, simply start a R session and `render` it with the project ID as a parameter:
```r
render("datasets_report.inc", params = list(project_id = "`r project_id`"))
@@ -61,6 +61,10 @@ This report was generated on ``r Sys.Date()``.
## Downloads
+All data is retrieved from [Alambic](https://alambic.io), an open-source framework for development data extraction and processing.
+
+This project's analysis page can be found on the [Alambic instance for the Eclipse forge](https://eclipse.alambic.io), at https://eclipse.alambic.io/projects/`r project_id`.
+
Downloads are composed of gzip'd CSV and JSON files. CSV files always have a header to name the fields, which makes it easy to import in analysis software like R:
```r
diff --git a/website/content/_index.md b/website/content/_index.md
index 9047119..8ea3b74 100644
--- a/website/content/_index.md
+++ b/website/content/_index.md
@@ -12,6 +12,8 @@ toc: true
This web site hosts the open datasets generated in the course of the [Crossminer research project](https://crossminer.org).
The datasets include various pieces of data retrieved from the Eclipse forge: **Mailing lists**, **Project development data**, and **AERI stacktraces** in handy CSV and JSON formats. Each dataset has a R Markdown document describing its content and providing hints about how to use it. Examples provided mainly use the [R statistical analysis software](https://r-project.org).
+All data is retrieved from the **Eclipse Alambic instance** at https://eclipse.alambic.io. **Alambic** is **an open-source framework for development data extraction and processing**, for more information see https://alambic.io.
+
All datasets are published under the [Creative Commons BY-Attribution-Share Alike 4.0 (International)](https://creativecommons.org/licenses/by-sa/4.0/).
All data is anonymised, please see the [dedicated document]({{< ref "datasets_privacy" >}}) to learn more about privacy and the anonymisation mecanism.
--
GitLab