From 93788711411044063b3dbd8c40ab9d065c3fbd5c Mon Sep 17 00:00:00 2001 From: b0ink <40929320+b0ink@users.noreply.github.com> Date: Sun, 23 Mar 2025 16:34:50 +1100 Subject: [PATCH 1/4] docs: add capstone self enrolment project proposal --- ...apstone Self Enrolment Project Proposal.md | 305 ++++++++++++++++++ .../Admin/ui_admin_add_projects_tutorials.png | Bin 0 -> 72389 bytes .../UI/Admin/ui_admin_task_form_enable.png | Bin 0 -> 31908 bytes .../Admin/ui_enable_capstone_management.png | Bin 0 -> 27116 bytes .../UI/Admin/ui_existing_groups.png | Bin 0 -> 90226 bytes .../UI/Student/ui_begin_enrolment.png | Bin 0 -> 70618 bytes .../UI/Student/ui_enrolment_complete.png | Bin 0 -> 49805 bytes .../ui_enrolment_form_modal_filling.png | Bin 0 -> 96941 bytes ...ui_enrolment_form_modal_viewsubmission.png | Bin 0 -> 97663 bytes .../UML/current_ontrack_schema_condensed.png | Bin 0 -> 188854 bytes 10 files changed, 305 insertions(+) create mode 100644 docs/OnTrack/Capstone Self Enrolment/Capstone Self Enrolment Project Proposal.md create mode 100644 docs/OnTrack/Capstone Self Enrolment/UI/Admin/ui_admin_add_projects_tutorials.png create mode 100644 docs/OnTrack/Capstone Self Enrolment/UI/Admin/ui_admin_task_form_enable.png create mode 100644 docs/OnTrack/Capstone Self Enrolment/UI/Admin/ui_enable_capstone_management.png create mode 100644 docs/OnTrack/Capstone Self Enrolment/UI/Admin/ui_existing_groups.png create mode 100644 docs/OnTrack/Capstone Self Enrolment/UI/Student/ui_begin_enrolment.png create mode 100644 docs/OnTrack/Capstone Self Enrolment/UI/Student/ui_enrolment_complete.png create mode 100644 docs/OnTrack/Capstone Self Enrolment/UI/Student/ui_enrolment_form_modal_filling.png create mode 100644 docs/OnTrack/Capstone Self Enrolment/UI/Student/ui_enrolment_form_modal_viewsubmission.png create mode 100644 docs/OnTrack/Capstone Self Enrolment/UML/current_ontrack_schema_condensed.png diff --git a/docs/OnTrack/Capstone Self Enrolment/Capstone Self Enrolment Project Proposal.md b/docs/OnTrack/Capstone Self Enrolment/Capstone Self Enrolment Project Proposal.md new file mode 100644 index 000000000..75a790d12 --- /dev/null +++ b/docs/OnTrack/Capstone Self Enrolment/Capstone Self Enrolment Project Proposal.md @@ -0,0 +1,305 @@ +# Capstone company & project self enrolment feature + +## Project scope + +### Description + +This project aims to improve the capstone company and project selection process within OnTrack by +developing a form-based task that collects and processes student selections efficiently. The goal is +to ensure seamless enrolment, prevent errors, and facilitate easy data extraction. + +### Objectives + +- Develop an OnTrack task for SIT374 & SIT378 to handle company and project selection. +- Ensure student selections are accurate and complete before submission. +- Generate a CSV file containing all student selections for administrative use. +- Maintain the ability to modify the form as required. + +### Scope of Work + +The enhancement will include the following steps within a single OnTrack task: + +#### 1. Company allocation task + +- Students self-enrol in a company through the native OnTrack groups. +- The selected company is automatically linked to the form task. + +#### 2. Project Selection + +- Display available projects within the selected company. +- Enforce project capacity limits (default max 30 students, except for designated projects with + different limits) +- Mark fully allocated projects as unavailable (disabled with "Project Full" text) + +#### 3. Leadership Interest + +- Provide a multiple-choice question: "Are you interested in a leadership position? (Yes/No)" + +#### 4. GitHub Username Submission + +- Collect students' GitHub usernames for ease of repository management. + +#### 5. Submission Process + +- Ensure all fields are completed before allowing submission. +- Students should be able to view their submission responses within OnTrack. +- Subission should be final (no resubmissions allowed after end of week 2). + +### Data Management + +- The task should auatomatically collect student names and IDs. +- All form responses should be downloadable as a CSV file for each unit separately. +- Admins should have the ability to modify the form to add/remove project teams or companies. + +### Implementation Considerations + +- A spearate onboarding mobule will be created to guide students on companies and projects before + making selections. +- The form task should have a user-friendly interface and clear instructions to eliminate errors + (eg. Ensure users cannot select a project team that is already full) +- Staff should have an easy-to-use interface for managing project teams and downloading student + selections. + +### Expected Outcomes + +- Streamlined project allocation process within OnTrack. +- Reduced administrative workload for managing company and project selection. +- Improved student experience by ensuring clear and error-free selection processes. + +--- + +## Use Cases + +TODO.. + +--- + +## Understanding how SIT374 & SIT378 are currently managed + +### Group Sets & Groups + +- In Team Project A & B units, `groups` are used for submission tasks 2.1P & 6.1P, allowing each + capstone company to make their own handover report submissions. +- As we have the two units, juniors in Team Project A will submit their report for their group + (Company), and seniors in Team Project B will submit their report for their group (Company). +- These groups each are linked to a tutorial within the unit (Company tutorial), automatically + enrolling students into that tutorial. + +### Tutorial Streams & Tutorials + +- `tutorial_streams` are used to categorise different tutorials. +- Students can only be enrolled into one `tutorial` from each `tutorial_stream` +- Tutorials have a designated tutor, allowing them to access the work submitted students that are + "enrolled" into their tutorial. + +### Current schema design + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
!J(nVeB%)v5Ew2Y;sNJEOKPl
z?8PQ8{d{;lvZho>a!+sUYI0g^o)$9#r+lYd*TJ+j!fr&cVWP(Fl%)Tc6d^=O76%#D
zEB%uc$Nom?an^&16p^(?@_#o+C$G()yPfYwo{0{OAmwtACP}|i{ZA`t5kiP=ZMbH&
z!vEeKGrAyz`d=}?QK!|os39cna$;^2JB{<=&-;vu{2w_RDj@erZT5&f8yftNWwa>q
z|Ci YC0So!qT&0
zCN)kCT``ctZG>5HzAmFCzT+ZPFaizC^)u@17*C&F+%BgFTD{aMDm9d!_1Jq(*T#GA
zV-R4jnvydxO|AE+SDV?$QiCkFgs;cSaiUAGYTI9d>Z9SkK|K}yo&c2H*YV! l8H;ljB+Hc;IU2<=!a$drD$EdHp4$
zUoU>w&ja^L*LGy5mXMpBK(zl3G8b+pSoHl_3hVG~QsazwD;`my*vempQC?@ZD&{2D
zS)lm*bjoes7-Rd3WxLNf=qcC+yBiQl_<5V`qOWrp?!qx}Dzllyt)gxikKFGH*Z0hX
zz5kSOV&
NsH2ia8vLJY{3Pw`WS)7tCLN~mj))`hWJA59E
z)pWGTPn{RB0XGG9!t=os(X88rr@aCEIE&Is%*4$j-q;94{ltm%f7pA=uQ
maat0X3+t9D$gG?_TIzI=xBci+rlufm4z&th?$AWd|?Z}_VwM$FEPy!IL9Ym4G&
zw^ fzy0SK%Uj%wiNYSNhzi*aAs83KI8~n56X(5<~
zF;Fr(_M^g=Fw5(S`*f+1kk_=6m%x~+{jXC+DXlnARgkzo<{xt*dn8q*0zj5toMTXj
z@1d=2Z@3)VyWIC|6tt(BqABd{@S=C&tJk#mwc){H)1Et@fz4<=q;fy($9^i_@{L!I
z2k0gK__if<^4s_lx2k`q_lDnjP~LDX#12cxjhTiHGja-m7jyPDNmr1R`>;nC`bf>k
z{5
En_3*OyZ
z2Y2)Xr-Owjh~95$qUqQk{qRvMDmdkb_h+sbG-M#tP3yuiCO5nR%ELmgHRi%(T^s`1
zkzCc_fz|w<4;JJ^&)5=ky+(IcwQNX}QP+FMD`HvvlWF{o(q2foL0Ln{Zf(9j!zVPN
zuo*tKJ3v3uhl^&g?|R$JnM0J5RgGFxxQ=XQ6QZp*1J`^#dCZE9{f?BiXe&YB>J*yKvqC8n_^
zm%@2U=^>*5o5A!Y2la!MMm2V#mHDEYt)7d_HCsR#tk;XzT7Hw&*6l{23&}w!F0<+$
z$P9ZT2hjamLD=_KOuog40qOQQcHU=3=nOMkCSE-Jj