Merge branch 'master' of https://github.com/ReCodEx/wiki.wiki

Rewritten-docs.md

@@ -1817,7 +1817,7 @@ application follows.
 ### First steps in ReCodEx
 
 You can create an account if you click on the “*Create account*” menu item in
-the left sidebar. You can choose between two types of registration methods – by
+the left sidebar. You can choose between two types of registration methods -- by
 creating a local account with a specific password, or pairing your new account
 with an existing CAS UK account.
 
@@ -1839,8 +1839,8 @@ organization you are a member of.
 
 To log in, go to the homepage of ReCodEx and in the left sidebar choose the menu
 item “*Sign in*”. Then you must enter your credentials into one of the two forms
-– if you selected a password during registration, then you should sign with your
+-- if you selected a password during registration, then you should sign with
-email and password in the first form called “*Sign into ReCodEx*”. If you
+your email and password in the first form called “*Sign into ReCodEx*”. If you
 registered using the Charles University Authentication Service (CAS), you should
 put your student’s number and your CAS password into the second form called
 “*Sign into ReCodEx using CAS UK*”.
@@ -1887,39 +1887,39 @@ provided later on with according roles.
 
 ## Student
 
-Student is a default role used in web application every newly registered user
+Student is a default role for every newly registered user. This role has quite
-has it. As a student you have a quite limited range what to do in ReCodEx.
+limited range what can to do in ReCodEx. Generally student can only submit
-Generally you can only submit your solutions of exercises in some particular
+solutions of exercises in some particular groups. These groups should correspond
-groups. These groups should correspond to courses you attend at college.
+to courses he/she attend at college.
 
-On the "Dashboard" page there is "Groups you are student of" section where you
+On the "*Dashboard*" page there is "Groups you are student of" section where you
-can find list of your students groups in rows. In first column of every row
+can find list of your student groups. In first column of every row there is a
-there is brief panel describing concerning group. There is name of the group and
+brief panel describing concerning group. There is name of the group and
 percentage of gained points from course. If you have enough points to
-successfully complete the course then described panel will have green background
+successfully complete the course then this panel has green background with tick
-with tick sign. In the second column there can be found list of assigned
+sign. In the second column there is a list of assigned exercises with its
-exercises with deadlines. If you want to quickly get to the groups page you
+deadlines. If you want to quickly get to the groups page you might want to use
-might want to use provided "Show group's detail" button.
+provided "Show group's detail" button.
 
 ### Join group and start solving assignments
 
-To be able to submit solutions you have to be member of the right group. Groups
+To be able to submit solutions you have to be member of the right group. Each
-as such has hierarchy and belongs to some particular instance which you chose
+instance have own group hierarchy, so you can choose only those from your
-during registration. That is why if you want to join group you have to visit
+instance. That is why list of groups is available from instance link located in
-your instance link located in sidebar. After that you will be redirected
+sidebar. This link brings you to instance detail page.
-instance detail page.
 
-In there you can see some description of intance and most importantly in "Groups
+In there you can see a description of the intance and most importantly in
-hierarchy" box there can be found hierarchical list of all public groups in
+"Groups hierarchy" box there is a hierarchical list of all public groups in the
 instance. Please note that groups with plus sign are collapsable and can be
-further extended. If you successfully located instance which you would like to
+further extended. If you successfully located group you would like to join,
-join continue by clicking on "See group's page" link.
+continue by clicking on "See group's page" link following with "Join group"
+link.
 
-**Note:** Some groups can be marked as private these groups are not visible in
+**Note:** Some groups can be marked as private and these groups are not visible
- hierarchy and cannot be joined by students themselves. Management of students
+ in hierarchy and membership cannot be established by students themselves.
- is then in the hands of supervisors.
+ Management of students in this type of groups is in the hands of supervisors.
 
-On the group detail page there multiple things which might concern you. First
+On the group detail page there are multiple interesting things for you. First
 one is brief overview with information describing the group, there is list with
 supervisors and also hierarchy of subgroups. Most importantly there is
 "Student's dasboard" section. This section contains list of assignments and list
@@ -1927,54 +1927,56 @@ of fellow students. If supervisors of groups allowed students to see each others
 statistics there will also be points which particular students gained.
 
 In the "Assignments" box on the group detail page there is list of assigned
-exercises which are students supposed to solve. Assignments are displayed with
+exercises which students are supposed to solve. The assignments are displayed
-their names and deadlines. There are two deadlines, the first one means that
+with their names and deadlines. There are possibly two deadlines, the first one
-till this datetime student will receive full amount of points in case of
+means that till this datetime student will receive full amount of points in case
-successful solution. Second deadline does not have to be set but if it is, then
+of successful solution. Second deadline does not have to be set, but in case of
-number of points which are gainable for successful solution within first and
+presence the maximum number of points for successful solution between these two
-second deadline can be different.
+deadlines can be different.
-
+
-If you follow assignment link it will lead you to assignment detail page. In
+An assignment link will lead you to assignment detail page where are presented
-there you can found all possible details which might interest you. There are of
+all known details about assignment. There are of course both deadlines, limit of
-course particular deadlines but also limit of submissions which you can make and
+submissions which you can make and also full-range description of assignment,
-full-range description of assignment. Description of assignment can be localized
+which can be localized. The localization can be ondemand switched between all
-and you can switch between all language variants in tab like box.
+language variants in tab like box.
-
+
-Further on the page you can found "Submitted solutions" box where list of
+Further on the page you can find "Submitted solutions" box where is a list of
-submissions can be found with links to result details. But most importantly
+submissions with links to result details. But most importantly there is a
-there is "Submit new solution" button on the assignment page which makes it
+"Submit new solution" button on the assignment page which provides an interface
-possible to submit solution of the assignment.
+to submit solution of the assignment.
-
+
-After clicking on submit button, dialog window should show up. In here you can
+After clicking on submit button, dialog window will show up. In here you can
-upload files representing your solution, you can even add some notes to your
+upload files representing your solution, you can even add some notes to mark the
-supervisor if you thing they are needed. After you successfully uploaded all
+solution. Your supervisor can also access the note. After you successfully
-files necessary for the right execution of your solution then click on "Submit
+uploaded all files necessary for your solution, click on "Submit your solution"
-your solution" button and let ReCodEx do its thing.
+button and let ReCodEx do its thing.
-
+
-During execution ReCodEx backend might send to your browser evaluation progress
+During the execution ReCodEx backend might send evaluation progress state to
-state which will be displayed in another dialog window. When whole execution is
+your browser which will be displayed in another dialog window. When the whole
-finished then "See the results" button will appear and you can look at the
+execution is finished then a "See the results" button will appear and you can
-results of your solution.
+look at the results of your solution.
-
+
-On the results details page there are lot of information. Apart assignment
+On the results detail page there are a lot of information. Apart assignment
-description which is not connected to your results you can found here when the
+description which is not connected to your results there is also the solution
-solution was submitted and by whom (supervisor can submit solution on your
+submitter name (supervisor can submit solution on your behalf), further there
-behalf), further there are files which were uploaded on submission and most
+are files which were uploaded on submission and most importantly "Evaluation
-importantly "Evaluation details" and "Test results".
+details" and "Test results" boxes.
 
 Evalation details contains overall results of your solution. There are
-information such as if solution was provided before deadlines if the evaluation
+information such as if solution was provided before deadlines, if the evaluation
 process succesfully finished or if compilation succeeded. After that you can
-find a lot of numbers, most important one is the last one "Total score" where
+find a lot of values, most important one is the last, "Total score", consisting
-first number is your score and second one the maximum number of points.
+of your score, slash and the maximum number of points for this assignment.
-Interestingly the first number in total score can be higher than second one,
+Interestingly the your score value can be higher than the maximum, which is
-that is because of "Bonus points" item above. If your solution is nice and
+caused by "Bonus points" item above. If your solution is nice and
-supervisor will notice it he/she can assign you additional points for effort.
+supervisor notices it, he/she can assign you additional points for effort. On
-
+the other hand, points can be also subtracted for bad coding habits or even
-In test results box you can find table of results from particular exercise test
+cheating.
-cases. In columns you can find these information:
+
-
+In test results box there is a table of all exercise tests results. Columns
-- test case overall result, yes/no option
+represents these information:
+
+- test case overall result, symbol of yes/no option
 - test case name
 - percentage of correctness of this particular test
 - evaluation status, if test was successfully executed or failed
@@ -1982,16 +1984,16 @@ cases. In columns you can find these information:
   displayed
 - time limit, if supervisor allowed it then percentual time usage is displayed
 
-New feature of web application is "Comments and notes" box where you can
+A new feature of web application is "Comments and notes" box where you can
 communicate with your supervisors or just write random private notes to your
-submission. Adding note is quite simple you just write it to text field in the
+submission. Adding a note is quite simple, you just write it to text field in
-bottom of box and click on "Send" button. Note the lock image underneath, by
+the bottom of box and click on the "Send" button. The button with lock image
-click on it you can set visibility of the comment.
+underneath can switch visibility of newly created comments.
-
+
-If you think your solution is correct but ReCodEx evaluated as wrong one. You
+In case you think the ReCodEx evaluation of your solution is wrong, please use
-may consider to use comments system described above, but for now there are no
+the comments system described above, or even better notify your supervisor by
-notifications which will alert supervisors in case of new comments. So please
+another channel (email). Unfortunately there is currently no notification
-use another mechanism to contact your supervisor.
+mechanism for new comment messages.
 
 
 ## Group supervisor