From ddd00575277cb8ec097afdf8687a0f7e0a32b55e Mon Sep 17 00:00:00 2001
From: Boris Baldassari <boris@chrysalice.org>
Date: Sun, 28 Feb 2021 13:23:51 +0100
Subject: [PATCH] #5 Fix minor typos in docs.
Signed-off-by: Boris Baldassari <boris@chrysalice.org>
---
report/datasets_report.Rmarkdown | 9 +++++++--
website/content/_index.md | 7 +++----
2 files changed, 10 insertions(+), 6 deletions(-)
diff --git a/report/datasets_report.Rmarkdown b/report/datasets_report.Rmarkdown
index b73360c..b1e998f 100644
--- a/report/datasets_report.Rmarkdown
+++ b/report/datasets_report.Rmarkdown
@@ -4,6 +4,8 @@ output:
blogdown::html_page:
toc: true
autoCollapseToc: false
+ html_document:
+ toc: yes
params:
project_id: "%%ECLIPSE_PROJECT_ID%%"
menu:
@@ -50,12 +52,15 @@ 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 start a R session and `render` it with the project ID as a parameter:
+To re-execute the document, simply start a R session, load `rmarkdown` and `render` the page with the project ID as a parameter:
```r
-render("datasets_report.inc", params = list(project_id = "`r project_id`"))
+require('rmarkdown')
+render("datasets_report.Rmarkdown", params = list(project_id = "`r project_id`"), output_format="html_document")
```
+This website uses the [blogdown](https://github.com/rstudio/blogdown) R package, which provides a different output_format for the hugo framework.
+
This report was generated on ``r Sys.Date()``.
diff --git a/website/content/_index.md b/website/content/_index.md
index 8ea3b74..e52a01b 100644
--- a/website/content/_index.md
+++ b/website/content/_index.md
@@ -9,14 +9,13 @@ toc: true
-This web site hosts the open datasets generated in the course of the [Crossminer research project](https://crossminer.org).
+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 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.
+All data is anonymised, please see the [dedicated document]({{< ref "datasets_privacy" >}}) to learn more about privacy and the anonymisation mechanism.
We're open: if you'd like to contribute, or for any request or question, please see the [Eclipse GitLab project](https://gitlab.eclipse.org/bbaldassari2kd/scava-datasets) page.
-
--
GitLab