mo8it/AdvLabDB
1
0
Fork 0
mirror of https://codeberg.org/Mo8it/AdvLabDB.git synced 2024-11-08 21:21:06 +00:00
Code Releases Activity

Remove adoc

Browse source
This commit is contained in:
Mo 2022-06-28 03:51:39 +02:00
parent efabf619ce
commit 856c394aeb
4 changed files with 0 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
advlabdb/scripts/maintain/update_docs.py
View file

@ -1,20 +0,0 @@
# TODO: Port to Python
# Needed packages: asciidoctor
# List of documentation files
# DOC_FILE_NAMES=$(fd -d 1 -t f --extension adoc --exclude "README.adoc")
#
# for doc_file_name in "${DOC_FILE_NAMES[@]}"; do
# DOC_FILE_NAME_WITHOUT_EXTENSION=${doc_file_name::-5}
# OUTPUT_PATH=../advlabdb/templates/docs/$DOC_FILE_NAME_WITHOUT_EXTENSION.html
#
# # Convert to html with asciidoctor
# asciidoctor -v --backend html5 "$doc_file_name" -o "$OUTPUT_PATH"
#
# # Add the Jinja raw tag
# sed -i "1i {% raw %}" "$OUTPUT_PATH"
# echo -e "\n{% endraw %}" >>"$OUTPUT_PATH"
#
# # Done
# echo "Generated $OUTPUT_PATH"
# done

14
docs/user_docs/README.adoc
View file

@ -1,14 +0,0 @@
= Updating documentation
After changing the documentation files with the `.adoc` extension in this directory, the script `update_docs.sh` has to be run to update the related html files in the directory `advlabdb/advlabdb/templates/docs`.
IMPORTANT: You have to `cd` into the `advlabdb/docs` directory where the script, this README and the documentation files with the `.adoc` extension are located before running the script!
IMPORTANT: The packages `fd` (`find` alternative) and `asciidoctor` have to be installed!
Run the script with:
[source,bash]
----
bash update_docs.sh
----

4
docs/user_docs/admin.adoc
View file

@ -1,4 +0,0 @@
= Admin's documentation
// TODO:
Coming soon...

47
docs/user_docs/assistant.adoc
View file

@ -1,47 +0,0 @@
= Assistant's documentation
== Welcome
Welcome to this website, AdvLabDB, where you will be able to manage your lab assistance. Please, *read this documentation* to familiarize yourself with this website.
== Menu items
In this section, you will find explanations to each menu item on the upper navigation bar.
=== Home
This is your home page. Here, you currently only find the number of *missing* final experiment marks for the experiments that you are assigned to. At the latest at the end of the semester, this number should be 0. A number higher than 0 means that some oral and/or protocol marks are missing. The final experiment mark is calculated automatically after the oral and protocol marks of an experiment are set.
=== Group Experiment
Here, you will find all the experiments you are responsible for paired with the groups that are doing these experiments in this semester. You can add an optional note specific to a pair of group and experiment. Examples for such a note:
* Protocol received
* Submission until ...
* etc.
This note can be **seen and edited** by admins and assistants that are responsible for this semester experiment (if you are not the only one who is responsible for this experiment and group pair).
To edit the note, click on the pen on the left of a row.
=== Appointment
Here, you will find all the appointments you have for the experiments you are assigned to. You can only edit the _Date_ of an appointment. You should do so after writing with the students doing the experiment corresponding to the appointment. The initial date you find before editing it is only a suggestion in the week where the appointment should take place. If _Special_ is checked, then the date should be chosen in the semester break.
To edit the date of an appointment, click on the date (underlined fields are editable). Then, choose the new date and click on the check mark.
=== Experiment Mark
Here, you find the experiment marks that you have to fill for every student in every group. Students in a group have separate marks. The oral mark has to be set after the oral exam. The protocol mark has to be set after correcting the group's protocol. The final experiment mark is calculated automatically after the oral and protocol marks are set.
*IMPORTANT:* #Oral and protocol marks are between 0 and 15!#
To edit an oral or protocol mark, click on the pen icon in a row. Then, enter the mark(s) and click on _Save_.
You can use the search bar to find a student by a part of the name or an email.
=== User
Here, you find a table with only one entry which is you as a user. Make sure that the fields _Phone Number_, _Mobile Phone Number_, _Building_ and _Room_ are filled and up to date, especially if you are a new assistant. To edit these fields, click on the pen icon at the left of the single entry in the table. After editing, click on _Save_.
You can generate a new random password by clicking on the pen icon, checking the corresponding checkbox and then clicking on _Save_. You will be then logged out. Your new password is displayed above the login fields. Make sure that you save the password in a safe place. Using a free open source password manager like https://bitwarden.com/[Bitwarden^] or https://keepassxc.org/[KeepassXC^] is recommended.
=== Docs
This is a link which leads you to this page.
=== Active semester
An active semester is the semester you are working in. All shown experiment marks and appointments are in your active semester. By default as a new assistant, your active semester should be the latest semester.
If you see a warning that you are in an old semester, click on _Active semester_ and choose the latest semester. You should only work in an old semester if there are still experiment marks to be set in the old semester.