Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .coderabbit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ reviews:
instructions: |
Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Anywhere there are tables, they should use `list-table`.
- Clear and concise language.
- Correct grammar and spelling.
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
Expand Down
Binary file added source/img/canvascoursecoursetselect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/guides/assessment_gb_rubric.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/guides/assessment_mc_exec.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/guides/assessment_mc_grading.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/guides/freetext-grading.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/guides/freetext_navigate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/guides/freetextanswer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/guides/freetexticon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/guides/notpartial.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/img/guides/parsonspuzzlegrading.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/guides/partial.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/img/lti-json-url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
115 changes: 89 additions & 26 deletions source/instructors/admin/integration/lti1-3Canvas.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ The Canvas user who carries out these steps must be a system administrator.
When copying links, please use the copy button adjacent to each link to ensure accuracy and prevent linking errors.



**In Codio:**

1. Click your username in the top-right corner, then select **Organization** from the menu. In the Organizations area, click the name of your organization.
Expand All @@ -39,25 +38,66 @@ The Canvas user who carries out these steps must be a system administrator.

5. Click on **Developer Key** and select **+LTI key**.

6. Complete the **Key Name, Title** and **Description** fields. Make sure to set the **method** to **Manual Entry**.
(Step 6, Option 1) Using JSON configuration Url
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

|image2|
You can use a JSON configuration URL to automatically configure most Canvas settings:

.. image:: /img/lti-json-url.png
:alt: Canvas configuration for JSON configuration Url
:width: 80%

You only need to configure:

.. list-table::
:header-rows: 1
:widths: 30 70

* - **Value**
- **What to add**
* - **Key Name:**
- A name for the Tool, i.e.: "Codio"
* - **Owner Email:**
- An email, you can use your own email.
* - **Redirect URIs:**
- Paste the Redirect URL from your Codio integration
* - Set the Method as **Enter URL**
-
* - **JSON URL**
- Paste the URL from **Canvas JSON configuration Url**

.. note::
If you use the JSON configuration URL method, skip to **Part 2**. To manually configure everything, continue with the steps below.

(Step 6, Option 2) Completing Canvas Steps Manually
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

+------+--------------------------------------------------------+-----------------------------------------------------------------------+
| | **Copy** | **Paste** |
+======+========================================================+=======================================================================+
| 7 | From Codio, under **LTI 1.3 Integration, copy the** | Paste it into the **Canvas Redirect URI** field. |
| | **Redirect URL** | |
+------+--------------------------------------------------------+-----------------------------------------------------------------------+
| 8 | Copy the **LTI URL** | Paste it into the **Target Link URI field** in Canvas. |
+------+--------------------------------------------------------+-----------------------------------------------------------------------+
| 9 | Copy the **Initiate Login URL** | Paste it into the **OpenID Connect Initiation URL**. |
+------+--------------------------------------------------------+-----------------------------------------------------------------------+
| 10 | In Canvas, change **JWK Method** to **Public JWK URL**.| |
+------+--------------------------------------------------------+-----------------------------------------------------------------------+
| 11 | From Codio, copy the **Keyset URL** | Paste it into the **Public JWK URL** field. |
+------+--------------------------------------------------------+-----------------------------------------------------------------------+
Complete the **Key Name, Title** and **Description** fields. Make sure to set the **method** to **Manual Entry**.

|image2|

.. list-table::
:header-rows: 1
:widths: 5 50 50

* -
- **Copy**
- **Paste**
* - 7
- From Codio, under **LTI 1.3 Integration, copy the Redirect URL**
- Paste it into the **Canvas Redirect URI** field.
* - 8
- Copy the **LTI URL**
- Paste it into the **Target Link URI** field in Canvas.
* - 9
- Copy the **Initiate Login URL**
- Paste it into the **OpenID Connect Initiation URL**.
* - 10
- In Canvas, change **JWK Method** to **Public JWK URL**.
-
* - 11
- From Codio, copy the **Keyset URL**
- Paste it into the **Public JWK URL** field.


|image3|
Expand Down Expand Up @@ -100,12 +140,11 @@ Link Selection and Assignment Selection
https://static-assets.codio.com/dashboard/images/icons/favicon-16x16.da14ae918fd9bc3b.png


Course Navigation and Editor Button
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Editor Button
~~~~~~~~~~~~~

.. image:: /img/canvascourseeditortselect.png
:alt: Canvas Course Navigation and Editor Button placement
:alt: Canvas Editor Button placement
:width: 750px


Expand All @@ -114,7 +153,31 @@ Course Navigation and Editor Button
.. code-tab:: text
:caption: Target Link URI

https://apollo.codio.com/lti/resource_selection
https://apollo.codio.com/lti/editor_button

.. tabs::

.. code-tab:: text
:caption: Icon URL

https://static-assets.codio.com/dashboard/images/icons/favicon-16x16.da14ae918fd9bc3b.png


Course Navigation
~~~~~~~~~~~~~~~~~


.. image:: /img/canvascoursecoursetselect.png
:alt: Canvas Course Navigation placement
:width: 750px


.. tabs::

.. code-tab:: text
:caption: Target Link URI

https://apollo.codio.com/lti/course_navigation

.. tabs::

Expand Down Expand Up @@ -223,7 +286,7 @@ Updating the fields in Platform Information
.. code-tab:: text
:caption: Platform ID

https://canvas.instructure.com
https://canvas.instructure.com



Expand All @@ -240,7 +303,7 @@ Updating the fields in Platform Information
.. code-tab:: text
:caption: Public Keyset URL

https://[CANVAS DOMAIN]/api/lti/security/jwks
https://[CANVAS DOMAIN]/api/lti/security/jwks

6. **Access Token URL:**

Expand All @@ -249,7 +312,7 @@ Updating the fields in Platform Information
.. code-tab:: text
:caption: Access Token URL

https://[CANVAS DOMAIN]/login/oauth2/token
https://[CANVAS DOMAIN]/login/oauth2/token

7. **Authentication Request URL:**

Expand All @@ -258,7 +321,7 @@ Updating the fields in Platform Information
.. code-tab:: text
:caption: Authentication Request URL

https://[CANVAS DOMAIN]/api/lti/authorize_redirect
https://[CANVAS DOMAIN]/api/lti/authorize_redirect

8. Click **Create**

Expand Down
30 changes: 13 additions & 17 deletions source/instructors/authoring/assessments/advanced-code-test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ The advanced code test assessment type allows you to easily implement unit tests
To ensure that your test scripts run securely and to prevent student access to your testing files or executables, place them in the **.guides/secure** folder. Create a folder if one does not already exist. This folder is not available to students in their assignments and they cannot access it from the command line. Only teachers with editing privileges have access to the **.guides/secure** folder.


.. Note:: If your assignment will contain multiple assessments, Code files and Test Cases for individual assessments should be placed in separate folders to avoid compiling all files.
.. note:: If your assignment will contain multiple assessments, Code files and Test Cases for individual assessments should be placed in separate folders to avoid compiling all files.


Complete each section to set up your advanced code test. For more information on **General**, **Metadata** and **Files** see :ref:`Assessments <assessments>`.
Complete each section to set up your advanced code test. For more information on **General**, **Metadata** (Optional) and **Files** (Optional) see :ref:`Assessments <assessments>`.

1. Complete **General**.

Expand All @@ -27,30 +27,26 @@ Complete each section to set up your advanced code test. For more information on
- **Python**: `pycodestyle`_ or `UnitTest`_
- **JavaScript**: `JSHint and JSLint`_

.. Note:: For more information, see the :ref:`test-types` section or click any test name above to navigate directly to that section.
.. note:: For more information, see the :ref:`test-types` section or click any test name above to navigate directly to that section.

- **Language Assessment Subtype** - Click the drop-down and choose a subtype for the selected language type, if applicable.

- **Timeout** - You can amend the timeout setting for the code to execute. Arrows will allow you to set max 300 (sec). If you require longer, you can manually enter the timeout period.

3. Click **Grading** in the top navigation pane and complete the following fields:

.. image:: /img/guides/ACTGradingScreen.png
:alt: Grading
:width: 500px

- **Points** - The score given to the student if the code test passes. You can enter any positive numeric value. If this assessment should not be graded, enter 0 points.
- **Partial Points** - Toggle to enable a percentage of total points to be given based on the percentage correctly answered. Note that it's not enough to turn partial points on; the advanced code test has to be written to handle partial points. See :ref:`Partial Points <partial-points>` for more information.
- **Define Number of Attempts** - enable to allow and set the number of attempts students can make for this assessment. If disabled, the student can make unlimited attempts.
- **Show Rationale to Students** - Toggle to display the rationale for the answer to the student. This guidance information will be shown to students after they have submitted their answer and any time they view the assignment after marking it as completed. You can set when to show this selecting from **Never**, **After x attempts**, **If score is greater than or equal to a % of the total** or **Always**
- **Rationale** - Enter guidance for the assessment. This is always visible to the teacher when the project is opened in the course or when opening the student's project.
- **Use maximum score** - Toggle to enable assessment final score to be the highest score attained of all runs.

5. **(Optional)** Complete **Metadata**.
.. image:: /img/guides/ACTGradingScreen.png
:alt: Grading
:width: 500px

6. **(Optional)** Complete **Files**.
- **Points** - The score given to the student if the code test passes. You can enter any positive numeric value. If this assessment should not be graded, enter 0 points.
- **Partial Points** - Toggle to enable a percentage of total points to be given based on the percentage correctly answered. Note that it's not enough to turn partial points on; the advanced code test has to be written to handle partial points. See :ref:`Partial Points <partial-points>` for more information.
- **Define Number of Attempts** - enable to allow and set the number of attempts students can make for this assessment. If disabled, the student can make unlimited attempts.
- **Show Rationale to Students** - Toggle to display the rationale for the answer to the student. This guidance information will be shown to students after they have submitted their answer and any time they view the assignment after marking it as completed. You can set when to show this selecting from **Never**, **After x attempts**, **If score is greater than or equal to a % of the total** or **Always**
- **Rationale** - Enter guidance for the assessment. This is always visible to the teacher when the project is opened in the course or when opening the student's project.
- **Use Maximum Score** - Toggle to enable assessment final score to be the highest score attained of all runs.

7. Click **Create** to complete the process.
4. Click **Create** to complete the process.


See a Working Example
Expand Down
Loading