From 80d2fa6ef6ded2c239f6100abaef584b2995679d Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Sat, 2 Mar 2024 18:31:39 +0100 Subject: [PATCH] Ready for merge --- book/.jupyterlite.doit.db | Bin 0 -> 24576 bytes book/_toc.yml | 4 ++-- .../comments-extension.md | 3 --- book/installation-and-setup/extension.md | 7 +++++++ .../installation-and-setup/git-hub-desktop.md | 7 +++++++ book/installation-and-setup/git-lab.md | 5 ----- book/installation-and-setup/git-setup.md | 15 ++++++++++++-- book/installation-and-setup/user-types.md | 19 ++++++++---------- 8 files changed, 37 insertions(+), 23 deletions(-) create mode 100644 book/.jupyterlite.doit.db delete mode 100644 book/installation-and-setup/comments-extension.md create mode 100644 book/installation-and-setup/extension.md create mode 100644 book/installation-and-setup/git-hub-desktop.md delete mode 100644 book/installation-and-setup/git-lab.md diff --git a/book/.jupyterlite.doit.db b/book/.jupyterlite.doit.db new file mode 100644 index 0000000000000000000000000000000000000000..c022fbd345eae8bb48d8d95770b4ec6757eba208 GIT binary patch literal 24576 zcmeI4?Qh%09mge~{1iuG(#CNUEGwe`>x$YMkH;f<8VbjaowjQN%!`9=C^g|o9&OgL zq>@xtx6lADSh8V#wU>QYtQhuc?}z;d1%~a#fWF_}?bTik#eluo?j+Ne9r;PA94|Nm zlzBYz$GguxkoUXq`QGxKFkx!Yh&E`VqRfR%Hk-Mrs+mk?gzsZ~Pq!>T$fW`PSA>t+ zMlz+~A9>~9nGt0%qbw?aKI#S;F9}Ejl7J*22}lBxfFvLZNCJ|8Bp?Z#RRUWR+3}g_ z>FidVP`AeXMwp0wz6RwIhRH66< zoaKbzIm-7DKoXDyBmqfa$OM)q!1Z>s5hqo* z71sQZi`56T)?#tBTr8^}w`bL&x5m767Kw22?jpX`4HkKf&zi9~{a&U0@V)We!sGE> zL*^upJqTB;-Wsj1GG7>n&}5h(PxlQQ6Ji_G(~)Tt&4ol~ z#4jG6np)h_Zoq3bv?XFDezMpqe+-Y%ie zC#Khkb_+qAnWN3-oL16HsFbXJv|SiB!5Blc1a)F)8lF|51`Vj&{HO>SKg*y=yg)Z~ zU1PRsYgDrhtU-iLbld_NS{5qprBTsBBUTmUTk(mI_q5O-<-ptRu8DFI(Ry6t<=CkA z9uI2zp#^dakLE=hd#gyJl{8yP)eob6hWj;smjuYLH4HuEVpn6(3k()uAMw_Y7_4+7o7 zN0eGm^?X>%<|>c#Jui@e`7ELd^Q(M}%IYz%tZ_MJNfOpqPu2>aMK`*e=G`ufy4B|9 z>h`N>yGQGNYji6UDw!50n!&p#Od#Q%lz|xvZ2sz?P`5k_Qpn$k7!k`Rl)pXTaXYCY zz6g((UH&aIdWrw!CeHEStNE2op^{%w{!sW-SypZoMwP!Rdf}&q?-V{M{H^eX@~N_x z|6}3H{G)tWSk3>v@SFT+g?Z&CL;fO?<|P41KoXDyBmqf45|9KW0ZBj-IP(N9fw^pV zBp-5zTHG1KU;PGnJ-hAo;V1bxIuQ}wgDY17Nh4|Gt%VO*dHe56SAdm9ai1!WNN<{X z1>DQ-x}#EmVCp#C@q}K!4&F>Hh?C_fu9$umyqi60z~6BmUsAx0?v>rFym$@Fr?yj% zK)LaNMN#Op_=QO@(*<$yGJxrIT_&C13wiKz*PL)yDV-4aU3J(MCct!7oX&p>ET{MG z`m&$M#QF2!S_g-?XX+fdvVG6Fo4GB}iRczdUvGx+vXuGIIb~Dp@eoWF!1W$F6W;_2 zJ;D9%^>LBYUgulaKRebjvg11(ErPexJRRTz%yph~peGNAD%0OxH1Zm#OdeI7X=&wo zYntHG{e_G9$5VfrisbzNneSd?0wn=SKoXDyo+kow{$I}jA0cUw^Z%*NyI#-986|1`Umwiy4P&(tzwzZ!dM42*t0>WyB@ zeVO}3?l$-*_#Kb<8n;K}QtsVP=8ker^phzLC}+ohUDyv(LTKzWpM&(Uk{3o%(R)1u&ng z4^toDuE%zt((Le7*CQIcc@fOCJKo4aE!@2TV4AKT5AmSp78USv7nktG4s4|$tfU_4 zL9NW^!F2m+l2JJimQyx|c)$lu->oTdt&_{AN#g?dxNoO%&~*GdnjGB%pMS6eynJF` z{fQoZV6#7P3=yx<9-TASo>TY8&kNC9L(g#{w$Vt~Qay<_OW1Q=!X=wJ!o&_-pJIf$ z{&0^>TBr|gr16&rBDzpWyVTMVBA8;+r=G3bIv1+DC@^g1SvsVLze0wRCv4g!$n=0x z-KCoA@>K(#VcA;0yqJhUdsfwTgXcvv0tA^$bpkDB`y2t&pzXRI!vUADde0y)$yyls zT;3ifn{&0$<2qLs_t%6Hldl}$IWe$!vqRm~Y#r;qWoVFCkgu8WA+oW}xYixp|=Xy9V%`pDF%foTAl{R|Rr85ZwgOup2@ zMig88>y){MZ+QLkVj0M=W>p(uv2-TDrsW!<_u*yWVPsRTf%aY3z=6*Tf^{;p^KEeO z$JJ1Jq~r9mJP)T+v(rj)ST}j8DQZseAgFQ+sM!2X;D&Q-AVdExkMb zAItwYqx@F6UHDhwv%(!7keehR2}lBxfFvLZNCJ|8Bp?Y$0+PV`. \ No newline at end of file +Git Bash is a shell (also referred to as "the terminal") that is automatically installed with git. It provides Unix-like commands on a Windows OS, and is recommended for working with open source projects like Jupyter (for example `pip install`, building Jupyter books, using Git Bash in VS Code, etc). To do this, `conda` needs to be setup properly; this is described in the {ref}`instructions for setting up VS Code `. + +## More on GitLab + +To get to know more about working in GitLab and getting familiar with its features, click [here](/jupyter-book-manual/book/workflows/overview.md) or watch this [video](https://www.youtube.com/watch?v=1SBtM3znviU&t=1s)! \ No newline at end of file diff --git a/book/installation-and-setup/user-types.md b/book/installation-and-setup/user-types.md index dc6f67d..2d9a254 100644 --- a/book/installation-and-setup/user-types.md +++ b/book/installation-and-setup/user-types.md @@ -1,10 +1,10 @@ # 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 workflow and GitLab. For now we will differentiate 5 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 -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. +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 @@ -14,25 +14,22 @@ In a similar manner, colleages and team members can leave content related commen 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?) - ### 4. Colleague making 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. The trickty part however is implementing interactive features in the book as they definetly require more knowledge on implementation and testing using a local python server or in the draft version online. +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. ### 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. +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. ### Summary -Now that the types of users have been explained, you might have an idea which type corresponds to you! (Quiz to follow) +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
|
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 1
Type 2 | No software needed!
Just open your interactive book and navigate to the extension | [Extension Tutorial](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) | - +| Type 4 | Git & GitLab
GitHub Desktop
VS Code
Python Environments
Jupyter book | [Git](git-setup.md)
[GitHub Desktop](git-hub-desktop.md)
[VS Code](vscode-setup.md) | +| Type 5 | Git & GitLab
GitHub Desktop
VS Code
Jupyter Book
Extensions | [Git](git-setup.md)
[GitHub Desktop](git-hub-desktop.md)
[VS Code](vscode-setup.md)
[Jupyter Book](jupyter-book-setup)
[Extensions](../features/overview.md) |