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

Update user_types.md

Browse source
This commit is contained in:
Robert Lanzafame 2024-12-04 02:26:46 +01:00 • committed by GitHub
parent ee7423cff0
commit 0f0c65118d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -9,7 +9,7 @@ Different types of users will interact with the website or the Jupyter Books dif
In a similar manner as students, colleages and team members can leave content-related comments on the website through extensions or GitHub/GitLab features (e.g., Issues). In this way, multiple teachers can give input in the draft of the textbook and course material without requiring a complete understanding of Jupyter Books or GitLab/GitHub. The responsible teacher (or student assistants) can then make adaptations to the book as recommended by their colleagues.
3. **Colleague making adjustments via the browser**. <br>
This type of user requires only very basic knowledge in GitLab/GitHub in order to make changes to the website themselves. Most iportantly, there is no need to install any software! Making adjustments to a file only requires the user to be able to login into GitLab/GitHub and edit .md or .ipynb files. The changes can be done directly in the main or release branch, or, if unsure, a new branch can be used for the changes then the set-up and merging can be taken care of by someone more familiar in GitLab/GitHub. Files can be edited individually or many-at-a-time using the VS Code-style browser application.
This type of user requires only very basic knowledge in GitLab/GitHub in order to make changes to the website themselves. Most iportantly, there is no need to install any software! Making adjustments to a file only requires the user to be able to login into GitLab/GitHub and edit .md or .ipynb files. The changes can be done directly in an existing branch, or, if unsure, a new branch can be used for the changes then the set-up and merging can be completed by someone more familiar with GitLab/GitHub. Files can be edited individually or many-at-a-time using the VS Code-style browser application.
4. **Colleague making adjustments locally**. <br>
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 and therefore does not need to have special software installed besides a text editor (e.g., Python is not required).