Update material template

bin/update-material-template.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+#
+# Update material template for the directory that was provided as a parameter.
+
+if [ $# -lt 1 ]; then
+  echo 1>&2 "$0: not enough arguments"
+  exit 2
+elif [ $# -gt 1 ]; then
+  echo 1>&2 "$0: too many arguments"
+  exit 2
+fi
+
+updated_repository=${1%/}
+
+BASEDIR=$(dirname "$0")
+BASEDIR_WITHOUT_BIN=${BASEDIR%bin}
+
+if [ -z "$BASEDIR_WITHOUT_BIN" ]; then
+  BASEDIR_WITHOUT_BIN="."
+fi
+
+rm -r $updated_repository/gatsby-*
+rm -r $updated_repository/package*
+rm -r $updated_repository/plugins
+rm -r $updated_repository/src
+rm -r $updated_repository/docs
+rm -r $updated_repository/bin
+
+cp -r $BASEDIR_WITHOUT_BIN/gatsby-* $updated_repository
+cp -r $BASEDIR_WITHOUT_BIN/package* $updated_repository
+cp -r $BASEDIR_WITHOUT_BIN/plugins $updated_repository/plugins
+cp -r $BASEDIR_WITHOUT_BIN/src $updated_repository/src
+cp -r $BASEDIR_WITHOUT_BIN/docs $updated_repository/docs
+cp -r $BASEDIR_WITHOUT_BIN/bin $updated_repository/bin

course-settings.js

@@ -2,54 +2,13 @@ const courseSettings = {
   language: "fi",
   name: "Ohjelmoinnin MOOC 2020",
   siteUrl: "https://ohjelmointi-20.mooc.fi",
+  githubUrl: "https://github.com/rage/python-s20",
   subtitle: "Ohjelmoinnin alkeet kaikille, ilmaiseksi",
   slug: "ohjelmoinnin-mooc-2020",
   tmcCourse: "2020-ohjelmointi",
   quizzesId: "a9251b4f-b3d2-4d0c-ab01-a143eb2834b5",
   tmcOrganization: "mooc",
   bannerPath: "banner.svg",
-  sidebarEntries: [
-    {
-      title: "Tietoa kurssista",
-      path: "/",
-    },
-    {
-      title: "Arvostelu ja kokeet",
-      path: "/arvostelu-ja-kokeet",
-    },
-    {
-      title: "Mahdollisuus opinto-oikeuteen",
-      path: "/opinto-oikeus",
-    },
-    { title: "Tukiväylät", path: "/tukivaylat" },
-    {
-      title: "Opettajille ja opinto-ohjaajille",
-      path: "/opettajille",
-    },
-    {
-      title: "Usein kysytyt kysymykset",
-      path: "/usein-kysytyt-kysymykset",
-    },
-    { separator: true, title: "Ohjelmoinnin perusteet" },
-  ],
-  sidebarFuturePages: [
-    { title: "Osa 3", tba: "11.1.2020" },
-    { title: "Osa 4", tba: "25.1.2020" },
-    { title: "Osa 5", tba: "1.2.2020" },
-    { title: "Osa 6", tba: "8.2.2020" },
-    { title: "Osa 7", tba: "15.2.2020" },
-    { separator: true, title: "Ohjelmoinnin jatkokurssi" },
-    { title: "Osa 8", tba: "1.3.2020" },
-    { title: "Osa 9", tba: "8.3.2020" },
-    { title: "Osa 10", tba: "15.3.2020" },
-    { title: "Osa 11", tba: "22.3.2020" },
-    { title: "Osa 12", tba: "29.3.2020" },
-    { title: "Osa 13", tba: "12.4.2020" },
-    { title: "Osa 14", tba: "19.4.2020" },
-  ], // { title: "Osa 14", tba: "19.4.2019" },
-  splitCourses: false,
 }
 
-module.exports = {
-  default: courseSettings,
-}
+module.exports = courseSettings

data/arvostelu-ja-kokeet.md

@@ -3,6 +3,7 @@ path: "/arvostelu-ja-kokeet"
 title: "Arvostelu ja kokeet"
 hidden: false
 information_page: true
+sidebar_priority: 4000
 ---
 
 Ohjelmoinnin MOOC sisältää Helsingin yliopiston kurssit Ohjelmoinnin perusteet (materiaalin osat 1-7) ja Ohjelmoinnin jatkokurssi (materiaalin osat 8-14). Kummastakin osasta järjestetään verkossa tehtävä ilmainen koe, ja kummastakin osasta saa erillisen arvosanan. Ohjelmoinnin MOOCista on kaksi versiota: aikataulutettu kurssi ja aikatauluttamaton kurssi. Näiden arvostelu poikkeaa hieman toisistaan.

data/frontmatter-guide.md

@@ -0,0 +1,87 @@
+---
+banner: false
+hidden: true
+hide_in_sidebar: true
+information_page: false
+overview: true
+path: "/frontmatter-guide"
+separator_after: "derp"
+sidebar_priority: 1337
+title: "Frontmatter-guide"
+upcoming: "1.1."
+vocabulary_page: false
+---
+
+### Kaikki mahdolliset frontmatter-fieldit:
+
+banner
+
+- Ei pakollinen
+- Boolean-tyyppinen
+- Lisää projektin juuresta löytyvän banner.svg -kuvan sivun yläreunaan.
+- HUOM! Banneri lisätään vain, jos myös information\_page on true
+
+hidden
+
+- Ei pakollinen
+- Boolean-tyyppinen
+- Sivua ei näy sivupalkissa (HUOM! käytä mieluummin hide\_in\_sidebar-kenttää, jos haluat piilottaa sivun ainoastaan sivupalkista)
+- Heittää 404, jos yrittää mennä sivun url:iin
+
+hide\_in\_sidebar
+
+- Ei pakollinen
+- Boolean-tyyppiä
+- Piilottaa sivun sivupalkista, jos se muuten näkyisi sivupalkissa. Sivupalkissa näkyy oletuksena kaikki index.md-nimiset tiedostot sekä kaikki data-kansion juuressa olevat markdown-tiedostot.
+
+information\_page
+
+- Ei pakollinen
+- Boolean-tyyppinen
+- Sivupalkkia varten. Tiedostot, joissa information\_page on true, ovat ensimmäisinä sivupalkissa
+
+overview
+
+- Ei pakollinen
+- Boolean-tyyppinen
+- Tarkoitettu kurssin osien indeksisivuille (esim osa-01/index.md). Piilottaa sivujen alareunassa olevan listan osan aliosista. HUOM! Nämä ovat piilotettu myös information\_page-sivuista, eli tätä ei tarvitse erikseen asettaa false:ksi information\_page-sivuilla
+
+path
+
+- Pakollinen
+- String-tyyppinen
+- Polku tiedostoon url:ssa, muodossa baseurl/path
+
+separator\_after
+
+- Ei pakollinen
+- String-tyyppinen
+- Lisää sivupalkkiin jakajan sivun linkin jälkeen.
+- Jos asetettu tyhjäksi tekstiksi (separator\_after: ""), pelkkä jakaja ilman otsikkoa. Jos ei tyhjä, jakajan alla on otsikkona asetettu teksti.
+
+sidebar\_priority
+
+- Ei pakollinen
+- Integer-tyyppinen
+- Tarkoitettu vain information\_page-sivuille
+- Tällä kentällä voi uudelleenjärjestää sivupalkin information\_page-sivujen linkkejä. Sivupalkissa on oletuksena ensin information\_page-sivut, sitten muut. Sekä information\_page-sivut että muut ovat aakkosjärjestyksessä.
+- sidebar\_priority-kentän omaavat sivut tulevat ennen muita, ja ne ovat suuruusjärjestyksessä suurimmasta pienimpään (`sidebar_priority: 5000` tulee ennen `sidebar_priority: 2000`)
+
+title
+
+- Pakollinen
+- String-tyyppinen
+- Sivun otsikko selaimen yläreunassa, selaimen välilehdessä, sekä itse tiedoston yläreunassa
+
+upcoming
+
+- Ei pakollinen
+- String-tyyppinen
+- Jos asetettu, sivun linkki sivupalkissa on harmaana, ei klikattavissa, ja sen vieressä lukee asetettu teksti.
+- Suosittelemme, että tekstiksi asetetaan sivun julkaisupäivämäärä muodossa "pv.kk.", koska kenttä on sen verran pieni ettei vuosiluku mahdu kokonaan näkyville.
+
+vocabulary\_page
+
+- Ei pakollinen
+- Boolean-tyyppinen
+- Tarkoitettu ainoastaan sanastosivua varten. Jos tämä on asetettu, sivulla on pääsy dataan sanaston sanoista.

data/index.md

@@ -4,6 +4,7 @@ title: "Tietoa kurssista"
 hidden: false
 information_page: true
 banner: true
+sidebar_priority: 5000
 ---
 
 Ohjelmoinnin MOOC on kaikille avoin ja ilmainen ohjelmoinnin perusteet

data/koe-ja-moodle-ilmoittautuminen.md

@@ -3,6 +3,7 @@ path: "/koe-ja-moodle-ilmoittautuminen"
 title: "Koe ja Moodle-ilmoittautuminen"
 hidden: false
 information_page: true
+hide_in_sidebar: true
 ---
 
 Draft

data/macos-ohjeet.md

@@ -3,6 +3,7 @@ path: "/macos-ohjeet"
 title: "macOS ohjeet"
 hidden: false
 information_page: true
+hide_in_sidebar: true
 ---
 
 ## Käyttöliittymätestit

data/nayttokokeesta.md

@@ -3,6 +3,7 @@ path: '/nayttokokeesta'
 title: 'Näyttökokeesta'
 hidden: false
 information_page: true
+hide_in_sidebar: true
 ---
 
 Tämä sivu koskee niitä opiskelijoita, jotka hakevat opinto-oikeutta aikataulullisen Ohjelmoinnin MOOC -kurssin kautta.

data/opinto-oikeus.md

@@ -4,6 +4,7 @@ title: 'Mahdollisuus opinto-oikeuteen'
 hidden: false
 information_page: true
 banner: false
+sidebar_priority: 3000
 ---
 
 ### Olet oikeutettu hakemaan opiskelupaikkaa jos

data/osa-10/index.md

@@ -3,6 +3,7 @@ path: '/osa-10'
 title: 'Osa 10'
 overview: true
 hidden: true
+upcoming: "15.3.2020"
 ---
 
 <only-for-course-variant variant="dl">

data/osa-11/index.md

@@ -3,6 +3,7 @@ path: '/osa-11'
 title: 'Osa 11'
 overview: true
 hidden: true
+upcoming: "22.3.2020"
 ---
 
 <only-for-course-variant variant="dl">

data/osa-12/index.md

@@ -3,6 +3,7 @@ path: '/osa-12'
 title: 'Osa 12'
 overview: true
 hidden: true
+upcoming: "29.3.2020"
 ---
 
 <only-for-course-variant variant="dl">

data/osa-13/index.md

@@ -3,6 +3,7 @@ path: '/osa-13'
 title: 'Osa 13'
 overview: true
 hidden: true
+upcoming: "12.4.2020"
 ---
 
 <only-for-course-variant variant="dl">

data/osa-14/index.md

@@ -3,6 +3,7 @@ path: '/osa-14'
 title: 'Osa 14'
 overview: true
 hidden: true
+upcoming: "19.4.2020"
 ---
 
 <only-for-course-variant variant="dl">

data/osa-15/index.md

@@ -3,6 +3,7 @@ path: '/osa-14'
 title: 'Osa 15'
 overview: true
 hidden: true
+hide_in_sidebar: true
 ---
 
 <only-for-course-variant variant="dl">

data/osa-3/index.md

@@ -3,6 +3,7 @@ path: '/osa-3'
 title: 'Osa 3'
 overview: true
 hidden: false
+upcoming: "11.1.2020"
 ---
 
 <only-for-course-variant variant="dl">

data/osa-4/index.md

@@ -3,6 +3,7 @@ path: '/osa-4'
 title: 'Osa 4'
 overview: true
 hidden: false
+upcoming: "25.1.2020"
 ---
 
 <only-for-course-variant variant="dl">

data/osa-5/index.md

@@ -3,6 +3,7 @@ path: '/osa-5'
 title: 'Osa 5'
 overview: true
 hidden: false
+upcoming: "1.2.2020"
 ---
 
 <only-for-course-variant variant="dl">

data/osa-6/index.md

@@ -3,6 +3,7 @@ path: '/osa-6'
 title: 'Osa 6'
 overview: true
 hidden: false
+upcoming: "8.2.2020"
 ---
 
 <only-for-course-variant variant="dl">

data/osa-7/index.md

@@ -3,6 +3,8 @@ path: '/osa-7'
 title: 'Osa 7'
 overview: true
 hidden: false
+separator_after: "Ohjelmoinnin jatkokurssi"
+upcoming: "15.2.2020"
 ---
 
 <only-for-course-variant variant="dl">

data/osa-8/index.md

@@ -3,6 +3,7 @@ path: '/osa-8'
 title: 'Osa 8'
 overview: true
 hidden: true
+upcoming: "1.3.2020"
 ---
 
 <only-for-course-variant variant="dl">

data/osa-9/index.md

@@ -3,6 +3,7 @@ path: '/osa-9'
 title: 'Osa 9'
 overview: true
 hidden: true
+upcoming: "8.3.2020"
 ---
 
 <only-for-course-variant variant="dl">

data/osaamistavoitteet.md

@@ -3,6 +3,7 @@ path: "/osaamistavoitteet"
 title: "Osaamistavoitteet"
 hidden: true
 information_page: true
+hide_in_sidebar: true
 ---
 
 TODO: rewrite

data/tukivaylat.md

@@ -3,6 +3,7 @@ path: "/tukivaylat"
 title: "Tukiväylät"
 hidden: false
 information_page: true
+sidebar_priority: 2000
 ---
 
 Kurssilla on vertaistukeen perustuva keskustelukanava, jonka lisäksi tammikuun puolesta välistä lähtien kaikilla kurssilaisilla on mahdollisuus ohjaukseen Helsingin yliopiston Kumpulan kampuksella.

data/usein-kysytyt-kysymykset.md

@@ -3,6 +3,7 @@ path: "/usein-kysytyt-kysymykset"
 title: "Usein kysytyt kysymykset"
 hidden: false
 information_page: true
+separator_after: "Ohjelmoinnin perusteet"
 ---
 
 Tässä usein kysyttyjä kysymyksiä ja ongelmia. Jos et löydä kysymykseesi vastausta täältä, voit esitttää sen [tukiväylillämme](/tukivaylat).

data/vaihda-aikatauluttomaan.md

@@ -3,6 +3,7 @@ path: '/vaihda-aikatauluttomaan'
 title: 'Kurssin vaihto aikatauluttomaan versioon'
 hidden: false
 information_page: true
+hide_in_sidebar: true
 ---
 
 <notice>HUOMAATHAN, että aikatauluton kurssi ei ole vielä alkanut. Aikatauluton kurssi avataan ensimmäisen deadlinen jälkeen.</notice>

data/vocabulary.md

@@ -0,0 +1,11 @@
+---
+path: "/sanasto"
+title: "Sanasto"
+hidden: false
+information_page: true
+banner: false
+vocabulary_page: true
+hide_in_sidebar: true
+---
+
+<vocabulary />

docs/how-to-update-template.md

@@ -0,0 +1,15 @@
+## How to update the template
+
+To update a course using this repository as a template, simply execute the script `update-material-template.sh` found in this repository's bin-directory.
+
+The script takes a single parameter, the path to the directory of the course that's updated.
+
+The script updates the following parts in the target directory:
+
+- src-directory
+- plugins-directory
+- docs-directory
+- all files beginning with `gatsby-`
+- all files beginning with `package`
+
+Note, that you might have to manually update some files (such as course-settings.js), if needed.