From f7b4065176b30b88f951b5940ccc921597cc71c6 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sat, 16 Nov 2024 15:44:06 +0100 Subject: [PATCH] Update links --- README.md | 10 +++++----- book/basic-features/hypothesis.md | 19 ++++--------------- book/external/Download-Link-Replacer | 2 +- book/external/JupyterBook-Patches | 2 +- book/external/Nested-Books | 2 +- book/external/Sphinx-Image-Inverter | 2 +- book/external/Useful_python_code | 2 +- book/external/deploy-book-workflow | 2 +- book/external/template | 2 +- book/installation-and-setup/anaconda.md | 10 +++------- book/installation-and-setup/tools.md | 2 +- book/intro.md | 10 +++++----- 12 files changed, 25 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index f0f5dd7..c92464c 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ # TeachBooks Manual -This manual assists you in creating and collaborating on [JupyterBooks](https://jupyterbook.org/) for educational purposes. Some parts are specifically aimed for teachers at Delft University of Technology, although all material and tools are openly available. This manual aims at providing an easy start and advanced usages for new and existing users with or without skills on this topic. it is part of TeachBooks, for more information visit [https://teachbooks.tudelft.nl/](https://teachbooks.tudelft.nl/). +This manual assists you in creating and collaborating on [JupyterBooks](https://jupyterbook.org/) for educational purposes. Some parts are specifically aimed for teachers at Delft University of Technology, although all material and tools are openly available. This manual aims at providing an easy start and advanced usages for new and existing users with or without skills on this topic. it is part of TeachBooks, for more information visit [https://teachbooks.io/](https://teachbooks.io/). ## Contact -If you encounter any issues and you have a TU Delft account, report it by clicking the gitlab icon and lightbulb on the top right corner of this page. Or contribute directly by creating a merge request in the [repository](https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual). +If you encounter any issues and you have a TU Delft account, report it by clicking the gitlab icon and lightbulb on the top right corner of this page. Or contribute directly by creating a merge request in the [repository](https://github.com/Teachbooks/manual). If you have questions, contact Tom van Woudenberg, Robert Lanzafame or our TA Julie Kirsch at TeachBooks@tudelft.nl, also for non-TU Delft account holders. TU Delft account holder can also contact us in the [MS Teams Open Interactive Textbooks Community](https://teams.microsoft.com/l/team/19%3Ah9-uRcP_yYauh-VuoPFozJVUvHVOB4a0mz1ZWvh4q4Q1%40thread.tacv2/conversations?groupId=3e88c1f3-4a4f-483a-a366-7e617de9ba99&tenantId=096e524d-6929-4030-8cd3-8ab42de0887b) We really value your feedback on this manual. This helps us improving it. Please keep using the manual as you build your own Jupyter Book and come back to fill out this short [survey](https://forms.gle/hXbFUQgN95H8ftxt9). ## Contribute -This book will continue to develop, so feel free to contribute https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual! You can do so directly by forking this repository and creating a merge request. +This book will continue to develop, so feel free to contribute https://github.com/TeachBooks/manual! You can do so directly by forking this repository and creating a merge request. -The released book can be found on on https://teachbooks.tudelft.nl/jupyter-book-manual. This page shows the built book of the `release` branch. The `main` branch is meant for reviewing and is visible here: https://teachbooks.tudelft.nl/jupyter-book-manual/draft. All branches will also be visible on the mirrored repository on GitHub Pages: https://github.com/TeachBooks/mirror_teachbook_manual/actions +The released book can be found on on https://teachbooks.io/manual. This page shows the built book of the `release` branch All branches will also be visible as seen in the action's summaries: https://github.com/TeachBooks/mirror_teachbook_manual/actions -Some parts of this book are taken from other sources in the form of submodules (linked in the folder [book/external](book/external)). To contribute to those pages, contribute to the source repository directly with a fork and merge/pull request. If you intent to clone this boko including its submodules, clone using: `git clone --recurse-submodules git@gitlab.tudelft.nl:interactivetextbooks-citg/jupyter-book-manual.git` +Some parts of this book are taken from other sources in the form of submodules (linked in the folder [book/external](book/external)). To contribute to those pages, contribute to the source repository directly with a fork and merge/pull request. If you intent to clone this boko including its submodules, clone using: `git clone --recurse-submodules git@github.com:TeachBooks/manual.git` Happy book building! \ No newline at end of file diff --git a/book/basic-features/hypothesis.md b/book/basic-features/hypothesis.md index b438ae3..117ae48 100644 --- a/book/basic-features/hypothesis.md +++ b/book/basic-features/hypothesis.md @@ -20,27 +20,16 @@ html: ``` ## Using Hypothesis -In this case it is easier to learn by doing! Hypothesis has been enabled for this book, but only in the _draft_ version. +In this case it is easier to learn by doing! Hypothesis has been enabled for this book, but only in the _hypothesis_ version: https://teachbooks.tudelft.io/manual/hypothesis -````{admonition} How to View the Draft Site -:class: tip, dropdown -You can access the draft version by adding `draft/` at the end of the main book (but before the current page). For example: +Once on the hypothesis version of this page, look at the top right corner: you will see three icons, an arrow, an eye and a note-pad. Clicking on the arrow will open the extension and allow you to view the annotations. Create an account and log in if you would like to reply or make your own annotations. You can also highlight text, but this is not publicly visible, it is only for your own reference. -``` -https://teachbooks.tudelft.nl/jupyter-book-manual/draft/basic-features/hypothesis.html -``` - -You can find out more about the draft and publish feature on {ref}`this page `. -```` - -Once on the draft version of this page, look at the top right corner: you will see three icons, an arrow, an eye and a note-pad. Clicking on the arrow will open the extension and allow you to view the annotations. Create an account and log in if you would like to reply or make your own annotations. You can also highlight text, but this is not publicly visible, it is only for your own reference. - -Note that the annotations are only visible for the page that you are currently viewing. You can see all the Annotations on a website by opening the "Public" menu at the top of the dialog pane, selecting "Public" again in the drop-down, then "View group activity." Make sure you type in the URL to search (e.g., `teachbooks.tudelft.nl/jupyter-book-manual`). +Note that the annotations are only visible for the page that you are currently viewing. You can see all the Annotations on a website by opening the "Public" menu at the top of the dialog pane, selecting "Public" again in the drop-down, then "View group activity." Make sure you type in the URL to search (e.g., `teachbooks.io/manual`). ```{admonition} Tips :class: tip -- use the {ref}`remove_from_publish` feature to enable Hypothesis in the draft book only +- use the {ref}`remove_from_publish` feature to enable Hypothesis in a specific version of the book only ``` ## Student-controller with browser extension diff --git a/book/external/Download-Link-Replacer b/book/external/Download-Link-Replacer index bb7884a..e220538 160000 --- a/book/external/Download-Link-Replacer +++ b/book/external/Download-Link-Replacer @@ -1 +1 @@ -Subproject commit bb7884aaf0c0205b2c0b8a7bb676e929528b2e33 +Subproject commit e2205387f4446e736a89d6f5e70e0bddfa955a98 diff --git a/book/external/JupyterBook-Patches b/book/external/JupyterBook-Patches index a476ff8..8d97cb2 160000 --- a/book/external/JupyterBook-Patches +++ b/book/external/JupyterBook-Patches @@ -1 +1 @@ -Subproject commit a476ff813e481dcab65d02cb869266cb6a704451 +Subproject commit 8d97cb21d7d5f67cc19d35768c5e257d36cc0e69 diff --git a/book/external/Nested-Books b/book/external/Nested-Books index 6037083..c0aab87 160000 --- a/book/external/Nested-Books +++ b/book/external/Nested-Books @@ -1 +1 @@ -Subproject commit 60370834c33ea9b7754d685ecb5bc2d3a8a0ebc1 +Subproject commit c0aab87a87c97e2c643c4e905a0065a49d925616 diff --git a/book/external/Sphinx-Image-Inverter b/book/external/Sphinx-Image-Inverter index 7db6dbb..95fccf0 160000 --- a/book/external/Sphinx-Image-Inverter +++ b/book/external/Sphinx-Image-Inverter @@ -1 +1 @@ -Subproject commit 7db6dbbed739366e1b60e4b6349db97b943ec540 +Subproject commit 95fccf09f2c9d42ae473b3ed6033ebcb948792b1 diff --git a/book/external/Useful_python_code b/book/external/Useful_python_code index a647c34..e522976 160000 --- a/book/external/Useful_python_code +++ b/book/external/Useful_python_code @@ -1 +1 @@ -Subproject commit a647c34fa7b50cb95ef0c1d34ad07599292336ad +Subproject commit e522976583a6c8cbc910531e972320a45f942737 diff --git a/book/external/deploy-book-workflow b/book/external/deploy-book-workflow index 69f1248..87fe477 160000 --- a/book/external/deploy-book-workflow +++ b/book/external/deploy-book-workflow @@ -1 +1 @@ -Subproject commit 69f12482bf328a472b70d5f9c859729121ff0342 +Subproject commit 87fe4771b5154033f2c3aa915d9f21e2b45f4cfa diff --git a/book/external/template b/book/external/template index 0c2fa6f..5aadbc5 160000 --- a/book/external/template +++ b/book/external/template @@ -1 +1 @@ -Subproject commit 0c2fa6f93d5acdf97e4572c0f394a10882603524 +Subproject commit 5aadbc527ee1251a60cbd4877d109b0558e03aad diff --git a/book/installation-and-setup/anaconda.md b/book/installation-and-setup/anaconda.md index 5af4006..2018504 100644 --- a/book/installation-and-setup/anaconda.md +++ b/book/installation-and-setup/anaconda.md @@ -60,18 +60,14 @@ Here's an example of what a `requirements.txt` file might look like. ``` # first list the packages you wish to download from PyPI sympy +teachbooks +jupyterbook_patches # now list the packages (and the respective url) you wish to download from the GitLab package registry ---index-url https://__token__:glpat-JduurUdhDczFJzvzZN4G@gitlab.tudelft.nl/api/v4/projects/13957/packages/pypi/simple -teachbooks ---extra-index-url https://gitlab.tudelft.nl/api/v4/projects/17983/packages/pypi/simple -jupyterbook_patches ~= 0.1.4 --extra-index-url https://gitlab.tudelft.nl/api/v4/projects/11239/packages/pypi/simple sphinx-thebe ~= 0.9.9 - -# lastly any packages you wish to download directly from a Git repository -download_link_replacer @ git+https://gitlab.tudelft.nl/mude/sphinx-download-link-replacer ``` + This file needs to be manually updated by the team everytime a new package is required. It will be useful to routinely update the packages in your environment by downloading the required packages again. The packages used by sphinx-thebe or JupyterLite-Sphinx are not influenced by `requirements.txt`. You can do this by navigating your command line interface to the folder with `requirements.txt`: diff --git a/book/installation-and-setup/tools.md b/book/installation-and-setup/tools.md index fc7ea52..90cc64a 100644 --- a/book/installation-and-setup/tools.md +++ b/book/installation-and-setup/tools.md @@ -46,7 +46,7 @@ Choosing between GitHub and GitLab depends on multiple criteria. GitHub provides ### Book URL Github allows you to host your book on the GitHub server using GitHub pages (to be recognized by the `.github.io/` url, for example the [template book](https://teachbooks.github.io/template/)), which takes all the steps of hosting out of your hands. If you're book is part of the [GitHub Enterprise TU Delft](https://github.com/enterprises/tudelft) and is using SSO, a random url is generated `.github.io/`. Next to GitHub-provided URLs, you can set up a custom owned URL, although this requires some additional skills on a domain which you should own. For courses we advise you to create a organization with the course name so that the URL represent that course. -On TU Delft's GitLab you need a webserver, which is offered by TeachBooks (to be recognized by the url `teachbooks.tudelft.nl/`, for example [this manual](https://teachbooks.tudelft.nl/jupyter-book-manual)) as the TU Delft OIT team (to be recognized by the url `interactivetextbooks.tudelft.nl/`, for example [the TU Delft OIT demo book](https://interactivetextbooks.tudelft.nl/open-textbooks-demonstration/)). +On TU Delft's GitLab you need a webserver, which is offered by TeachBooks (to be recognized by the url `teachbooks.tudelft.nl/`, as the TU Delft OIT team (to be recognized by the url `interactivetextbooks.tudelft.nl/`. ### Real-time editing book Editing the book can happen both locally as online on GitHub/GitLab. If done locally, the book can be generated and viewed locally too (typically takes around 1 minute) but this requires you to be at least user type 4 or 5 depending on the book content. The built book can also be viewed online separate from the released version. diff --git a/book/intro.md b/book/intro.md index a4db0d9..ba7005f 100644 --- a/book/intro.md +++ b/book/intro.md @@ -1,19 +1,19 @@ # TeachBooks Manual -This manual assists you in creating and collaborating on Jupyter book for educational purposes. Some parts are specifically aimed for teachers at Delft University of Technology, although all material and tools are openly available. This manual aims at providing an easy start and advanced usages for new and existing users with or without skills on this topic. it is part of TeachBooks, for more information visit [https://teachbooks.tudelft.nl/](https://teachbooks.tudelft.nl/). +This manual assists you in creating and collaborating on Jupyter book for educational purposes. Some parts are specifically aimed for teachers at Delft University of Technology, although all material and tools are openly available. This manual aims at providing an easy start and advanced usages for new and existing users with or without skills on this topic. it is part of TeachBooks, for more information visit [https://teachbooks.io/](https://teachbooks.io/). ## Contact -If you encounter any issues and you have a TU Delft account, report it by clicking --> {fa}`lightbulb` on the top right corner of this page. Or contribute directly by creating a merge request in the [repository](https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual). +If you encounter any issues and you have a TU Delft account, report it by clicking --> {fa}`lightbulb` on the top right corner of this page. Or contribute directly by creating a merge request in the [repository](https://github.com/TeachBooks/manual). If you have questions, contact Tom van Woudenberg, Robert Lanzafame or our TA Julie Kirsch at TeachBooks@tudelft.nl, also for non-TU Delft account holders. TU Delft account holder can also contact us in the [MS Teams Open Interactive Textbooks Community](https://teams.microsoft.com/l/team/19%3Ah9-uRcP_yYauh-VuoPFozJVUvHVOB4a0mz1ZWvh4q4Q1%40thread.tacv2/conversations?groupId=3e88c1f3-4a4f-483a-a366-7e617de9ba99&tenantId=096e524d-6929-4030-8cd3-8ab42de0887b) We really value your feedback on this manual. This helps us improving it. Please keep using the manual as you build your own Jupyter Book and come back to fill out this short [survey](https://forms.gle/hXbFUQgN95H8ftxt9). ## Contribute -This book will continue to develop, so feel free to contribute https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual! You can do so directly by forking this repository and creating a merge request. +This book will continue to develop, so feel free to contribute https://github.com/TeachBooks/manual! You can do so directly by forking this repository and creating a merge request. -The released book can be found on on https://teachbooks.tudelft.nl/jupyter-book-manual. This page shows the built book of the `release` branch. The `main` branch is meant for reviewing and is visible here: https://teachbooks.tudelft.nl/jupyter-book-manual/draft. All branches will also be visible on the mirrored repository on GitHub Pages: https://github.com/TeachBooks/mirror_teachbook_manual/actions +The released book can be found on on https://teachbooks.io/manual. This page shows the built book of the `release` branch. All branches will also be visible online, as pointed to in the actions summaries: https://github.com/TeachBooks/mirror_teachbook_manual/actions -Some parts of this book are taken from other sources in the form of submodules (linked in the folder [book/external](https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual/-/tree/main/book/external)). To contribute to those pages, contribute to the source repository directly with a fork and merge/pull request. If you intent to clone this boko including its submodules, clone using: `git clone --recurse-submodules git@gitlab.tudelft.nl:interactivetextbooks-citg/jupyter-book-manual.git` +Some parts of this book are taken from other sources in the form of submodules (linked in the folder [book/external](https://github.com/TeachBooks/manual/tree/release/book/external)). To contribute to those pages, contribute to the source repository directly with a fork and merge/pull request. If you intent to clone this boko including its submodules, clone using: `git clone --recurse-submodules git@github.com:TeachBooks/manual.git` Happy book building! \ No newline at end of file