mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-13 06:45:52 +00:00
Merge branch 'main' into release
This commit is contained in:
commit
b0c30d4736
25 changed files with 104 additions and 108 deletions
3
.gitmodules
vendored
3
.gitmodules
vendored
|
|
@ -16,3 +16,6 @@
|
|||
[submodule "book/external/TeachBooks"]
|
||||
path = book/external/TeachBooks
|
||||
url = https://github.com/TeachBooks/TeachBooks.git
|
||||
[submodule "book/external/Sphinx-Image-Inverter"]
|
||||
path = book/external/Sphinx-Image-Inverter
|
||||
url = https://github.com/TeachBooks/Sphinx-Image-Inverter.git
|
||||
|
|
|
|||
|
|
@ -47,6 +47,7 @@ parts:
|
|||
- file: features/custom_toc.md
|
||||
- file: features/custom_download.md
|
||||
- file: external/Nested-Books/README.md
|
||||
- file: external/Sphinx-Image-Inverter/README.md
|
||||
- file: features/interactive_element.ipynb
|
||||
sections:
|
||||
- file: features/grasple.md
|
||||
|
|
|
|||
|
|
@ -21,5 +21,3 @@ Or, the derivation results in equation {eq}`<eq:Newton>`.
|
|||
|
||||
$$ F = m\cdot a $$(eq:Newton)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ name: banner_mude
|
|||
Example of a banner in the MUDE book.
|
||||
```
|
||||
|
||||
This is a commonly used feature, desribed in the [Jupyter Book manual here](https://jupyterbook.org/en/stable/web/announcements.html). However, note that if you are using the Sphinx-Thebe interactive Python feature, or other features that customize the top part of a Jupyter Book website (for example, the download page buttons), the banner does not always work. In this case, the banner should be specified using the `announcement` option in the `html_theme_options` setting in the `_config.yml` file:
|
||||
This is a commonly used feature, described in the [Jupyter Book manual here](https://jupyterbook.org/en/stable/web/announcements.html). However, note that if you are using the Sphinx-Thebe interactive Python feature, or other features that customize the top part of a Jupyter Book website (for example, the download page buttons), the banner does not always work. In this case, the banner should be specified using the `announcement` option in the `html_theme_options` setting in the `_config.yml` file:
|
||||
|
||||
```
|
||||
sphinx:
|
||||
|
|
@ -23,9 +23,9 @@ sphinx:
|
|||
```
|
||||
|
||||
```{tip}
|
||||
Note that you should always enclose your announcement in quotes to make it a complete string. Use a different type of quote if your announcement itself contains them (for example, `"like 'this'"`). If you are using HTML elements, it is best to make your announcement a complete HTML tag, not Markdown with HTML inside.
|
||||
You should always enclose your announcement in quotes to make it a complete string. Use a different type of quote if your announcement itself contains them (for example, `"like 'this'"`). If you are using HTML elements, it is best to make your announcement a complete HTML tag, not Markdown with HTML inside.
|
||||
|
||||
Markdown links do not work in the announcement, in which case you must use HTML!
|
||||
Markdown links do not work in the announcement, requiring you to use HTML!
|
||||
```
|
||||
|
||||
## Known Issue
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
# Code
|
||||
|
||||
There are two ways main ways to include code: directly within a Markdown file or as a Jupyter notebook. More methods are available, but we don't include them here. The first option is great for including simple calculations, or generating simple figures when an image file is not practical. *More will be added later.*
|
||||
There are two main ways to include code: directly within a Markdown file or within a Jupyter notebook. More methods are available, but we don't include them here. The first option is great for including simple calculations, or generating simple figures when an image file is not practical. *More will be added later.*
|
||||
|
||||
Note that if you are using a `*.ipynb` file or including a code snippet in a `*.md` file, including a blank line between the text and the closing three tick marks will generate an empty code box of one line in the Jupyter Book.
|
||||
|
||||
When making notebooks for the Book, you might want to hide certain cells from the reader. For example, when including a simple figure generated from code or making a JupyterQuiz, we have to execute a code cell that generates the quiz. This code cell is ugly and distracting, so we do not want to render this in the final book.
|
||||
|
||||
We can change how the compiler treats notebook cells by using cell tags. You can find a detailled explanation on cell tags [here](https://jupyterbook.org/en/stable/interactive/hiding.html?highlight=cell%20tag). Specifically, have a look at the sections on *hiding* cell inputs and *removing* cell inputs.
|
||||
We can change how the compiler treats notebook cells by using cell tags. You can find a detailed explanation on cell tags [here](https://jupyterbook.org/en/stable/interactive/hiding.html?highlight=cell%20tag). Specifically, have a look at the sections on *hiding* cell inputs and *removing* cell inputs.
|
||||
|
||||
The workflow of editing cell tags depends on your editor. If you're using Jupyter Lab, you can find instructions [here](https://jupyterbook.org/en/stable/content/metadata.html#jupyter-cell-tags).
|
||||
|
||||
|
|
@ -18,4 +18,5 @@ For example, the following tag is used to convert the code input into either a d
|
|||
]
|
||||
}
|
||||
```
|
||||
|
||||
Once a correctly typed tag is added to the notebook it will appear in the buttons at the top and can be added to other cells. Multiple tags can be added to the same cell, in which case the tags are separated by commas.
|
||||
|
|
|
|||
|
|
@ -18,6 +18,7 @@ $$
|
|||
The scientific rules dictate that quantities ($F$, $m$, $a$ etc.) should be printed in italics. Units, however, should not! One can use `\text{m}` in an equation to comply to this rule:
|
||||
|
||||
$$ F = m \cdot a = 10 \cdot 9.81 = 98 \text{N}$$
|
||||
|
||||
```
|
||||
|
||||
> **Warning**
|
||||
|
|
@ -36,6 +37,8 @@ $$
|
|||
F = m \cdot a
|
||||
$$ (newtons_second_law)
|
||||
|
||||
Equation {eq}`newtons_second_law` can now be referred to.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> The Jupyter Book uses MathJax to display equations, which provides some LaTeX-like functionality, but not all! For example, the Euro symbol is missing, and packages like `siunitx` are not available (hint, use `\textrm{}` and `\textrm{}`). When something is not working, it's useful to search for MathJax-specific solutions (hint, include "mathjax" in your Google search).
|
||||
|
|
|
|||
|
|
@ -23,20 +23,20 @@ sphinx:
|
|||
- sphinx_inline_tabs
|
||||
```
|
||||
|
||||
Technically speaking, a `_config.yml` file is not required to build a Jupyter Book. If you don't make one, `jupyter book` will just use all default values. However, you should make a configuration file with at least the following settings:
|
||||
Technically speaking, a `_config.yml` file is not required to build a Jupyter Book. If you don't make one, `jupyter book` will just use all default values. However, you should make a configuration file which includes at least the following settings:
|
||||
|
||||
- `title`: the title of your book, which appears on the top-left of every page, under the logo.
|
||||
- `author`: authors of the book, which appears in the bottom margin of every page.
|
||||
- `logo`: (relative) path to the logo of your book (optional).
|
||||
- `copyright`: the [licences](https://creativecommons.org/share-your-work/cclicenses/) attached to your book.
|
||||
- `copyright`: the [licenses](https://creativecommons.org/share-your-work/cclicenses/) attached to your book.
|
||||
|
||||
In addition, the following option can also be useful:
|
||||
|
||||
- `execute_notebooks`: turn on/off the execution of Jupyter Notebooks during the build process. On by default. If you perform heavy computations in your notebook (machine learning, FEM models, et cetera), you might be better off running the notebooks on a more powerful machine as opposed to the CI/CD server. To turn it off, specify the value `'off'`. You can also exclude specific notebooks by creating exclude patterns in the filenames. For more info, see the [Jupyter Book documentation](https://jupyterbook.org/en/stable/content/execute.html#exclude-files-from-execution).
|
||||
- `execute_notebooks`: *turn on/off* the execution of Jupyter Notebooks during the build process. *On* by default. If you perform heavy computations in your notebook (machine learning, FEM models, et cetera), you might be better off running the notebooks on a more powerful machine as opposed to the CI/CD server. To turn it off, specify the value `'off'`. You can also exclude specific notebooks by creating exclude patterns in the filenames. For more info, see the [Jupyter Book documentation](https://jupyterbook.org/en/stable/content/execute.html#exclude-files-from-execution).
|
||||
|
||||
|
||||
```{warning}
|
||||
The coniguration and table of contents files are in YAML format (short for YAML Ain't Markup Language). YAML has a specific syntax, which can cause some errors if you don't adhere to it. Just like Python, indentation is very important. You can find an overview of the syntax [here](https://en.wikipedia.org/wiki/YAML#Syntax).
|
||||
The configuration and table of contents files are in YAML format (short for YAML Ain't Markup Language). YAML has a specific syntax, which can cause some errors if you don't adhere to it. Just like Python, indentation is very important. You can find an overview of the syntax [here](https://en.wikipedia.org/wiki/YAML#Syntax).
|
||||
```
|
||||
|
||||
## The table of contents
|
||||
|
|
@ -85,7 +85,10 @@ parts:
|
|||
et cetera...
|
||||
```
|
||||
|
||||
## The structure of a chapter
|
||||
## Content
|
||||
The main thing people are interested in, is the content of the book. To help the reader, you can structure the book into chapters, each which sections and subsections as explained below.
|
||||
|
||||
### The structure of a chapter
|
||||
The 'nested' structure in the TOC is one way to organize your book. Another way to do so is in the file itself. The structure is defined by the number of `#`:
|
||||
|
||||
```
|
||||
|
|
@ -113,7 +116,7 @@ parts:
|
|||
- file: section_1_2
|
||||
```
|
||||
|
||||
## Including a chapter twice
|
||||
### Including a chapter twice
|
||||
In some cases you want to include the same chapter in two different places in your book (for instance parts). However, you do not want to make the same adjustments in different files, the content should only 'live' in one place. The solution is to use `include`:
|
||||
|
||||
````
|
||||
|
|
@ -121,7 +124,9 @@ In some cases you want to include the same chapter in two different places in yo
|
|||
```
|
||||
````
|
||||
|
||||
The *argument* in this case is the location of the file you want to include (for instance: `/basic-features/equations.md`). We provide an example of the use of `include` below: We included the chapter [equations](./equations.md) in this page.
|
||||
The *argument* in this case is the location of the file you want to include (for instance: `/basic-features/equations.md`). Note that when building the book locally, you get some warnings for duplicate labels..
|
||||
|
||||
We provide an example of the use of `include` below: We included the chapter [equations](./equations.md) in this page.
|
||||
|
||||
|
||||
```{include} /basic-features/equations.md
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
```{admonition} User types
|
||||
:class: tip
|
||||
This section is useful for user type 3-5.
|
||||
This section is useful for [user type 3-5](../installation-and-setup/user_types.md).
|
||||
```
|
||||
|
||||
A short description on basic features is given here. These pages will provide a list of some commonly used book features which are all available in the original <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="../images/logo-wide.svg" alt="Jupyter book"></a> package. However, this page includes best-practices on how to use them.
|
||||
These pages will provide a list of some common, basic book features which are all available in the original <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="../images/logo-wide.svg" alt="Jupyter book"></a> package. However, this page includes also best-practices.
|
||||
|
|
|
|||
2
book/external/Nested-Books
vendored
2
book/external/Nested-Books
vendored
|
|
@ -1 +1 @@
|
|||
Subproject commit 4f72481f6a9b65c9b3bd22d0351b58b562f4802c
|
||||
Subproject commit cc1d35d73558dc5787ede7c4552fb35e9ba82a46
|
||||
1
book/external/Sphinx-Image-Inverter
vendored
Submodule
1
book/external/Sphinx-Image-Inverter
vendored
Submodule
|
|
@ -0,0 +1 @@
|
|||
Subproject commit 61f101bd1fcf9bd8d2990e72b86e38499e0f3f04
|
||||
2
book/external/TeachBooks
vendored
2
book/external/TeachBooks
vendored
|
|
@ -1 +1 @@
|
|||
Subproject commit c802630d700f579eff2ac990496503bdda57ca3b
|
||||
Subproject commit f6968d6284d5f75950e502c50c6778d08d0fdf1f
|
||||
2
book/external/Useful_python_code
vendored
2
book/external/Useful_python_code
vendored
|
|
@ -1 +1 @@
|
|||
Subproject commit c8327b3e2cc68d44958974a47c940bc89f4bb32b
|
||||
Subproject commit 8c7d765f3a06b18517b315455ae7f5dc9230748c
|
||||
2
book/external/latex-to-markdown-conversion
vendored
2
book/external/latex-to-markdown-conversion
vendored
|
|
@ -1 +1 @@
|
|||
Subproject commit 0b9b6512da9ff9011e56897eb6837cc3ed89ee45
|
||||
Subproject commit f71092bfdb2e3d5d2f580bac5e31ff695806e7d3
|
||||
2
book/external/template
vendored
2
book/external/template
vendored
|
|
@ -1 +1 @@
|
|||
Subproject commit 2d5513da0a53b606f870890237ef4417dc18b398
|
||||
Subproject commit 080483e6865edff26fd125382bac99b13e4d8539
|
||||
|
|
@ -36,7 +36,7 @@
|
|||
"metadata": {},
|
||||
"source": [
|
||||
"## Setting up Python live coding\n",
|
||||
"To set up the Python live coding you need to add our own sphinx-thebe extension to your book. This extensions doesn't rely on a 3rd party like Binder and it supports local python execution and custom features. Therefore, you need to add some lines to `requirements.txt` and `_config.yml`\n",
|
||||
"To set up the Python live coding you need to add our [own sphinx-thebe extension](https://github.com/TeachBooks/Sphinx-Thebe) to your book. This extensions doesn't rely on a 3rd party like Binder and it supports local python execution and custom features. Therefore, you need to add some lines to `requirements.txt` and `_config.yml`\n",
|
||||
"\n",
|
||||
"For `requirements.txt` add the following lines:\n",
|
||||
"```\n",
|
||||
|
|
|
|||
|
|
@ -1,34 +1,33 @@
|
|||
# Content and copyright
|
||||
# Content & Copyright
|
||||
|
||||
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!
|
||||
|
||||
# Checklist
|
||||
## Checklist
|
||||
|
||||
Although the focus of TeachBooks is mostly to help the teaching staff create interactive textbooks for their students, it can be attractive to spread ones wings a bit and reach a wider audience. The following section will be all about what you have to keep in mind in terms of copy right and what you should know to avoid major legal issues and make your life easier later on when/if you decide to publish your book with an open license, especially via TU Delft Open. For more information you can find everything on the [TU Delft website](https://www.tudelft.nl/library/support/copyright)
|
||||
Although the focus of TeachBooks is mostly to help the teaching staff create interactive textbooks for their students, it can be attractive to spread ones wings a bit and reach a wider audience. The following section will be all about what you have to keep in mind in terms of copy right and what you should know to avoid major legal issues and make your life easier later on when/if you decide to publish your book with an open license, especially via TU Delft Open. For more information you can find everything on the [TU Delft Copyright website](https://www.tudelft.nl/library/support/copyright)
|
||||
|
||||
|
||||
1) Your own new content
|
||||
**1) Your own new content**
|
||||
|
||||
If you have created the content yourself, you are allowed to use it if there are no other agreements in place
|
||||
|
||||
2) Somebody else's content
|
||||
**2) Somebody else's content**
|
||||
|
||||
If you want to re-use someone else’s work, you need to ask for permission. When you ask for permission please do it in a written format and let the copyright holders know that you are going to use their work in an open licensed work. If they give you permission, exclude the work from the open licensed conditions applicability, by stating that in the attribution/footnote/caption. Exclude it as well in the colophon of the work. If you have asked for permission and you received no answer back, please consider it as a negative response and abstain using the work you were intended to.
|
||||
|
||||
If you really need to re-use someone else’s work, please alsio check whether the copyright exception right to quote is applicable to you.
|
||||
If you really need to re-use someone else’s work, please also check whether the copyright exception right to quote is applicable to you.
|
||||
|
||||
More info: [Citations](https://www.tudelft.nl/library/support/copyright/researcher-copyright-answers#c1131017) , [Use copyrighted multimedia](https://www.tudelft.nl/library/support/copyright/researcher-copyright-answers#c1131031) , [Use copyrighted text](https://www.tudelft.nl/library/support/copyright/researcher-copyright-answers#c1131032)
|
||||
|
||||
|
||||
3) Your own old content
|
||||
**3) Your own old content**
|
||||
|
||||
Always attribute the works that are not created by you. Even if created by you, you need to attribute yourself in order to avoid self-plagiarism. Read how to [here](https://www.tudelft.nl/library/support/copyright/researcher-copyright-answers#c1131032)
|
||||
|
||||
Even if you have created the work yourself but years ago, please check whether you have the right to re-use it. If you have created it while you were under the employment of your previous employer, then you will need to ask permission from them.
|
||||
|
||||
4) Open licensed work
|
||||
**4) Open licensed work**
|
||||
|
||||
If you want to re-use someone else’s work, please check whether you can find an open licensed work, which can replace the work you wanted to re-use in the first place. More info: [Open licensed work platforms](https://www.tudelft.nl/library/collecties/open-educational-resources)
|
||||
If you want to re-use someone else’s work, please check whether you can find an open licensed work, which can replace the work you wanted to re-use in the first place. More info: [Open licensed work platforms](https://www.tudelft.nl/en/library/collections/open-educational-resources)
|
||||
|
||||
If you use open licensed work, you need to attribute the license under which the work is licensed and you need to check the compatibility of the licenses. This means you need to check the license that the work you want to reuse has and the license that your TeachBook will be licensed with. More info [here](https://wiki.creativecommons.org/wiki/Wiki/cc_license_compatibility)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,65 +0,0 @@
|
|||
|
||||
```{Notes Robert}
|
||||
|
||||
- the creating content page can be more like an overview/jumping off point (for example, it can point out that a book is 3 things: toc+config+content), then link to existing JB manual, example books, etc, but have a really big colorful box that warns about copyright
|
||||
- on this main page it would be important to have a checklist for "what to do when starting a book" that includes choosing a license and how to avoid copyright issues, with links to supbages
|
||||
- creating content subpages:
|
||||
open source licenses: a short overview of types, pointing out that some are oriented on creative work, others on software. mostly pointing out we don't know the right answer but listing examples of what others have done so far
|
||||
copyright page (this is where paschalis' bullet points should go)
|
||||
|
||||
```
|
||||
|
||||
# Creating Content
|
||||
|
||||
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. TeachBooks provides a [template](https://teachbooks.tudelft.nl/jupyter-book-manual/external/template/README.html) you can use to create your book on GitHub, ensuring that your repository contains all the files you may need. Now it's time to create your own content. This section will provide an overview of these components and help you get started on your content.
|
||||
|
||||
# Building Blocks
|
||||
|
||||
Creating content for your Jupyter Book involves assembling several key components: the table of contents (`_toc.yml`), the configuration settings (`_config.yml`) and the actual content.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
## Configuration
|
||||
|
||||
## Content
|
||||
|
||||
```{Important}
|
||||
Please ensure you respect copy right laws when creating and including content! Don't forget to go through our checklist.
|
||||
```
|
||||
|
||||
Markdown Files: Write your content in Markdown (.md) files. Markdown is a lightweight markup language with plain text formatting syntax.
|
||||
Chapters and Sections: Organize your content into chapters and sections, with each chapter being a separate Markdown file.
|
||||
|
||||
|
||||
# Checklist - Copy Right
|
||||
|
||||
Although the focus of TeachBooks is mostly to help the teaching staff create interactive textbooks for their students, it can be attractive to spread ones wings a bit and reach a wider audience. The following section will be all about what you have to keep in mind in terms of copy right and what you should know to avoid major legal issues and make your life easier later on when/if you decide to publish your book with an open license, especially via TU Delft Open. For more information you can find everything on the [TU Delft website](https://www.tudelft.nl/library/support/copyright)
|
||||
|
||||
|
||||
1) Your own new content
|
||||
|
||||
If you have created the content yourself, you are allowed to use it if there are no other agreements in place
|
||||
|
||||
2) Somebody else's content
|
||||
|
||||
If you want to re-use someone else’s work, you need to ask for permission. When you ask for permission please do it in a written format and let the copyright holders know that you are going to use their work in an open licensed work. If they give you permission, exclude the work from the open licensed conditions applicability, by stating that in the attribution/footnote/caption. Exclude it as well in the colophon of the work. If you have asked for permission and you received no answer back, please consider it as a negative response and abstain using the work you were intended to.
|
||||
|
||||
If you really need to re-use someone else’s work, please alsio check whether the copyright exception right to quote is applicable to you.
|
||||
|
||||
More info: [Citations](https://www.tudelft.nl/library/support/copyright/researcher-copyright-answers#c1131017) , [Use copyrighted multimedia](https://www.tudelft.nl/library/support/copyright/researcher-copyright-answers#c1131031) , [Use copyrighted text](https://www.tudelft.nl/library/support/copyright/researcher-copyright-answers#c1131032)
|
||||
|
||||
|
||||
3) Your own old content
|
||||
|
||||
Always attribute the works that are not created by you. Even if created by you, you need to attribute yourself in order to avoid self-plagiarism. Read how to [here](https://www.tudelft.nl/library/support/copyright/researcher-copyright-answers#c1131032)
|
||||
|
||||
Even if you have created the work yourself but years ago, please check whether you have the right to re-use it. If you have created it while you were under the employment of your previous employer, then you will need to ask permission from them.
|
||||
|
||||
4) Open licensed work
|
||||
|
||||
If you want to re-use someone else’s work, please check whether you can find an open licensed work, which can replace the work you wanted to re-use in the first place. More info: [Open licensed work platforms](https://www.tudelft.nl/library/collecties/open-educational-resources)
|
||||
|
||||
If you use open licensed work, you need to attribute the license under which the work is licensed and you need to check the compatibility of the licenses. This means you need to check the license that the work you want to reuse has and the license that your TeachBook will be licensed with. More info [here](https://wiki.creativecommons.org/wiki/Wiki/cc_license_compatibility)
|
||||
|
||||
When you want to adapt previously published work you need to ask permission for it. Otherwise please check whether you can find an open licensed work that you can adapt if their license it permits it.
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 217 KiB |
|
|
@ -16,7 +16,7 @@ Don't forget to add the package `teachbooks` in the `requirements.txt` files in
|
|||
|
||||
## Build a book
|
||||
|
||||
As soon as you've installed your book environment with jupyter-book you can build your book locally. The official <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="../images/logo-wide.svg" alt="Jupyter book"></a> documentation is quite extensive. Only two notes: first navigate to the directory where your book is to leave out the `path-to-book` and use `--all` whenever building a book to make sure the table of contents fully updates:
|
||||
As soon as you've installed your book environment with jupyter-book you can build your book locally. The official <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="../images/logo-wide.svg" alt="Jupyter book"></a> documentation is quite extensive. You can navigate to the directory where your book is to leave out the `path-to-book`.
|
||||
|
||||
```
|
||||
teachbooks build <path-to-book> --all
|
||||
|
|
@ -26,6 +26,8 @@ Alternatively:
|
|||
jupyter-book build <path-to-book> --all
|
||||
```
|
||||
|
||||
Note: use `--all` for the jupyter-book whenever building a book to make sure the table of contents fully updates. Or alternatively, delete the old `_build` folder before building the new book.
|
||||
|
||||
## View the book locally
|
||||
|
||||
Once the build process is completed successfully, you will see the file location in your terminal output. Your terminal will look something like this. Simply open this in the browser (you may have to copy/paste).
|
||||
|
|
|
|||
|
|
@ -2,7 +2,8 @@
|
|||
|
||||
Different types of users will interact with the website or the Jupyter Books differently and will therefore need to know more or less about the composition of the book. For now we will differentiate 5 types of users.
|
||||
|
||||
1. **Students providing feedback on the published website**.<br> <img src="figures/type 1.jpg" alt="Example Image" align="right" width="130" style="margin: 10px;"> There are multiple tools of providing feedback in the built book: a) using the issue button in the top-right corner to directly create issues visible to the editor team. b) Using the [hypothesis](https://jupyterbook.org/en/stable/interactive/comments/hypothesis.html)-extension which allows public/private highlighting and annotating parts of the book. An example can be seen on the [MUDE website](https://mude.citg.tudelft.nl/book/intro.html). c) Using the [Utterances](https://jupyterbook.org/en/stable/interactive/comments/utterances.html)-extension which allows commenting on pages for books which are hosted on GitHub visible for everyone. Those comments are converted to issues on GitHub for the editors to handle.
|
||||
1. **Students providing feedback on the published website**.<br>
|
||||
<img src="figures/type 1.jpg" alt="Example Image" align="right" width="130" style="margin: 20px;"><br>There are multiple tools of providing feedback in the built book:<br>a) using the issue button in the top-right corner to directly create issues visible to the editor team.<br>b) Using the [hypothesis](https://jupyterbook.org/en/stable/interactive/comments/hypothesis.html)-extension which allows public/private highlighting and annotating parts of the book. An example can be seen on the [MUDE website](https://mude.citg.tudelft.nl/book/intro.html).<br>c) Using the [Utterances](https://jupyterbook.org/en/stable/interactive/comments/utterances.html)-extension which allows commenting on pages for books which are hosted on GitHub visible for everyone. Those comments are converted to issues on GitHub for the editors to handle.
|
||||
|
||||
2. **Colleague providing feedback on the draft website**. <br>
|
||||
In a similar manner as students, colleages and team members can leave content related comments on the website through extensions. In this way, multiple teachers can give input in the draft of the textbook and course material without requiring and exact understanding of Jupyter Books or GitLab/GitHub. The responsible teacher (or student assistants) can then make the adaptations to the book as recommended by their colleagues.
|
||||
|
|
@ -14,9 +15,10 @@ Different types of users will interact with the website or the Jupyter Books dif
|
|||
User 4 is a hybrid between type 3 and 5. Basically this user is making changes by editing the .md files locally using, for example, VS Code. Therefore, this user requires a little bit more knowledge on git (think of pulling and pushing changes) but their main focus remains to make adjustments to the content of the book by editing .md files whereas user type 5 has more knowledge to make changes to python files the book as well. This user can build the book online.
|
||||
|
||||
5. **Colleague making text and code (especially Python) adjustments to multiple files at the same time locally**. <br>
|
||||
<img src="figures/type 5.jpg" alt="Example Image" align="right" width="120" style="margin: 10px;">
|
||||
<img src="figures/type 5.jpg" alt="Example Image" align="right" width="120" style="margin: 20px;"><br>This user has more knowledge in GitLab/GitHub than the previous user and can basically take care of branching and merging by themselves. They know how to work with software for editing .md and .ipynb files. They can use the draft book online to view their changed in the book, or build the book locally.
|
||||
|
||||
This user has more knowledge in GitLab/GitHub than the previous user and can basically take care of branching and merging by themselves. They know how to work with software for editing .md and .ipynb files. They can use the draft book online to view their changed in the book, or build the book locally.
|
||||
|
||||
<br style="clear:both;">
|
||||
```{Note}
|
||||
|
||||
At this point, you might already be trying to see which user type fits you the best. We are aware that the lines between user types can be a bit blurry, especially between type 3, 4 and 5. If case you're (1) a user type 3 and want to dabble in git or (2) a user type 4/5 and want to make some quick edits with only a few clicks, then you might consider using a more advanced online editor in GitHub (GitHub Dev) as explained [further on in Collaborative book-editing - Edit - User type 3 - GitHub](../workflows/edit_book.md).
|
||||
```
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
# TeachBooks Manual
|
||||
|
||||
This is an introduction to Git, VS Code and Jupyter Books for teachers and teaching assistants involved in TeachBooks, our platform easing the process of making a <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="images/logo-wide.svg" alt="Jupyter book"></a>. This book is still work in progress, so feel free to contribute https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual! For more information about teachbooks, visit [https://teachbooks.tudelft.nl/](https://teachbooks.tudelft.nl/).
|
||||
This is an introduction to Git, VS Code and Jupyter Books for teachers and teaching assistants involved in TeachBooks, our platform easing the process of making a <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="images/logo-wide.svg" alt="Jupyter book"></a>. This book will continue to develop, so feel free to contribute https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual! For more information about teachbooks, visit [https://teachbooks.tudelft.nl/](https://teachbooks.tudelft.nl/).
|
||||
|
||||
## Contact
|
||||
If you encounter any issues and you have a TU Delft account, report it by clicking <svg class="svg-inline--fa fa-gitlab" aria-hidden="true" focusable="false" data-prefix="fab" data-icon="gitlab" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" data-fa-i2svg=""><path fill="currentColor" d="M503.5 204.6L502.8 202.8L433.1 21.02C431.7 17.45 429.2 14.43 425.9 12.38C423.5 10.83 420.8 9.865 417.9 9.57C415 9.275 412.2 9.653 409.5 10.68C406.8 11.7 404.4 13.34 402.4 15.46C400.5 17.58 399.1 20.13 398.3 22.9L351.3 166.9H160.8L113.7 22.9C112.9 20.13 111.5 17.59 109.6 15.47C107.6 13.35 105.2 11.72 102.5 10.7C99.86 9.675 96.98 9.295 94.12 9.587C91.26 9.878 88.51 10.83 86.08 12.38C82.84 14.43 80.33 17.45 78.92 21.02L9.267 202.8L8.543 204.6C-1.484 230.8-2.72 259.6 5.023 286.6C12.77 313.5 29.07 337.3 51.47 354.2L51.74 354.4L52.33 354.8L158.3 434.3L210.9 474L242.9 498.2C246.6 500.1 251.2 502.5 255.9 502.5C260.6 502.5 265.2 500.1 268.9 498.2L300.9 474L353.5 434.3L460.2 354.4L460.5 354.1C482.9 337.2 499.2 313.5 506.1 286.6C514.7 259.6 513.5 230.8 503.5 204.6z"></path></svg> --> {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).
|
||||
|
|
@ -8,6 +8,6 @@ If you encounter any issues and you have a TU Delft account, report it by clicki
|
|||
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)
|
||||
|
||||
## Feedback
|
||||
We really value your feedback on this manual so we can keep 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).
|
||||
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).
|
||||
|
||||
Happy book building!
|
||||
|
|
@ -8,8 +8,8 @@ Suppose we are writing a new chapter, or are updating an existing chapter for ou
|
|||
|
||||
**... by directly adding changes on a single file to the Git-timeline (committing) in ...**
|
||||
|
||||
`````{tab-set}
|
||||
````{tab-item} ... GitLab
|
||||
```````{tab-set}
|
||||
``````{tab-item} ... GitLab
|
||||
|
||||
In GitLab, you can directly make changes in the files on the remote repository. You can make changes to the files already in the repository using the text editor but you can also upload new files!
|
||||
|
||||
|
|
@ -46,8 +46,8 @@ In GitLab, you can directly make changes in the files on the remote repository.
|
|||
</figure>
|
||||
|
||||
You can edit it and commit the changes in the same manner as with markdown (.md) files.
|
||||
````
|
||||
````{tab-item} ... GitHub
|
||||
``````
|
||||
``````{tab-item} ... GitHub
|
||||
|
||||
How to make an edit and make a commit is demonstrated in the figure below, all steps are elaborated on in the following step-by-step tutorial.
|
||||
|
||||
|
|
@ -74,6 +74,9 @@ In GitHub, you can directly make changes in the files on the remote repository.
|
|||
<img src="figures/HubUser3_NewFile2.PNG" alt="Example Image" width="700">
|
||||
</figure>
|
||||
|
||||
`````{tab-set}
|
||||
````{tab-item} ... using 'Edit in place'
|
||||
|
||||
4. In case you want to make changes to an existing file, navigate to the file in your remote repository. Then click the downward pointing arrow on the very left in the top bar. Select the option `Edit in place`.
|
||||
|
||||
<figure align="center">
|
||||
|
|
@ -93,8 +96,51 @@ In GitHub, you can directly make changes in the files on the remote repository.
|
|||
</figure>
|
||||
|
||||
You can edit it and commit the changes in the same manner as with markdown (.md) files.
|
||||
|
||||
````
|
||||
````{tab-item} ... using 'VS Code in your browser'
|
||||
|
||||
Using this feature, you can open VS Code in your browser and edit the files in your repository. By doing this, you completely by-pass the need to open (and install) VS Code and GitHub Desktop on your laptop making it the optimal way to quickly fix something.
|
||||
|
||||
1. Navigate to your main page (`code`) of your repository in GitHub
|
||||
2. Press the dot key on your keyboard `.` This will open VS Code
|
||||
3. Navigate to a file and make some changes
|
||||
|
||||
```{figure} ./figures/Online_VS1.PNG
|
||||
:name: VS Code in Browser
|
||||
:width: 70%
|
||||
:align: center
|
||||
|
||||
VS Code in Browser
|
||||
```
|
||||
In the bottom left you can see the branch you are working in.
|
||||
|
||||
4. This feature requires you to use git in VS Code. You can do that in the Source Control tab in the activity bar on the left side of the window (it looks like a branching icon). Write your commit message and click on commit & push.
|
||||
5. Now let's see the result. Go back to your GitHub repo. In the top bar, go to actions.
|
||||
|
||||
```{figure} ./figures/Online_VS2.PNG
|
||||
:name: GitHub Actions
|
||||
:width: 70%
|
||||
:align: center
|
||||
|
||||
GitHub Actions
|
||||
```
|
||||
You will see the latest commit you just did (in this case text). After the pipeline has run, the yellow icon will turn green. Click on the commit and scroll until you see the title Deployed Branches.
|
||||
|
||||
```{figure} ./figures/Online_VS3.PNG
|
||||
:name: Deployed Branches
|
||||
:width: 60%
|
||||
:align: center
|
||||
|
||||
Deployed Branches
|
||||
```
|
||||
Click on the link and admire your changes:)
|
||||
|
||||
````
|
||||
`````
|
||||
|
||||
``````
|
||||
```````
|
||||
````````
|
||||
````````{tab-item} ... user type 4 ...
|
||||
|
||||
|
|
|
|||
BIN
book/workflows/figures/Online_VS1.PNG
Normal file
BIN
book/workflows/figures/Online_VS1.PNG
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 56 KiB |
BIN
book/workflows/figures/Online_VS2.PNG
Normal file
BIN
book/workflows/figures/Online_VS2.PNG
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
book/workflows/figures/Online_VS3.PNG
Normal file
BIN
book/workflows/figures/Online_VS3.PNG
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.1 KiB |
Loading…
Add table
Add a link
Reference in a new issue