Merge branch 'main' into release

This commit is contained in:
Tom van Woudenberg 2024-11-04 10:20:09 +01:00
commit 82e16e9a7d
4 changed files with 17 additions and 16 deletions

View file

@ -21,10 +21,8 @@ parts:
- file: workflows/edit_book
- file: workflows/check_changes_online
- file: workflows/merge_request
- file: installation-and-setup/organize-team
sections:
- file: installation-and-setup/collab
- file: installation-and-setup/tools
- file: installation-and-setup/collab
- file: installation-and-setup/tools
- file: installation-and-setup/creating_content.md
- caption: Features
chapters:

View file

@ -1,4 +1,9 @@
# Team and collaboration
# Organize editing team, collaboration and visibility
```{admonition} User types
:class: tip
This page is useful for user type 4-5.
```
## Roles and responsibilities
To ensure smooth collaboration, it is essential to define the roles and responsibilities within your team. Firstly, designate who will be in charge of team organization ('administrators') who should be at least user type 4. Additionally, assign 'maintainers' responsible for combining content, also requiring at least user type 4. 'Editors' should be identified for editing and reviewing content, requiring at least user type 3.

View file

@ -1,8 +0,0 @@
# Organize your editing team, tools and URL
```{admonition} User types
:class: tip
This page is useful for user type 4-5.
```
If you want to create a collaborative book for students, there's a few agreements you should make to enhance collaboration and student experience. These are written from our own experience, feel free to deviate or provide your own advice! A distinction has been made between organization of teams and tools.

View file

@ -1,5 +1,11 @@
# URLs and tools
The setup of tools is dependent on agreements you've made on collaboration.
# Choose URLs and tools
```{admonition} User types
:class: tip
This page is useful for user type 4-5.
```
The setup of tools and URLs is dependent on agreements you've made on [collaboration](./collab.md).
## Collaboration in readme
Provide explanation on how you organize the book-editing and how you'd like to receive feedback in both the readme as the published book. The use of the [issue button](https://jupyterbook.org/en/stable/basics/repository.html#add-a-button-to-open-issues) is advised for the published book.
@ -64,7 +70,7 @@ GitHub has a nice integration with the [GitHub Desktop application](git-setup_lo
### Summary
Here's a table summarizing the information:
| | GitHub | GitLab |
| | GitHub | TU Delft GitLab |
|--|----------|-------------|
| Book url | GitHub pages (`<organization/username>.github.io/<book>`), for TU Delft GitHub Enterprise with SSO a random URL (`<random>.github.io/<book>`), or custom url `<anything>.<anything>/<book>`> 🌐 | TeachBooks (`teachbooks.tudelft.nl/<book>`) or TU Delft OIT (`interactivetextbooks.tudelft.nl/<book>`) 🎓 |
| Real-time book editing | Automated and flexible (multiple version of the book, building error insights, fast, custom urls) 🚀 | Automated but simplistic (not easily adaptable, no caching environments, no visual summaries, no parallel processes) 🛵 For TU Delft OIT: restricted adaptations because of copyright checks 🚫 |