admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

WIP

Browse source
This commit is contained in:
Robert Lanzafame 2024-12-17 09:00:37 +01:00
parent c5382da717
commit 2a87d7f1fd
3 changed files with 55 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

34
book/credits.md
View file

@ -1,33 +1,35 @@
(credits)=
# Credits and License
You can refer to this book as:
You can refer to this book in its entirety as:
> Teachbooks Team (2024), _TeachBooks Manual_. https://github.com/TeachBooks/manual
> van Woudenberg, T. and Lanzafame, R. (2024), _TeachBooks Manual_. https://github.com/TeachBooks/manual. Retreived [Month, Year]. CC BY 4.0.
The introduction, structure of the book and formatting of contents is done by the Editor. The content is written by the Authors.
The introduction, structure and decisions on content is done under direction of Tom van Woudenberg and Robert Lanzafame. The content is written by many contributors, of which there are many.
We anticipate that the content of this book will change continuously. Therefore, if you'd like to refer to a specific chapter, we recommend using the source code directly with the citation that refers to the GitHub repository and lists the date and name of the file. Although content will be added over time, chapter titles and URL's in this book are expected to remain relatively static. You can refer to individual chapters or pages within this book as:
We anticipate that the content of this book will change continuously. Therefore, if you'd like to refer to a specific chapter, we recommend using the source code directly with the citation that refers to the GitHub repository and lists the date and name of the file. Although content will be added over time, chapter titles and URL's in this book are expected to remain relatively static after Spring 2025. You can refer to individual chapters or pages within this book as:
> `<Primary Author>` (2024), `<Title of Chapter or Page>`. In TeachBook Team, _TeachBooks Manual_. https://github.com/TeachBooks/manual (`./book/intro/` chapter, accessed `<date>`).
> `<Primary Author>` (2024), `<Title of Chapter or Page>`. In _TeachBooks Manual_. https://github.com/TeachBooks/manual (chapter `./book/intro/`, retrieved [`<date>`]).
(editor)=
## Editor
- Tom van Woudenberg from Delft University of Technology
Better yet, include a link to the specific commit! _If you know what this means, we assume you know how to do it._
## Acknowledgements
This book has many contributors, many of whom are also key members of the TeachBooks Team:
## Authors: TeachBooks Team
- Tom van Woudenberg
- Robert Lanzafame
- Freek Pols
- Julie Kirsch
- Caspar Jungbacker
All from Delft University of Technology
All from Delft University of Technology.
Ths doesn't include small contributions from various people from within and outside Delft University of Technology.
This doesn't include small contributions from various people from within and outside Delft University of Technology.
## Acknowledgements
Big thanks to the various colleagues and teaching assistant part of the [TeachBooks](https://teachbooks.io/) for developing tools and providing support to improve this book.
A better way to see the contributions is to check the [Contributors Page](https://github.com/TeachBooks/manual/graphs/contributors) of the GitHub repository.
A big "thank you" is also due to the various colleagues and teaching assistants that have worked as part of the [TeachBooks](https://teachbooks.io/) Team for developing tools and providing support to improve this book, as well as the faculty of Civil Engineering and Geosciences and the Library at Delft University of Technology for significant financial support. The faculties of of Applied Sciences and Electrical Engineering, Mathematics and Computer Science have also provided support in the form of contributions from employees and student assistants..
## License
This manual is [CC BY 4.0 licensed](https://creativecommons.org/licenses/by/4.0/) allowing you to share and adapt the material, as long as the source is named. External resources that are reused in this manual are listed below.
@ -42,9 +44,9 @@ The following pages are included directly from an external resource and is not e
- _Work in progress: list the numerous README pages and include their respective licenses with the source code of this manual._
The following pages contain content written by others, part of has been reused and/or modified by the TeachBooks Team:
- Page {ref}`copyright` includes text from {cite:t}`tud_cip_24` that is used in the copyright checklist items.
- Page {ref}`copyright_licenses` includes an unmodified figure ({ref}`fig_license_types`), paraphrased and quoted text (including hyperlinks) from {cite:t}`hall21`.
- On page {ref}`copyright_licenses`, figure {ref}`fig_license_compatibility` is released by Kennisland under a CC0 license. Accessed at [](https://wiki.creativecommons.org/wiki/File:CC_License_Compatibility_Chart.png) on December 17, 2024.
- Page {ref}`copyright` includes text from {cite:t}`tud_cip_24` that is used in the copyright checklist items. Original content licensed under CC BY.
- Page {ref}`copyright_licenses`: {numref}`Figure %s<fig_license_types>` is included unmodified, along with paraphrased and quoted text (including hyperlinks) from {cite:t}`hall21`. Work is licensed under CC BY.
- Page {ref}`copyright_licenses`: {numref}`Figure %s<fig_license_compatibility>` is included unmodified. Work is provided by Kennisland under a CC0 license. Accessed at [](https://wiki.creativecommons.org/wiki/File:CC_License_Compatibility_Chart.png) on December 17, 2024.

2
book/installation-and-setup/copyright.md
View file

@ -3,7 +3,7 @@
```{admonition} User types
:class: tip
This page is useful for user type 2-5.
This page is useful for user **all** user types.
```
The previous sections have familiarized you with the necessary software for your user type, the basics of Git, and how to collaborate with your team using Git. Now it's time to create your own content. This section will provide an overview of the copy right laws which need to be taking into account when creating and including content at TU Delft!

45
book/installation-and-setup/copyright/licenses.md
View file

@ -5,11 +5,7 @@ An overview of license types.
> This page reuses CC BY content from {cite:t}`hall21`. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
## Programming-Focused Educational Materials
For example, the [MUDE Team](https://mude.citg.tudelft.nl) is working towards releasing the files associated with assignments under an open license. Since the majority of the content is written in a storytelling style in Jupyter notebooks, a CC BY license is probably the best choice if only one license is applied to a single file. However, if released in bulk it may be better to follow the advice of [Matt Hall](https://agilescientific.com/blog/2021/2/17/which-open-licence-should-i-choose):
> You have to be practical; maybe it depends on whether you consider your notebooks to be 'content' or 'source code'. I sometimes put at the bottom of a notebook something like **Open source content. Text is CC-BY, code is Apache 2.0** and I think this makes my intent clear.
## License Types in Context
% retrieved dec 17 2024 by robert; see bib file, credits page
% https://agilescientific.com/blog/2021/2/17/which-open-licence-should-i-choose
@ -19,8 +15,39 @@ For example, the [MUDE Team](https://mude.citg.tudelft.nl) is working towards re
Overview of license types, emphasizing "openness" and subdivided by material type: content, code and data. Source: {cite:t}`hall21`, CC BY. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
```
```{figure} ./figures/1280px-CC_License_Compatibility_Chart.png
:name: fig_license_compatibility
### Open versus Not Open
Compatibility between Creative Commons license types. Source: Kennisland, CC0. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
```
```{warning}
Work in progress.
```
Be open.
### Content, Code and Data
```{warning}
Work in progress.
```
Choose the right type of open.
## A Note to the Wary
Are you thinking something like this?
> I've put a lot of work into my material, and I don't want people to take credit for it or use it without my knowledge. However, I do see the value of choosing a license, especially an open one. Maybe I will choose something like CC BY-NC-SA, which allows others to use my work but not for commercial purposes, and not allowing them to modify it. That way, I can still get credit for my work and others can use it for educational purposes.
This is a nice sentiment, but when it comes to books, we don't advise it. There are several reasons, most of which stem from the fact that the "ND" license prohibits derivative works: in other words, the material cannot be modified and must be used in its entirety. This is problematic for a few reasons:
- What if you have a wonderful page describing Topic X, but there are a few contextual phrases that are undesired, for example: "this is required reading for Tuesday, December 17, 2024 in CIEM1000." That would be distracting for your own students, but you can't remove it.
- What is the point of including a website together with another website? It's easier to just link to your material directly.
- What if someone only wants a small part of your book? They can't use it.
- What if someone else makes similar material and releases it under CC BY and you include it in your own book? That does not seem fair to not also provide them an opportunity to benefit from your work.
- Often someone creates a copy of your work and makes improvements. The Git system (e.g., forks, commits, pull requests, etc) make it very straightforward to also include these improvements back into your original work. This would not be possible if you did not allow for reuse in the first place!
Hopefully we have
## Example: Programming-Focused Educational Materials
For example, the [MUDE Team](https://mude.citg.tudelft.nl) is working towards releasing the files associated with assignments under an open license. Since the majority of the content is written in a storytelling style in Jupyter notebooks, a CC BY license is probably the best choice if only one license is applied to a single file. However, if released in bulk it may be better to follow the advice of [Matt Hall](https://agilescientific.com/blog/2021/2/17/which-open-licence-should-i-choose):
> You have to be practical; maybe it depends on whether you consider your notebooks to be 'content' or 'source code'. I sometimes put at the bottom of a notebook something like **Open source content. Text is CC-BY, code is Apache 2.0** and I think this makes my intent clear.