User doc restruct

master
Martin Polanka 8 years ago
parent 87e4bcd39a
commit 4c4599d5de

@ -2069,7 +2069,9 @@ Supervisor, Admin
@todo: actions which are available for all users @todo: actions which are available for all users
### How to create a user account? @todo: how to solve problems with ReCodEx, first supervisors, then administrators, etc...
### First steps in ReCodEx
You can create an account if you click on the “*Create account*” menu 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 item in the left sidebar. You can choose between two types of
@ -2086,12 +2088,10 @@ and access your name and email stored in the system and create your
account based on this information. You can change your personal account based on this information. You can change your personal
information or email later on the “*Settings*” page. information or email later on the “*Settings*” page.
When crating your account both ways, you must select an instance your When creating your account both ways, you must select an instance your
account will belong to by default. The instance you will select will be account will belong to by default. The instance you will select will be
most likely your university or other organization you are a member of. most likely your university or other organization you are a member of.
### How to get into ReCodEx?
To log in, go to the homepage of ReCodEx and in the left sidebar choose 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 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 of the two forms if you selected a password during registration, then
@ -2101,7 +2101,15 @@ Authentication Service (CAS), you should put your students number and
your CAS password into the second form called “Sign into ReCodEx using your CAS password into the second form called “Sign into ReCodEx using
CAS UK”. CAS UK”.
### How do I sign out of ReCodEx? There are several options you can edit in your user account:
- changing your personal information (i.e., name)
- changing your credentials (email and password)
- updating your preferences (e.g., source code viewer/editor settings,
default language)
You can access the settings page through the “*Settings*” button right
under your name in the left sidebar.
If you dont use ReCodEx for a whole day, you will be logged out If you dont use ReCodEx for a whole day, you will be logged out
automatically. However, we recommend you sign out of the application automatically. However, we recommend you sign out of the application
@ -2110,9 +2118,7 @@ in the top section of the left sidebar right under your name. You will
have to expand the sidebar with a button next to the “*ReCodEx*” title have to expand the sidebar with a button next to the “*ReCodEx*” title
(shown in the picture below). (shown in the picture below).
@todo: Simon's image ### Forgotten password
### What to do when you cannot remember your password?
If you cant remember your password and you dont use CAS UK If you cant remember your password and you dont use CAS UK
authentication, then you can reset your password. You will find a link authentication, then you can reset your password. You will find a link
@ -2131,50 +2137,28 @@ If you sign in through CAS UK, then please follow the instructions
provided by the administrators of the service described on their provided by the administrators of the service described on their
website. website.
### How to configure your account?
There are several options you have to edit your user account.
- changing your personal information (i.e., name)
- changing your credentials (email and password)
- updating your preferences (e.g., source code viewer/editor settings,
default language)
You can access the settings page through the “*Settings*” button right
under your name in the left sidebar.
## Student ## Student
@todo: describe what it means to be a “student” and what are the @todo: describe what it means to be a “student” and what are the
students rights students rights
### How to join a group for my class? ### Join group and start solving assignments
@todo: How to join a specific group @todo: How to join a specific group
### Which assignments do I have to solve?
@todo: Where the student can find the list of the assignment he is
expected to solve, what is the first and second deadline.
### Where can I see details of my classes group?
@todo: Where can the user see groups description and details, what @todo: Where can the user see groups description and details, what
information is available. information is available.
### How to submit a solution of an assignment? @todo: Where the student can find the list of the assignment he is
expected to solve, what is the first and second deadline.
@todo: How does a student submit his solution through the web app @todo: How does a student submit his solution through the web app
### Where are the results of my solutions?
@todo: When the results are ready and what the results mean and what to @todo: When the results are ready and what the results mean and what to
do about them, when the user is convinced, that his solution is correct do about them, when the user is convinced, that his solution is correct
although the results say different although the results say different
### How can I discuss my solution with my teacher/groups supervisor directly through the web application?
@todo: Describe the comments thread behavior (public/private comments), @todo: Describe the comments thread behavior (public/private comments),
who else can see the comments, how notifications work (*not implemented who else can see the comments, how notifications work (*not implemented
yet*!). yet*!).
@ -2185,63 +2169,55 @@ yet*!).
@todo: describe what it means to be a “supervisor” of a group and what @todo: describe what it means to be a “supervisor” of a group and what
are the supervisors rights are the supervisors rights
### How do I become a supervisor of a group? ### Create groups and manage them
@todo: How does a user become a supervisor of a group? @todo: How does a user become a supervisor of a group?
### How to add or remove a student to my group?
@todo: How to add a specific student to a given group @todo: How to add a specific student to a given group
### How do I assign an exercise to my students? ### Assigning exercises
@todo: Describe how to access the database of the exercises and what are @todo: Describe how to access the database of the exercises and what are
the possibilities of assignment setup availability, deadlines, points, the possibilities of assignment setup availability, deadlines, points,
score configuration, limits score configuration, limits
### How do I configure the limits of an assignment and how to choose appropriate limits? @todo: How can I assign some exercises only to some students of the group? Describe how to achieve this using subgroups
@todo: Describe the form and explain the concept of reference solutions. ### Students' solutions management
How to evaluate the reference solutions for the exercise right now (to
get the up-to-date information).
### How can I assign some exercises only to some students of the group?
@todo: Describe how to achieve this using subgroups
### How can I see my students solutions?
@todo Describe where all the students solutions for a given assignment @todo Describe where all the students solutions for a given assignment
can be found, where to look for all solutions of a given student, how to can be found, where to look for all solutions of a given student, how to
see results of a specific students solutions evaluation result. see results of a specific students solutions evaluation result.
### Can I assign points to my students solutions manually instead of depending on automatic scoring? @todo Can I assign points to my students solutions manually instead of depending on automatic scoring? If and how to change the score of a solution assignment
@todo If and how to change the score of a solution assignment
settings, setting points, bonus points, accepting a solution (*not settings, setting points, bonus points, accepting a solution (*not
implemented yet!*). Describe how the student and supervisor will still implemented yet!*). Describe how the student and supervisor will still
be able to see the percentage received from the automatic scoring, but be able to see the percentage received from the automatic scoring, but
the awarded points will be overridden. the awarded points will be overridden.
### How can I discuss students solution with him/her directly through the web application?
@todo: Describe the comments thread behavior (public/private comments), @todo: Describe the comments thread behavior (public/private comments),
who else can see the comments -- same as from the student perspective who else can see the comments -- same as from the student perspective
### Creating exercises
@todo: how to create exercise, what has to be provided during creation, who can create exercises
@todo: Describe the form and explain the concept of reference solutions.
How to evaluate the reference solutions for the exercise right now (to
get the up-to-date information).
## Group administrator ## Group administrator
@todo: who is this? @todo: who is this?
### How do I add another supervisor to my group? ### Creating subgroups and managing supervisors
@todo: What it means to create a subgroup and how to do it.
@todo: who can add another supervisor, what would be the rights of the @todo: who can add another supervisor, what would be the rights of the
second supervisor second supervisor
### How do I create a subgroup of my group?
@todo: What it means to create a subgroup and how to do it.
## Superadministrator ## Superadministrator

Loading…
Cancel
Save