From c41c48ea525e6f5609d7bbe3d56df8c27ff6ca29 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 4 Nov 2024 10:19:11 +0100 Subject: [PATCH] restructure team and tools --- book/_toc.yml | 6 ++---- book/installation-and-setup/collab.md | 7 ++++++- book/installation-and-setup/organize-team.md | 8 -------- book/installation-and-setup/tools.md | 12 +++++++++--- 4 files changed, 17 insertions(+), 16 deletions(-) delete mode 100644 book/installation-and-setup/organize-team.md diff --git a/book/_toc.yml b/book/_toc.yml index cbe770b..a5cd7c1 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -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: diff --git a/book/installation-and-setup/collab.md b/book/installation-and-setup/collab.md index 53c4532..1742531 100644 --- a/book/installation-and-setup/collab.md +++ b/book/installation-and-setup/collab.md @@ -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. diff --git a/book/installation-and-setup/organize-team.md b/book/installation-and-setup/organize-team.md deleted file mode 100644 index 8cc81c3..0000000 --- a/book/installation-and-setup/organize-team.md +++ /dev/null @@ -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. \ No newline at end of file diff --git a/book/installation-and-setup/tools.md b/book/installation-and-setup/tools.md index 2ca353b..9e3f6a9 100644 --- a/book/installation-and-setup/tools.md +++ b/book/installation-and-setup/tools.md @@ -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 (`.github.io/`), for TU Delft GitHub Enterprise with SSO a random URL (`.github.io/`), or custom url `./`> 🌐 | TeachBooks (`teachbooks.tudelft.nl/`) or TU Delft OIT (`interactivetextbooks.tudelft.nl/`) 🎓 | | 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 🚫 |