diff --git a/book/.jupyterlite.doit.db b/book/.jupyterlite.doit.db deleted file mode 100644 index 9d2d1ba..0000000 Binary files a/book/.jupyterlite.doit.db and /dev/null differ diff --git a/book/_toc.yml b/book/_toc.yml index 65a8c63..a0e98dd 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -2,12 +2,14 @@ format: jb-book root: intro parts: - - caption: How to (start to) work and collaborate on your book + - caption: Getting started! (Installation and setup for different types of user) chapters: - file: installation-and-setup/overview sections: - file: installation-and-setup/user-types - file: installation-and-setup/git-setup + - file: installation-and-setup/git-lab + - file: installation-and-setup/comments-extension - file: installation-and-setup/vscode-setup - file: installation-and-setup/jupyter-book-setup - file: workflows/overview diff --git a/book/installation-and-setup/comments-extension.md b/book/installation-and-setup/comments-extension.md new file mode 100644 index 0000000..03bf910 --- /dev/null +++ b/book/installation-and-setup/comments-extension.md @@ -0,0 +1,3 @@ +# Making comments on the website + +This section will explain how to use the extension in order to make comments. diff --git a/book/installation-and-setup/git-lab.md b/book/installation-and-setup/git-lab.md new file mode 100644 index 0000000..19b34d7 --- /dev/null +++ b/book/installation-and-setup/git-lab.md @@ -0,0 +1,5 @@ +# Git-Lab + + + +on the [MUDE website](https://mude.citg.tudelft.nl/software/overview/) there is a video on how to use Git GitLab and GitHub GUI, maybe useful for user 3 and up \ No newline at end of file diff --git a/book/installation-and-setup/git-setup.md b/book/installation-and-setup/git-setup.md index b806060..a455b65 100644 --- a/book/installation-and-setup/git-setup.md +++ b/book/installation-and-setup/git-setup.md @@ -1,4 +1,4 @@ -# Git +# What is Git and how do I set it up ## Installation diff --git a/book/installation-and-setup/user-types.md b/book/installation-and-setup/user-types.md index f2864ea..dc6f67d 100644 --- a/book/installation-and-setup/user-types.md +++ b/book/installation-and-setup/user-types.md @@ -2,17 +2,17 @@ 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 workflow and GitLab. For now we will differentiate 5 types of users. -### 1. Students providing feedback on the website +### 1. Students providing feedback on the published website As can already be seen on the [MUDE website](https://mude.citg.tudelft.nl/book/intro.html) an extension (hypothesis add link to features) 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 book website +### 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 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. +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 +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. (add pic?) @@ -22,4 +22,17 @@ This user has more knowledge in GitLab than the previous user and can basically ### 5. Colleague making adjustments to all content locally -This user has an understanding of GitLab and can independetly make changes on the website built through Jupyter Books. Moreove they have an understanding of various extensions that allows them to make the pages interactive for the student. \ No newline at end of file +This user has an understanding of GitLab and can independetly make changes on the website built through Jupyter Books. Moreove they have an understanding of various extensions that allows them to make the pages interactive for the student. + +### Summary + +Now that the types of users have been explained, you might have an idea which type corresponds to you! (Quiz to follow) +The following table will link the relevant installation and setup steps for you. + +|
User Types
|
Needed Software
|
Installation
| +|:---:|:---|:---| +| Type 1
Type 2 | No software needed!
Just open your interactive book and navigate to the extension | [Extension Tutorial](comments-extension.md) | +| Type 3 | Git & GitLab | [Git](git-setup.md) | +| Type 4 | GitLab
GitHub Desktop / VS Code
Plus maybe Anaconda, Python, knowledge on how to make environments?
Jupyter book | [Git](git-setup.md)
[GitHub Desktop](git-setup.md)
[VS Code](vscode-setup.md) | +| Type 5 | GitLab
GitHub Desktop / VS Code
Jupyter Book
Extensions | [Git](git-setup.md)
[GitHub Desktop](git-setup.md)
[VS Code](vscode-setup.md)
[Jupter Book]()
[Extensions](/book/features/overview.md) | +