mo8it/AdvLabDB
1
0
Fork 0
mirror of https://codeberg.org/Mo8it/AdvLabDB.git synced 2024-12-02 22:33:05 +00:00
Code Releases Activity

Done docs

Browse source
This commit is contained in:
Mo 2023-11-04 21:36:56 +01:00
parent 99cc109cde
commit 4cfc616a34
1 changed files with 92 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

105
advlabdb/templates/docs/admin.jinja.html
View file

@ -284,31 +284,70 @@
Only set a semester as done if all marks in that semester and all previous semesters are already set.
</p>
<!-- TODO
<h4 id="part">Part</h4>
<p></p>
<p>This table shows the parts in your active semester.</p>
<p>
A part consists of a <a href="#program">program</a>, a <a href="#semester">semester</a> and a number.
For example, if students in the bachelor of science program (BS) must absolve two lab courses, then you would have the parts BS1 and BS2.
But maybe the university only offers part BS2 every second semester.
Therefore, a part is coupled to a semester.
</p>
<h4 id="assistant">Assistant</h4>
<p></p>
<p>This table shows all assistants.</p>
<p>
To deactivate an assistant, you have to deactivate their <a href="#user">user</a> account.
</p>
<p>
You can assign <a href="#semester_experiment">semester experiments</a> to assistants either in this table or in the semester experiments table.
</p>
<h4 id="admin">Admin</h4>
<p></p>
<p>This is a read only table that shows current admins.</p>
<h4 id="user">User</h4>
<p></p>
<p>This table shows all users.</p>
<p>A user can have either an admin or assistant role (or both).</p>
<p>
Make sure to deactivate users if they don't require access to the database anymore.
Deactivated users can't login anymore.
</p>
<p>
Further details can be read under <a href="#user_settings">User settings</a>.
</p>
<h4 id="program">Program</h4>
<p></p>
<p>This table shows all programs.</p>
<p>
A program is a university program.
You can for example have the programs BS for bachelor of science, BE for bachelor of education, MS for master of science and so on.
It is recommended to choose short labels for programs.
</p>
<h3 id="import">Import</h3>
<p></p>
<p>
Allows you to import data for your active semester from a file.
Visit the importing page for more information.
</p>
<h3 id="actions">Actions</h3>
<p></p>
<p>
Run one or multiple actions like creating a database backup.
The available actions should be explained on the page.
</p>
<h3 id="analysis">Analysis</h3>
<p></p>
-->
<p>
Run an analysis and plot the results.
More information on the page itself.
</p>
<h3 id="docs">Docs</h3>
<p>This is a link which leads you to this page.</p>
@ -345,11 +384,51 @@
</p>
<p>If you forget your password, you can reset it using the CLI on the server.</p>
<!-- TODO
<h2>How-Tos</h2>
<h3>Start a new semester</h3>
<p></p>
-->
<p>Here is a list of tables that one has to visit when creating a new semester:</p>
<ol>
<li>
Program: Make sure that the programs are up to date. Usually, you will only create new programs when first creating the database for the first time.
</li>
<li>
User: Create a user for every new assistants.
Old assistants should already be in the database, just make sure that their users are activated.
</li>
<li>
Experiment: Create possibly new experiments.
Old experiments should already be in the database, just make sure that they are activated.
</li>
<li>
Semester: Create a new semester.
Read the notes in the form for creating a semester.
Possibly set old semester as done.
</li>
<li>
Part: The parts from the last semester should be duplicated in the new semester (if you don't uncheck the checkbox "Transfer parts" on creating a new semester).
You can add or remove a part from the new semester if required.
</li>
<li>
Semester Experiment: Semester experiments should be duplicated in the new semester (if you don't uncheck the checkbox "Transfer experiments" on creating a new semester).
Make sure that all are present.
Possibly create new ones.
Check the assigned assistants and possibly assign new ones or reassign old ones.
</li>
<li>
Import: Skip the next steps if you want to use the import functionality.
In that case, create an import file and import it.
Check that everything is imported correctly afterwards.
</li>
<li>Student: Add students that are new to the database.</li>
<li>Part Student: Add part students for all students that are doing a part in this semester.</li>
<li>Group: Create groups for part students.</li>
<li>
Group Experiment: Create new group experiments to assign semester experiments to groups.
The form allows you to directly add up to two appointments.
</li>
<li>Appointment: Check appointments and possibly add missing ones.</li>
</ol>
<h3>Tables</h3>