From 4fa2a4f518d3d1664359e04cbf4c38c73bfe3758 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 10 Apr 2024 12:56:18 +0200 Subject: [PATCH] Restructured some more stuff --- book/_toc.yml | 3 +- book/installation-and-setup/overview.md | 34 ++--------------------- book/installation-and-setup/user_types.md | 29 +++++++++++++++++++ 3 files changed, 33 insertions(+), 33 deletions(-) create mode 100644 book/installation-and-setup/user_types.md diff --git a/book/_toc.yml b/book/_toc.yml index 3776795..5457f6c 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -4,9 +4,9 @@ root: intro parts: - caption: Getting started! chapters: + - file: installation-and-setup/user_types - file: installation-and-setup/overview sections: - - file: installation-and-setup/extension - file: installation-and-setup/git-setup - file: installation-and-setup/vscode-setup - file: installation-and-setup/git-setup_local @@ -29,6 +29,7 @@ parts: - file: basic-features/overview sections: - file: basic-features/recipes.md + - file: installation-and-setup/extension - file: features/overview sections: - file: features/remove_from_publish diff --git a/book/installation-and-setup/overview.md b/book/installation-and-setup/overview.md index 2876046..42646c3 100644 --- a/book/installation-and-setup/overview.md +++ b/book/installation-and-setup/overview.md @@ -1,41 +1,11 @@ -# Installation and setup for different types of users - -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**.
-Example Image - - As can already be seen on the [MUDE website](https://mude.citg.tudelft.nl/book/intro.html) an extension has been added that allows students to highlight and annotate sections which they consider important. Through that extension students will also be able to leave feedback about the content or the website for the responsible teacher. - -
- -2. **Colleague providing feedback on the draft website**.
- In a similar manner, colleages and team members can leave content related comments on the webiste through that extension. 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. The responsible teacher (or student assistants) can then make the adaptations to the book as recommended by their colleagues. - -3. **Colleague making adjustments in GitLab using single text editor**.
- This type of user requires only very basic knowledge in GitLab in order to make changes to the website themselves without needing to install any software! Making adjustments using single text editor only requires the user to be able to login into GitLab and edit .md or .ipynb files. The changes can be done directly in the main or publish branch and if a new branch is needed for the changes then the set-up and merging can be taken care of by someone more familiar in GitLab. - -4. **Colleague making text adjustments locally**.
- 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 4 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 python adjustments to non-interactive content locally**.
- This user has more knowledge in GitLab 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. The tricky part however is implementing interactive features in the book as they definitely require more knowledge on implementation and testing using a local python server or in the draft version online. - -6. **Colleague making adjustments to all content locally**.
-Example Image - - This user has an understanding of GitLab and can independently make changes on the website built through Jupyter Books. Moreover they have an understanding of various extensions that allows them to make the pages interactive for the student. - -
- -**Overview required software** +# Installation for book reviewers and editors Now that the types of users have been explained, you might have an idea which type corresponds to you!
The following table will link the relevant installation and setup steps for you. |
User Types
|
Relevant Sections
|
Installation
| |:---:|:---|:---| -| Type 1
Type 2 | No software needed!
Just open your interactive book and navigate to the extension | [Extension Tutorial](extension.md) | +| Type 1
Type 2 | No software needed!
Just open your interactive book online and give review in the way you're asked to do| | | Type 3 | Understanding Git & GitLab | [Git & GitLab](git-setup.md) | | Type 4 | Understanding Git & GitLab
Edit using VS Code
Local Git with VS Code / GitHub Desktop| [Git & GitLab](git-setup.md)
[VS Code](vscode-setup.md)
[How do I use git locally?](git-setup_local.md) | | Type 5 | Understanding Git & GitLab
Edit using VS Code
Local Git with VS Code / GitHub Desktop
Anaconda
Using Anaconda in terminal
Working with directories
Python Environments
Python package: Jupyter book | [Git & GitLab](git-setup.md)
[VS Code](vscode-setup.md)
[How do I use git locally?](git-setup_local.md)
[Anaconda](anaconda.md)
[Anaconda in terminal](add_conda_to_path.md)
[Working directories](working-directory.md)
[Environments](environments.md)
[Jupyter Book](jupyter-book-setup) | diff --git a/book/installation-and-setup/user_types.md b/book/installation-and-setup/user_types.md new file mode 100644 index 0000000..d2de873 --- /dev/null +++ b/book/installation-and-setup/user_types.md @@ -0,0 +1,29 @@ +# User types + +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**.
+Example Image + + As can already be seen on the [MUDE website](https://mude.citg.tudelft.nl/book/intro.html) an extension has been added that allows students to highlight and annotate sections which they consider important. Through that extension students will also be able to leave feedback about the content or the website for the responsible teacher. + +
+ +2. **Colleague providing feedback on the draft website**.
+ In a similar manner, colleages and team members can leave content related comments on the webiste through that extension. 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. The responsible teacher (or student assistants) can then make the adaptations to the book as recommended by their colleagues. + +3. **Colleague making adjustments in GitLab using single text editor**.
+ This type of user requires only very basic knowledge in GitLab in order to make changes to the website themselves without needing to install any software! Making adjustments using single text editor only requires the user to be able to login into GitLab and edit .md or .ipynb files. The changes can be done directly in the main or publish branch and if a new branch is needed for the changes then the set-up and merging can be taken care of by someone more familiar in GitLab. + +4. **Colleague making text adjustments locally**.
+ 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 4 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 python adjustments to non-interactive content locally**.
+ This user has more knowledge in GitLab 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. The tricky part however is implementing interactive features in the book as they definitely require more knowledge on implementation and testing using a local python server or in the draft version online. + +6. **Colleague making adjustments to all content locally**.
+Example Image + + This user has an understanding of GitLab and can independently make changes on the website built through Jupyter Books. Moreover they have an understanding of various extensions that allows them to make the pages interactive for the student. + +
\ No newline at end of file