Merge branch 'release' into workshop-update

book/_toc.yml

@@ -43,10 +43,6 @@ parts:
       - file: basic-features/Code_block_figures
       - file: basic-features/banner
         title: Banner or Announcement
-    - file: basic-features/external-features.md
-      sections:
-      - file: basic-features/hypothesis.md
-      - file: basic-features/utterances.md
     - file: features/easy-editing.md
       sections:
       - file: external/template/README.md
@@ -57,7 +53,8 @@ parts:
     - file: features/sphinx_extensions.md
       sections: 
       - file: external/Download-Link-Replacer/README.md
-      - file: features/custom-launch-button.md      
+      - file: features/custom-launch-button.md
+      - file: basic-features/utterances.md      
       - file: features/interactive_element.ipynb
         sections:
         - file: external/Sphinx-Grasple-public/README.md
@@ -80,6 +77,7 @@ parts:
     - file: features/students
       sections:
       - file: external/annotater/README.md
+      - file: basic-features/hypothesis.md
 
   - caption: Examples
     chapters:

book/basic-features/external-features.md

@@ -1,8 +0,0 @@
-# Externally Developed Features
-
-```{admonition} User types
-:class: tip
-This section is useful for user type 1-5.
-```
-
-This chapter includes features useful for books in the educational context, developed by various parties. 

book/basic-features/hypothesis.md

@@ -1,5 +1,10 @@
 # Making comments on the website: Hypothesis
 
+```{admonition} User types
+:class: tip
+This section is useful for user type 1-5.
+```
+
 {bdg-warning}`Javascript overlay` {bdg-success}`Chrome Extension`
 
 Hypothesis is a third-party application that allows anyone to make publicly visible comments on a website (once you create a free account). This section explains how to use and install the extension. As this tool requires an account with a third-party, we advise to use our [local-annotator](../external/annotater/README.md) with similar capabilities but which store annotations locally. By default Hypothesis stores annotations publicly, which might confuse other students.

book/basic-features/utterances.md

@@ -1,5 +1,10 @@
 # Discussions in your book: Utterances
 
+```{admonition} User types
+:class: tip
+This section is useful for user type 3-5.
+```
+
 {bdg-white}`GitHub app and Javascript script`
 
 [Utterances 🔮](https://utteranc.es/) is a lightweight open-source widget which allows you, your colleages and your students to discuss stuff in a blog post in your book. It is build on GitHub issues, so requires a GitHub repository, although the book can be hosted anywhere (so also on GitLab).

book/external/template

@@ -1 +1 @@
-Subproject commit 433ec22593872e4d899fd0ffe037cf659a97edca
+Subproject commit 3d424555e5c727db9e614e1004bd27899b51814b

book/features/overview.md

@@ -1,8 +1,13 @@
 # Overview
 
-As TeachBooks, we collect a suite of existing open-source software and keep our books up-to-date so you don't have to! Some of the software is developed with our TA's to improve the learning experience of our students and ease the book-development process for our teachers. By deploying these tools from a central location we can prevent common problems before they arise, and fix them quickly when they do occur. As the open-source software landscape changes rapidly, it is essential to keep in contact and share resources amongst ourselves to minimize maintenance and downtime for our book websites and focus on what really matters: teaching!
+As TeachBooks, we collect a suite of existing open-source software so you don't have to! Some of the software is developed with our TA's to improve the learning experience of our students and ease the book-development process for our teachers. As the open-source software landscape changes rapidly, it is essential to keep in contact and share resources amongst ourselves to minimize maintenance and downtime for our book websites and focus on what really matters: teaching!
 
 Since the list of TeachBook features is getting quite long, we have grouped them in categories:
+- Original Jupyter Book and Sphinx features
+- Easy editing process
+- Additional functionality
+- Book styling
+- TeachBooks student-view features
 
 Additionally, not all features are built using the same type of sourcecode. For transparency, tags will help differentiate between the different backgrounds of the features:
 - {bdg-warning}`Javascript overlay`
@@ -10,6 +15,7 @@ Additionally, not all features are built using the same type of sourcecode. For
 - {bdg-white}`GitHub App and Javascript script`
 - {bdg-secondary}`Python Package`
 - {bdg-light}`GitHub Reusable Action`
+- {bdg-light}`GitHub Template`
 - {bdg-dark}`Git Workflow`
 - {bdg-primary}`Sphinx Extension`
 - {bdg-danger}`iframe`