Skip to content

Commit

Permalink
Add more information about Rubyric exercises
Browse files Browse the repository at this point in the history
An annotation about testing Rubyric in a local environment is added.
In addition, an implementation of a Rubyric exercise is added.
Having this exercise in the A+ manual will allow
the reader to understand better how Rubyric works in production.
  • Loading branch information
jaguarfi committed Jul 30, 2020
1 parent 57ac420 commit 8f33048
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 1 deletion.
17 changes: 17 additions & 0 deletions exercises/hello_rubyric/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

_external: true
title: Hello Rubyric
description: A simple grading example with Rubyric and Python
max_submissions: 10
max_points: 10
points_to_pass: 6
min_group_size: 1
max_group_size: 2
key: rubyric-python
lti: Rubyric
lti_context_id: ''
lti_resource_link_id: hello-world
lti_open_in_iframe: true
lti_aplus_get_and_post: true
url: /aplus_exercise

31 changes: 31 additions & 0 deletions rubyric/02_getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,22 @@ a new menu item in A+ choose Edit course and Menu and press Add new menu item.
You can also choose to use Rubyric through Haka login. In that case you don't
need to add Rubyric to menu.

.. important::

If you want to test Rubyric locally, you must read the
`Official Rubyric documentation <https://github.com/Aalto-LeTech/rubyric/blob/master/doc/rubyric.md#connect-local-rubyric-to-a-course-in-docker-optional>`_
and follow the instructions on how to use a local copy of Rubyric along with A+.
It is also important to mention that currently testing Rubyric locally can be
slightly difficult. Therefore, we recommend adding the desired `submit`
directives to the course along with the corresponding `config.yaml` file,
which should contains the configuration of the Rubyric exercise. Once you have
verified manually that all the parameters are correct, you can deploy the course
in our `testing environment <https://minus.cs.aalto.fi>`_ and only then verify that
you can configure and use Rubyric as expected.

For more information on how to deploy in our testing environment please send
an email to [email protected]

Configure course at Rubyric
---------------------------

Expand Down Expand Up @@ -196,3 +212,18 @@ delivered to Rubyric where they can be assessed.
If you want students to submit straight to Rubyric, you can provide students
with submission url which they can use. Submission url is shown at assignment
page.

Example
.......

The following example will show you how Rubyric exercises work. Please submit
your exercise and contact us through email [email protected]. We will show
you how the assignments are reviewed and how you can make use of Rubyric in your
courses.

.. submit:: rubyric 10
:config: exercises/hello_rubyric/config.yaml

.. important::

Please continue reading the whole chapter before sending us the email.
2 changes: 1 addition & 1 deletion rubyric/03_rubrics_and_reviews.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,4 @@ reviews. Feedback from all chosen reviews for the submission will be included
regardless of which you choose. Non-numerical grades, e.g. "Failed" or
"Boomerang", cannot be sent to A+. Thus non-numerical grades will be ignored
when calculating the sent points although the feedback text will still be
delivered.
delivered.

0 comments on commit 8f33048

Please sign in to comment.