Initial commit

.github/workflows/check.yml

@@ -0,0 +1,21 @@
+name: Clean install and build check with content (no deployment)
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  deploy_with_NEBULA:
+    permissions: 
+      contents: write
+    uses: esciencecenter-digital-skills/NEBULA/.github/workflows/[email protected]
+    with:
+      content_organization: ${{ github.repository_owner}}
+      content_repository: ${{ github.event.repository.name }}
+      content_ref: ${{ github.sha }}
+      nebula_ref: v1.0.0
+      deploy_to_ghpages: false

.github/workflows/deploy.yml

@@ -0,0 +1,18 @@
+name: Deploy to gh-pages
+
+on: 
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  deploy_with_NEBULA:
+    permissions: 
+      contents: write
+    uses: esciencecenter-digital-skills/NEBULA/.github/workflows/[email protected]
+    with:
+      content_organization: ${{ github.repository_owner}}
+      content_repository: ${{ github.event.repository.name }}
+      content_ref: ${{ github.sha }}
+      nebula_ref: v1.0.0
+      deploy_to_ghpages: true

.github/workflows/generate_config.yml

@@ -0,0 +1,44 @@
+name: Generate Config json File (Execute it only upon repository initialisation)
+
+on:
+  push:
+    branches:
+      - '**'
+
+permissions: write-all
+
+jobs:
+    create-config:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout content
+              uses: actions/checkout@v4
+
+            - name: Create config.json
+              run: |
+                echo '{
+                  "publicProps": {
+                    "title": "Add a title for your lesson/project",
+                    "baseURL": "${{ github.event.repository.name }}",
+                    "repoName": "${{ github.event.repository.name }}",
+                    "repoOwner": "esciencecenter-digital-skills",
+                    "organization": "Netherlands eScience Center",
+                    "categoryOrder": ["Category1", "Category2"]
+                  }
+                }' > config.json
+
+            - name: Commit and push config.json
+              run: |
+                git config --global user.email "[email protected]"
+                git config --global user.name "GitHub Action"
+                git add config.json
+                git commit -m "Create config.json" || exit 0   # Exits gracefully if there's nothing to commit
+                git push
+
+            - name: Disable this workflow once it has been run once on instantiation
+              shell: bash
+              run: |
+                gh workflow disable -R $GITHUB_REPOSITORY "${{ github.workflow }}"
+              env:
+                GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

LICENSE.md

@@ -0,0 +1,4 @@
+<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />The content of the `modules/` folder of this project is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
+
+This license does not apply to any image files in the `modules` folder or its subfolders.
+Image files are files with `.png`, `.jpg`, `.svg`, or `.gif` extensions.

README.md

@@ -0,0 +1,44 @@
+# NEBULA-content-template
+This template repository can be used to create an easily maintainable, version-controllable, web-based lesson collection to be deployed with the [NEBULA framework](https://github.com/esciencecenter-digital-skills/NEBULA).
+
+## Repo instantiation
+To create a custom-made lesson repository, click the `Use this template` button located at the top right of this page.
+
+## Configure GitHub Pages
+After instantiation, you need to set up your repo's GitHub Pages. Follow these steps:
+- Go to `Settings` (located on the top toolbar), and then click on `Pages`.
+- Under the `Branch` option, select the `gh-pages` branch and then click `Save`. Use the `/root` folder as the default.
+- Return to your main repository page.
+- In the `About` section of your repository details, find the `Website` field and select `Use your GitHub Pages website`.
+
+## Add the title of your lesson and additional sections
+This can be configured through the `config.json` file. Below is an example of its contents:
+```
+{
+  "publicProps": {
+    "title": "Add a title for your lesson/project",
+    "baseURL": "NEBULA-content-template",
+    "repoName": "NEBULA-content-template",
+    "repoOwner": "esciencecenter-digital-skills",
+    "organization": "Netherlands eScience Center",
+    "categoryOrder": ["Category1", "Category2"]
+  }
+}
+```
+You can modify the `"title"` field to reflect your specific topic and add new sections to your lesson under `"categoryOrder"`.
+
+The `"repoName"` and `"baseURL"` fields are automatically updated to the name of your new repository using the [generate_config.yml](https://github.com/esciencecenter-digital-skills/NEBULA-content-template/blob/main/.github/workflows/generate_config.yml) file. The corresponding workflow is triggered only once upon repository instantiation and is subsequently disabled.
+
+## Adding new modules
+This repository includes dummy model modules as templates that you can follow to create your own modules. Please, follow the recommended formats and file extensions.
+See also [NEBULA-docs](https://github.com/esciencecenter-digital-skills/NEBULA-docs) for information on how to create new modules.
+
+## Suggestions and further info
+Suggestions are always welcome.
+For this and any other issues, we invite you contribute to the project by creating `Issues` and `Pull requests`.
+If needed, you can also contact us directly:
+- Carlos M. R. Rocha: [email protected]
+- Jaro Camphuijsen: [email protected]
+- Robin Richardson: [email protected]
+
+

config.json

@@ -0,0 +1,10 @@
+{
+  "publicProps": {
+    "title": "Add a title for your lesson/project",
+    "baseURL": "NEBULA-content-template",
+    "repoName": "NEBULA-content-template",
+    "repoOwner": "esciencecenter-digital-skills",
+    "organization": "Netherlands eScience Center",
+    "categoryOrder": ["Category1", "Category2"]
+  }
+}

index.md

@@ -0,0 +1,5 @@
+# Hello world
+
+Here is some markdown content.
+
+[Demo lesson link](/lessons/demo)

main/about.md

@@ -0,0 +1,11 @@
+---
+title: About
+---
+
+## About this lesson/project
+
+Provide details about the project and lesson.
+
+## Target audience
+
+Define target audience for this material.

main/contribute.md

@@ -0,0 +1,7 @@
+---
+title: Contribute
+---
+
+## Contributing to this lesson
+
+Add contributing guidelines for you project.

modules/module1/exercises_module1.md

@@ -0,0 +1,9 @@
+---
+title: Exercises
+type: exercise
+order: 2
+---
+
+# Exercises
+
+Add here your exercises...

modules/module1/further_reading_module1.md

@@ -0,0 +1,9 @@
+---
+title: Reading material
+type: reading
+order: 3
+---
+
+# Reading material
+
+Add here links to relevant reading material...

modules/module1/index.md

@@ -0,0 +1,11 @@
+---
+id: 0
+trl: medium
+category: Category1
+title: Title of module 1
+author: eScience Center
+thumbnail: "nlesc-dummy.png"
+visibility: visible
+---
+
+# Category 1

modules/module1/info.md

@@ -0,0 +1,7 @@
+---
+title: Learning objectives
+type: info
+order: 0
+---
+
+Learning objectives of Module 1

modules/module1/slides_module1.md

@@ -0,0 +1,34 @@
+---
+title: Module 1
+type: slides
+order: 1
+---
+
+<!-- .slide: data-state="title" -->
+
+# Module 1
+
+===
+
+<!-- .slide: data-state="standard" -->
+
+## Title of the first slide
+
+<center>
+<img src="media/fig-dummy.png" width="55%">
+</center>
+
+Note:
+
+Add notes to the presenter...
+
+===
+
+<!-- .slide: data-state="keepintouch" -->
+
+
+www.esciencecenter.nl
+
+[email protected]
+
+020 - 460 47 70

modules/module2/exercises_module2.md

@@ -0,0 +1,9 @@
+---
+title: Exercises
+type: exercise
+order: 2
+---
+
+# Exercises
+
+Add here your exercises...

modules/module2/further_reading_module2.md

@@ -0,0 +1,9 @@
+---
+title: Reading material
+type: reading
+order: 3
+---
+
+# Reading material
+
+Add here links to relevant reading material...

modules/module2/index.md

@@ -0,0 +1,11 @@
+---
+id: 1
+trl: medium
+category: Category2
+title: Title of module 2
+author: eScience Center
+thumbnail: "nlesc-dummy.png"
+visibility: visible
+---
+
+# Category 2

modules/module2/info.md

@@ -0,0 +1,7 @@
+---
+title: Learning objectives
+type: info
+order: 0
+---
+
+Learning objectives of Module 2

modules/module2/slides_module2.md

@@ -0,0 +1,34 @@
+---
+title: Module 2
+type: slides
+order: 1
+---
+
+<!-- .slide: data-state="title" -->
+
+# Module 2
+
+===
+
+<!-- .slide: data-state="standard" -->
+
+## Title of the first slide
+
+<center>
+<img src="media/fig-dummy.png" width="55%">
+</center>
+
+Note:
+
+Add notes to the presenter...
+
+===
+
+<!-- .slide: data-state="keepintouch" -->
+
+
+www.esciencecenter.nl
+
+[email protected]
+
+020 - 460 47 70