From edb7789d153c932ff437e2a871061da6415dae97 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 29 Nov 2024 10:57:43 +0100 Subject: [PATCH] Added user types everywhere --- book/basic-features/external-features.md | 9 ++++++++- book/features/easy-editing.md | 9 ++++++++- book/features/interactive_element.ipynb | 2 +- book/features/sphinx_extensions.md | 5 +++++ book/features/students.md | 7 ++++++- 5 files changed, 28 insertions(+), 4 deletions(-) diff --git a/book/basic-features/external-features.md b/book/basic-features/external-features.md index 39d9505..d574b30 100644 --- a/book/basic-features/external-features.md +++ b/book/basic-features/external-features.md @@ -1 +1,8 @@ -# Externally Developed Features \ No newline at end of file +# 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. \ No newline at end of file diff --git a/book/features/easy-editing.md b/book/features/easy-editing.md index bb07d7d..418f55b 100644 --- a/book/features/easy-editing.md +++ b/book/features/easy-editing.md @@ -1 +1,8 @@ -# Easy Editing Process \ No newline at end of file +# Easy Editing Process + +```{admonition} User types +:class: tip +This section is useful for user type 3-5. +``` + +The following tools are created by TeachBooks to ease the process of making books. We acknowledge that making books is a difficult process; it requires advanced knowledge on CLI, python packages, html-files, data-storage and website hosting. The tools in this chapter are intended for those users who lack knowledge on these topics (which includes most of the TeachBooks' community members itself). \ No newline at end of file diff --git a/book/features/interactive_element.ipynb b/book/features/interactive_element.ipynb index 75bd000..f5fecce 100644 --- a/book/features/interactive_element.ipynb +++ b/book/features/interactive_element.ipynb @@ -9,7 +9,7 @@ "source": [ "# Interactive content: Elements not including Python\n", "\n", - "To add interactivity to the book, you can make use of interactive elements which are embedded in the book. You've four options:\n", + "To add interactivity to the book, you can make use of interactive elements which are embedded in the book. You've a few options:\n", "\n", " - Admonition: question provided in normal markdown language with answers in a drowdown menu. There's no feedback delivered to the student, only the correct answer no matter what the student's thinking/work.\n", " - JupyterQuiz: code-based implementation of multiple-choiche questions and numerical answer questions. This is a basic open course tool which requires you to write your quiz questions in Python language as a `dict` or to a `.json` file.\n", diff --git a/book/features/sphinx_extensions.md b/book/features/sphinx_extensions.md index 59eae0d..b30128a 100644 --- a/book/features/sphinx_extensions.md +++ b/book/features/sphinx_extensions.md @@ -1,5 +1,10 @@ # Sphinx Extensions +```{admonition} User types +:class: tip +This section is useful for user type 4-5. +``` + Sphinx extensions are plugins developed for the Sphinx documentation ecosystem (which Jupyter Book is built upon). They extend or modify Sphinx’s capabilities and can be added to Jupyter Book for extra functionality. Since Sphinx extensions are not an integral part of jupyter-book, as opposed to original jupyter-book features, they must be installed and configured explicitly, for example in the `_config.yml` file. At TeachBooks, we have many TA's working on developing cool and handy extensions to use in our books. Here's an overview: diff --git a/book/features/students.md b/book/features/students.md index a9a1abf..46a6993 100644 --- a/book/features/students.md +++ b/book/features/students.md @@ -1,3 +1,8 @@ # TeachBooks Student-view Features -This chapter includes some TeachBooks features which aim to improve the way students can use TeachBooks. These tools are fully student-side, they don't influence the book website and the author doesn't have to setup anything. Nevertheless, the author could point the students to the availability of these tools and use it as part of the didactical approach. +```{admonition} User types +:class: tip +This section is useful for user type 1-5. +``` + +This chapter includes some TeachBooks features which aim to improve the way students can use TeachBooks. These tools are fully student-side, they don't influence the book website and the author doesn't have to setup anything. Nevertheless, the author could point the students to the availability of these tools and use it as part of the didactical approach. These tools could also be useful for other users.