From 3f495ebee19464ffaa9da4b80a22fa916f8d9c65 Mon Sep 17 00:00:00 2001
From: Kurzenberger <01kuni1bif@hft-stuttgart.de>
Date: Fri, 13 Dec 2024 11:04:58 +0100
Subject: [PATCH] deployed codeChecker to Readme and fixed the links to the
pictures in the readme
---
{doc => .assets}/install_conf_1.png | Bin
{doc => .assets}/install_conf_2.png | Bin
{doc => .assets}/usage_student_1.png | Bin
{doc => .assets}/usage_student_2.png | Bin
{doc => .assets}/usage_student_3.png | Bin
{doc => .assets}/usage_student_4.png | Bin
{doc => .assets}/usage_teacher_1.png | Bin
{doc => .assets}/usage_teacher_2.png | Bin
{doc => .assets}/usage_teacher_3.png | Bin
README.md | 14 ++++++++++----
10 files changed, 10 insertions(+), 4 deletions(-)
rename {doc => .assets}/install_conf_1.png (100%)
rename {doc => .assets}/install_conf_2.png (100%)
rename {doc => .assets}/usage_student_1.png (100%)
rename {doc => .assets}/usage_student_2.png (100%)
rename {doc => .assets}/usage_student_3.png (100%)
rename {doc => .assets}/usage_student_4.png (100%)
rename {doc => .assets}/usage_teacher_1.png (100%)
rename {doc => .assets}/usage_teacher_2.png (100%)
rename {doc => .assets}/usage_teacher_3.png (100%)
diff --git a/doc/install_conf_1.png b/.assets/install_conf_1.png
similarity index 100%
rename from doc/install_conf_1.png
rename to .assets/install_conf_1.png
diff --git a/doc/install_conf_2.png b/.assets/install_conf_2.png
similarity index 100%
rename from doc/install_conf_2.png
rename to .assets/install_conf_2.png
diff --git a/doc/usage_student_1.png b/.assets/usage_student_1.png
similarity index 100%
rename from doc/usage_student_1.png
rename to .assets/usage_student_1.png
diff --git a/doc/usage_student_2.png b/.assets/usage_student_2.png
similarity index 100%
rename from doc/usage_student_2.png
rename to .assets/usage_student_2.png
diff --git a/doc/usage_student_3.png b/.assets/usage_student_3.png
similarity index 100%
rename from doc/usage_student_3.png
rename to .assets/usage_student_3.png
diff --git a/doc/usage_student_4.png b/.assets/usage_student_4.png
similarity index 100%
rename from doc/usage_student_4.png
rename to .assets/usage_student_4.png
diff --git a/doc/usage_teacher_1.png b/.assets/usage_teacher_1.png
similarity index 100%
rename from doc/usage_teacher_1.png
rename to .assets/usage_teacher_1.png
diff --git a/doc/usage_teacher_2.png b/.assets/usage_teacher_2.png
similarity index 100%
rename from doc/usage_teacher_2.png
rename to .assets/usage_teacher_2.png
diff --git a/doc/usage_teacher_3.png b/.assets/usage_teacher_3.png
similarity index 100%
rename from doc/usage_teacher_3.png
rename to .assets/usage_teacher_3.png
diff --git a/README.md b/README.md
index 0b95c53..2f94ab2 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ After approval, install the plugin directly from the Moodle Plugins Directory vi
Before that or alternatively: zip the plugin code from https://transfer.hft-stuttgart.de/gitlab/HFTSoftwareProject/moodledta (here). The readily-zipped current version also sits in the repository’s main directory. Then install the plugin from zip via Site Administration/Plugins/Install Plugins, or by extracting the plugin archive to {Moodle_Root}/mod/assign/submission/dta and visiting the admins notifications page.
-Visit Site Administration/Plugins/Plugin Overview and select Settings next to the Moodle Dockerized Test Agent (MoDTA) entry to enter the URI of your backend as shown in Fig. 1.  Finally, configure via Site Administration/Security/HTTP Security settings permitting communication with the backend URI and port as seen in Fig. 2.  The plugin requires the external DTA REST webservice backend.
+Visit Site Administration/Plugins/Plugin Overview and select Settings next to the Moodle Dockerized Test Agent (MoDTA) entry to enter the URI of your backend as shown in Fig. 1.  Finally, configure via Site Administration/Security/HTTP Security settings permitting communication with the backend URI and port as seen in Fig. 2.  The plugin requires the external DTA REST webservice backend.
Notes:
@@ -59,7 +59,7 @@ With the MoDTA plugin installed and configured backend URI (including Moodle Sec
### Teacher
-When creating an assignment, a teacher can select the MoDTA exercise as a new assignment type via an additional checkbox on the assignment creation page as shown at the bottom of Fig. 3.  A new standard file upload field appears as indicated in Fig. 4. . There, the teacher must upload a text file with the git repository URI containing the tests as shown in Fig. 5.  The text file has to adhere to the following format also given in the example repository:
+When creating an assignment, a teacher can select the MoDTA exercise as a new assignment type via an additional checkbox on the assignment creation page as shown at the bottom of Fig. 3.  A new standard file upload field appears as indicated in Fig. 4. . There, the teacher must upload a text file with the git repository URI containing the tests as shown in Fig. 5.  The text file has to adhere to the following format also given in the example repository:
The text file has to contain the following, each separated by ::
- dtt as the URI-type
@@ -76,9 +76,9 @@ Students use the same format, just without the runner part at the end.
### Student
-Students use an additional MoDTA standard file upload field in the standard submission processs in Moodle like in Fig. 6. [Fig. 6: Moodle DTA Student File Upload](doc/usage_student_1.png) There, they place either a zip archive or a text file adhering to the same format as the teacher’s file with their code repository URI and optionally credentials and/or a ticketing system URI as shown in Fig. 7. 
+Students use an additional MoDTA standard file upload field in the standard submission processs in Moodle like in Fig. 6. [Fig. 6: Moodle DTA Student File Upload](.assets/usage_student_1.png) There, they place either a zip archive or a text file adhering to the same format as the teacher’s file with their code repository URI and optionally credentials and/or a ticketing system URI as shown in Fig. 7. 
-Upon completion, students see a summarized overview of their test results in an additional column of the submission feedback table like in Fig. 8.  Clicking on a new expansion icon in that column, they reach a detailed feedback dialog including stack traces of compile errors and test failures as in Fig. 9.  Optionally, the MoDTA backend creates tickets for compile failures in the ticketing system under the URI provided by the student upon hand-in.
+Upon completion, students see a summarized overview of their test results in an additional column of the submission feedback table like in Fig. 8.  Clicking on a new expansion icon in that column, they reach a detailed feedback dialog including stack traces of compile errors and test failures as in Fig. 9.  Optionally, the MoDTA backend creates tickets for compile failures in the ticketing system under the URI provided by the student upon hand-in.
Note: Teachers have access to the Moodle submission result view to assess student results. However, teacher control and grading are not the focus of MoDTA.
@@ -162,3 +162,9 @@ This file serves as the gateway to various standard Moodle APIs designed for plu
### util folder
The folder contains various utility files, e.g. displaying the new test summary pages is delegated from the locallib.php for brevity of that source.
+
+
+### Code Checking
+
+The Moodle Plugin Directory offers a helpful tool for developers to ensure their code adheres to Moodle's coding conventions. This tool, named "Code Checker," can be found via the following link:
+https://moodle.org/plugins/local_codechecker
\ No newline at end of file
--
GitLab