Merge pull request #57 from esciencecenter-digital-skills/NEBULA-update

Nebula update

.github/workflows/check.yml

@@ -0,0 +1,44 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Clean install and build check (no deploy) with dummy content
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: checkout NEBULA
+      uses: actions/checkout@v4
+      with:
+          repository: esciencecenter-digital-skills/NEBULA
+          ref: v0.4.0
+          path: ./NEBULA
+
+    - name: Checkout content
+      uses: actions/checkout@v4
+      with:
+        path: ./content
+
+    - name: Set content path environment variable
+      run: echo "CONTENT_PATH=${PWD}/content" >> $GITHUB_ENV
+
+    - name: Run CI on Node.js 18.x
+      uses: actions/setup-node@v3
+      with:
+        node-version: 18.x
+        cache: 'npm'
+        cache-dependency-path: './NEBULA/package-lock.json'
+    - run: |
+        cd NEBULA
+        npm ci
+    - run: |
+        cd NEBULA
+        npm run build

.github/workflows/deploy.yml

@@ -1,44 +1,19 @@
 name: Deploy to gh-pages
 
 on: 
-  push:
+  [release, workflow_dispatch]
 env:
   NUXT_APP_CDN_URL: https://esciencecenter-digital-skills.github.io/research-software-support
 jobs:
-  get_content_config:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout content
-        uses: actions/checkout@v4
-        with:
-          sparse-checkout: config.json
-          sparse-checkout-cone-mode: false
-          path: ./content_config/
-
-      - name: Show config path
-        run: |
-          pwd
-          ls -la
-          cd content_config
-          ls -la
-          cd -
-
-      - name: Upload content config file
-        uses: actions/upload-artifact@v4
-        with:
-          name: content_config
-          path: ./content_config/config.json
-
   deploy_with_NEBULA:
-    needs: get_content_config
     permissions: 
       contents: write
-    uses: esciencecenter-digital-skills/NEBULA/.github/workflows/deploy.yml@main
+    uses: esciencecenter-digital-skills/NEBULA/.github/workflows/deploy.yml@v0.4.0
     with:
-      config_artifact_name: content_config
-      nebula_ref: main
-
-
+      content_organization: esciencecenter-digital-skills
+      content_repository: research-software-support
+      content_ref: NEBULA-update
+      base_url: research-software-support
+      nebula_ref: v0.4.0
 
 

config.json

@@ -1,9 +1,9 @@
 {
     "publicProps": {
-        "title": "Research Software Support platform",
+        "title": "Research Software Support",
+        "baseURL": "research-software-support",
         "repoName":"research-software-support",
         "repoOwner": "esciencecenter-digital-skills",
-        "repoTag": "main",
         "organization": "Netherlands eScience Center",
         "categoryOrder": ["Getting started", "Reusability", "Publishing & Citing", "Development", "Upcoming (under construction)"]
     }

main/about.md

@@ -0,0 +1,12 @@
+---
+title: About
+---
+
+## About the Research Software Support
+In the Research Software Support modules we want to provide a comprehensive overview of the different aspects of research software support.
+
+## Target audience
+
+The target audience for this material is University management and support staff.
+University management taking part in courses involving these modules may be involved in creating university policy around research software.
+The University support staff targeted are not themselves researchers or software engineers, but they support researchers and research software engineers in creating research software.

main/contribute.md

@@ -0,0 +1,21 @@
+---
+title: Contribute
+---
+
+## Contributing to the Research Software Support
+
+In the Research Software Support modules we want to provide a comprehensive overview of the different aspects of research software support.
+This, as you can imagine, is no easy feat, and we need your help!
+So first of all, thank you very much for your interest in contributing to this project.
+
+### What can I do?
+
+Go to our github repository by clicking on the GitHub logo in the top right of this website. 
+
+* Contribute to the content discussion in the [chapter issues](https://github.com/esciencecenter-digital-skills/research-software-support/issues?q=is%3Aissue+is%3Aopen+label%3Astory), e.g. by listing good resources for information.
+* [Author a lesson](#elements-of-a-module), e.g. by:
+  * [Creating slides](#slides)
+  * [Designing an exercise](#exercises)
+  * [Curating online resources](#online-resources)
+* Review a lesson module; both by looking at [open PRs](https://github.com/esciencecenter-digital-skills/research-software-support/pulls), as well as flagging issues for improvement in the [existing content](https://esciencecenter-digital-skills.github.io/research-software-support/).
+* [Provide feedback](https://github.com/esciencecenter-digital-skills/research-software-support/issues) on the different subjects covered: what did we miss? Should something be restructured?

modules/citation/citationcff.md

@@ -1,3 +1,9 @@
+---
+title: The `CITATION.cff` file
+type: reading
+order: 4
+---
+
 ## The `CITATION.cff` file
 
 To facilitate the citation of scientific software, a group of software developers, researchers, and publishers have come together to develop the `CITATION.cff` format. A `CITATION.cff` file is a lightweight, machine-readable file that provides information about the software, its creators, and how it should be cited. This file can be included in the software, and should be easy to find and access.
@@ -20,5 +26,3 @@ identifiers:
     value: 10.5281/zenodo.1234
 date-released: 2021-08-11
 ```
-
-:::

modules/citation/create_citation_file.md

@@ -1,5 +1,9 @@
+---
+title: Using cffinit to create `CITATION.cff`
+type: exercise
+order: 5
+---
+
 ## Using cffinit to create `CITATION.cff`
 
 This tutorial demonstrates the use of CFFinit, to create a `CITATION.cff` file. You can find the tool at [citation-file-format.github.io/cff-initializer-javascript](https://citation-file-format.github.io/cff-initializer-javascript/#/).
-
-:::

modules/citation/ex_when_to_cite.md

@@ -1,3 +1,9 @@
+---
+title: Which software should I cite?
+type: exercise
+order: 6
+---
+
 ## Exercise: Which software should I cite?
 Suppose you are writing a paper on your latest research and are putting together the reference list. During your research you have used all the software mentioned below. 
 
@@ -11,5 +17,3 @@ Suppose you are writing a paper on your latest research and are putting together
 - Your own local python script, used to execute the analysis
 
 Which software would you cite and which not? Why?
-
-:::

modules/citation/further_reading.md

@@ -1,9 +1,14 @@
+---
+title: Reading material
+type: reading
+order: 7
+---
+
 ## Links for further reading
 
 - The FORCE11 [Software Citation Principles](https://force11.org/info/software-citation-principles-published-2016/) describe the rationale behind software citation. 
 - An interactive guide on software citation can be found at [citesoftware.org](https://cfa-library.github.io/citesoftware.org/).
 - An extensive (non-interactive) guide can be found at [cite.research-software.org](https://cite.research-software.org/).
 - To provide citation information [CITATION.cff](https://citation-file-format.github.io/) files can be created using the online [CFFInit](https://citation-file-format.github.io/cff-initializer-javascript/#/) tool.
 - [Shouldacite](https://mr-c.github.io/shouldacite/) helps you decide when to cite software in your publications.
-
-:::
+

modules/citation/index.md

@@ -0,0 +1,13 @@
+---
+id: 0
+trl: medium
+category: Publishing & Citing
+title: Software citation
+author: eScience Center
+thumbnail: "thumbnail-citation.jpg"
+visibility: visible
+---
+
+[thumbnail-citation](https://unsplash.com/photos/difficult-roads-lead-to-beautiful-destinations-desk-decor-z1d-LP8sjuI?utm_content=creditShareLink&utm_medium=referral&utm_source=unsplash)
+
+Photo by <a href="https://unsplash.com/@helloimnik?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Nik</a> on <a href="https://unsplash.com/photos/difficult-roads-lead-to-beautiful-destinations-desk-decor-z1d-LP8sjuI?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a>

modules/citation/info.md

@@ -0,0 +1,7 @@
+---
+title: Learning objectives
+type: info
+order: 0
+---
+
+Learning objectives for the Citation module

modules/citation/introduction.md

@@ -1,3 +1,9 @@
+---
+title: Citing software
+type: reading
+order: 2
+---
+
 ## Citing software
 
 Software has become a crucial part of scientific research, yet it is not cited or credited as often and as easily as traditional research outputs. However, it is important to properly cite software, for many reasons, among which:

modules/citation/principles.md

@@ -1,8 +1,12 @@
-The FORCE11 working group published the [Software Citation Principles](https://force11.org/info/software-citation-principles-published-2016/)
+---
+title: The principles
+type: reading
+order: 3
+---
 
+## The FORCE11 working group published the [Software Citation Principles](https://force11.org/info/software-citation-principles-published-2016/)
 
-
-## The principles
+### The principles
 
 **Importance**: Software should be considered a legitimate and citable product of research. Software citations should be accorded the same importance in the scholarly record as citations of other research products, such as publications and data; they should be included in the metadata of the citing work, for example in the reference list of a journal article, and should not be omitted or separated. Software should be cited on the same basis as any other research product such as a paper or a book, that is, authors should cite the appropriate set of software products just as they cite the appropriate set of papers.
 
@@ -15,5 +19,3 @@ The FORCE11 working group published the [Software Citation Principles](https://f
 **Accessibility**: Software citations should facilitate access to the software itself and to its associated metadata, documentation, data, and other materials necessary for both humans and machines to make informed use of the referenced software.
 
 **Specificity**: Software citations should facilitate identification of, and access to, the specific version of software that was used. Software identification should be as specific as necessary, such as using version numbers, revision numbers, or variants such as platforms.
-
-:::

modules/citation/slides-citation.pmd

@@ -1,3 +1,11 @@
+---
+title: Software Citation
+type: slides
+order: 1
+---
+
+---
+
 <!-- .slide: data-state="title" -->
 
 # Software Citation

modules/documentation/info.md

@@ -0,0 +1,7 @@
+---
+title: Learning objectives
+type: info
+order: 0
+---
+
+Learning objectives for the FAIR software module

modules/environments/info.md

@@ -0,0 +1,7 @@
+---
+title: Learning objectives
+type: info
+order: 0
+---
+
+Learning objectives for the FAIR software module

modules/fairsoftware/exercise1.md

@@ -1,3 +1,9 @@
+---
+title: What is FAIR?
+type: exercise
+order: 2
+---
+
 # Exercise 1
 
 ## What is FAIR?

modules/fairsoftware/exercise2.md

@@ -1,3 +1,9 @@
+---
+title: Mapping the principles
+type: exercise
+order: 3
+---
+
 # Exercise 2
 
 ## Mapping the principles

modules/fairsoftware/exercise3.md

@@ -1,4 +1,10 @@
-# Exercise 2
+---
+title: FAIR in practice
+type: exercise
+order: 4
+---
+
+# Exercise 3
 
 ## FAIR in practice
 

modules/fairsoftware/index.md

@@ -0,0 +1,13 @@
+---
+id: 3
+trl: medium
+category: Getting started
+title: FAIR software
+author: eScience Center
+thumbnail: "thumbnail-fair-software.jpg"
+visibility: visible
+---
+
+[thumbnail-fair-software](https://unsplash.com/photos/three-men-sitting-while-using-laptops-and-watching-man-beside-whiteboard-wD1LRb9OeEo?utm_content=creditShareLink&utm_medium=referral&utm_source=unsplash)
+
+Photo by <a href="https://unsplash.com/@austindistel?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Austin Distel</a> on <a href="https://unsplash.com/photos/three-men-sitting-while-using-laptops-and-watching-man-beside-whiteboard-wD1LRb9OeEo?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a>

modules/fairsoftware/info.md

@@ -0,0 +1,7 @@
+---
+title: Learning objectives
+type: info
+order: 0
+---
+
+Learning objectives for the FAIR software module

modules/fairsoftware/reading.md

@@ -1,3 +1,9 @@
+---
+title: Reading material
+type: reading
+order: 5
+---
+
 # Reading material
 
 ## FAIR software

modules/fairsoftware/slides-fairsoftware.pmd

@@ -1,3 +1,9 @@
+---
+title: FAIR software
+type: slides
+order: 1
+---
+
 ---
 
 <!-- .slide: data-state="title" -->