diff --git a/.~lock.Rewritten-docs.md# b/.~lock.Rewritten-docs.md# new file mode 100644 index 0000000..b2d7617 --- /dev/null +++ b/.~lock.Rewritten-docs.md# @@ -0,0 +1 @@ +,petr,felicity,18.01.2017 13:51,file:///home/petr/.config/libreoffice/4; \ No newline at end of file diff --git a/Rewritten-docs.md b/Rewritten-docs.md index 0907159..5099f95 100644 --- a/Rewritten-docs.md +++ b/Rewritten-docs.md @@ -341,7 +341,7 @@ annoyed if they did not. - _automated deployment_ -- all of the components of the system must be easy to deploy in an automated fashion - _open source licensing_ -- the source code should be released under a - permissive license allowing further development; this also applies to used + permissive licence allowing further development; this also applies to used libraries and frameworks - _multi-platform worker_ -- worker machines running Linux, Windows and potentially other operating systems must be supported @@ -540,8 +540,8 @@ we figured out is based on user and group separation inside the system. There are multiple _instances_ in the system, which means unit of separation. Each instance has own set of users and groups, exercises can be optionally shared. Evaluation backend is common for all instances. To keep track of active -instances and paying customers, each instance must have a valid _license_ to -allow users submit their solutions. License is granted for defined period of +instances and paying customers, each instance must have a valid _licence_ to +allow users submit their solutions. licence is granted for defined period of time and can be revoked in advance if the subject do not keep approved terms and conditions. @@ -2082,7 +2082,7 @@ In meta information form you can fill these options: - subform for localized descriptions (new localization can be added by clicking on "Add language variant" button, current one can be deleted with "Remove this language" button) - - language of description from dropdown field (english, czech, german) + - language of description from dropdown field (English, Czech, German) - description in selected language - score configuration which will be used on students solution evaluation, you can find some very simple one already in here, description of score @@ -2146,19 +2146,21 @@ This page is the same as for students with one exception -- there is an additional collapsed box "Set bonus points". In unfolded state, there is an input field for one number (positive or negative integer) and confirmation button "Set bonus points". After filling intended amount of points and -submitting the form, the data in "Evaluation details" box get immedialely +submitting the form, the data in "Evaluation details" box get immediately updated. To remove assigned bonus points, submit just the zero number. The bonus points are not additive, newer value overrides older values. It is useful to give a feedback about the solution back to the user. For this you can use the "Commens and notes" box. Make sure that the messages are not private, so that the student can see them. More detailed description of this box +can be nicely used the "Comments and notes" box. Make sure that the messages are +not private, so the student can see them. More detailed description of this box is available in student part of user documentation. One of the discussed concept was marking one solution as accepted. However, due to lack of frontend developers it is not yet prepared in user interface. We hope, it will be ready as soon as possible. The button for accepting a solution -will be most propably also on this page. +will be most probably also on this page. ### Creating exercises @@ -2188,8 +2190,8 @@ can define: - subform containing localized descriptions of exercise, new one can be added with "Add language variant" button and current one deleted with "Remove this language" - - language in which this particular description is in (czech, english, - german) + - language in which this particular description is in (Czech, English, + German) - actual localized description of exercise After all information is properly set form has to be submitted with "Edit @@ -2246,6 +2248,8 @@ as described earlier. However, there is curretly no user interface to upload and evaluate reference solutions. It is possible to use direct REST API calls, but it is not very user +However, there is currently no user interface to upload and evaluate reference +solutions. It is possible to use direct REST API calls, but it is not much user friendly. If you are interested, please look at [API documentation](https://recodex.github.io/api/), notably sections _Uploaded-Files_ and _Reference-Exercise-Solutions_. You need to upload the @@ -2303,7 +2307,7 @@ particular supervisor should not to be supervisor of the group anymore. Instance administrator can be only one person per instance. In addition to previous roles this administrator should be able to modify the instance details, -manage licenses and take care of top level groups which belong to the instance. +manage licences and take care of top level groups which belong to the instance. ### Instance management @@ -2331,7 +2335,7 @@ as the one for creating subgroup in already existing group so we can skip description of the form fields. After successful creation of the group it will appear in "Groups hierarchy" box at the top of the page. -### Licenses +### licences On the instance details page, there is a box "Licences". On the first line, it shows it this instance has currently valid licence or not. Then, there are @@ -2342,7 +2346,7 @@ the last date of licence validity. A box "Add new licence" is used for creating new licences. Required fields are the note and the last day of validity. It is not possible to extend licence lifetime, a new one should be generated instead. It is possible to have more -than one valid licence at a time. Curretly there is no user interface for +than one valid licence at a time. Currently there is no user interface for revoking licences, this is done manually by superadministrator. If an instance is to be disabled, all valid licences have to be revoked. @@ -2742,8 +2746,8 @@ enables the system to be shared by multiple independent organizations without interfering with each other. Usage of the system by the users of an instance can be limited by -possessing a valid license. It is up to the administrators of the system -to determine the conditions under which they will assign licenses to the +possessing a valid licence. It is up to the administrators of the system +to determine the conditions under which they will assign licences to the instances. ### Group @@ -2827,7 +2831,7 @@ role of a specific user changes Instances and hierarchy of groups --------------------------------- -@todo: What is an instance, how to create one, what are the licenses and +@todo: What is an instance, how to create one, what are the licences and how do they work. Why can the groups form hierarchies and what are the benefits – what it means to be an admin of a group, hierarchy of roles in the group hierarchy. @@ -2947,7 +2951,7 @@ of entities and relational database models), describe the logical grouping of entities and how they are related: - user + settings + logins + ACL -- instance + licenses + groups + group membership +- instance + licences + groups + group membership - exercise + assignments + localized assignments + runtime environments + hardware groups - submission + solution + reference solution + solution evaluation