Skip to content

Commit 8c82817

Browse files
LolaValenteLolaValente
authored
updated lti course copy and others (#470)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Clarified LTI course copy setup with separate, version-specific instructions for LTI 1.3 and LTI 1.1 * Simplified Canvas LTI 1.3 integration configuration process * Enhanced course LLM setup documentation with improved formatting and clarity * Added documentation for teaching assistant access to LLM usage statistics and limits <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 25242e5 commit 8c82817

4 files changed

Lines changed: 84 additions & 75 deletions

File tree

‎source/img/canvasplatform25.png‎

-6.86 KB
Loading

‎source/instructors/admin/integration/lti-course-copy.rst‎

Lines changed: 53 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -3,62 +3,67 @@
33

44
.. _lti-course-copy:
55

6-
LTI Course copy
6+
7+
LTI Course Copy
78
===============
89

9-
Enabling this setting allows existing Codio course content used in your LMS to be copied into a new Codio course and a new course in your LMS. This should be enabled for the courses connected with the "Master" course in your LMS. The parameter will be disabled by default for all copied courses.
10+
Enabling this setting allows existing Codio course content used in your LMS to be copied into a new Codio course and a new course in your LMS. Enable this for courses connected to the "Master" course in your LMS. The parameter will be disabled by default for all copied courses.
11+
12+
.. note::
13+
Screenshots below show Canvas, but other LMS platforms should be similar. Refer to their documentation for more assistance.
14+
15+
.. important::
16+
Codio can automatically detect the course to copy from using LMS-provided source identifiers, removing the need to manually specify ``codio_course_target_id`` in most cases. This applies to both LTI 1.3 and LTI 1.1.
1017

11-
.. note::
12-
The screenshots below are for implementation in Canvas but other LMS systems should be similar. Refer to their documentation for more assistance.
13-
18+
- If your LMS provides ``lis_course_offering_sourcedid``, Codio will use it automatically to detect the parent course.
19+
- Codio also supports ``lis_course_section_sourcedid`` for course copy detection. If both are present, ``lis_course_offering_sourcedid`` takes priority.
20+
- Not all LMS platforms supply these identifiers. When neither is available, ``codio_course_target_id`` must be set manually.
21+
- In Canvas, if ``lis_course_offering_sourcedid`` is unavailable due to privacy settings, use the custom parameter ``custom_codio_course_offering_sourcedid=$CourseOffering.sourcedId`` as a fallback.
1422

1523

24+
LTI 1.3 Course Copy
25+
--------------------
26+
1627
First enable :ref:`LTI Constant URLs <lti-keys-and-urls-information>` for your course.
1728

29+
1. In your existing Codio course, enable **Enable LTI course copy**, save your changes.
30+
31+
.. figure:: /img/lti/enable_class_fork.png
32+
:alt: Enable course copy field
33+
34+
2. In your LMS, use "Copy this Course" (or equivalent) to create your new course.
35+
36+
3. In the new LMS course, go to settings and add a unique SIS ID (e.g. ``Fall2026``).
37+
38+
4. Open one of the new assignments in the copied LMS course. This will create the new course in Codio with content from your original course.
39+
40+
41+
LTI 1.1 Course Copy
42+
--------------------
43+
44+
First enable :ref:`LTI Constant URLs <lti-keys-and-urls-information>` for your course.
45+
46+
47+
1. In your existing Codio course, enable **Enable LTI course copy** and save your changes.
48+
49+
.. figure:: /img/lti/enable_class_fork.png
50+
:alt: Enable course copy field
51+
52+
2. Add both custom parameters to the tool in the Master course in Canvas.
53+
54+
3. In your LMS, use "Copy this Course" (or equivalent) to create your new course.
55+
56+
4. Go to **External Apps** and edit the existing app connecting Codio to your LMS.
57+
58+
.. figure:: /img/lti/copy_course.png
59+
:alt: Copy LMS Course
1860

61+
5. Replace the existing custom field with a unique ID of your own (e.g. ``codio_course_target_id=semester-year``).
1962

63+
.. figure:: /img/lti/parent_class.png
64+
:width: 400
65+
:alt: Parent course ID
2066

21-
+-----------------------------------------------+------------------------------------------------------------------------------+
22-
| 1. In your existing Codio course, enable | .. figure:: /img/lti/enable_class_fork.png |
23-
| the **Enable LTI course copy** button, | :alt: Enable course copy field |
24-
| and save your changes. | |
25-
| | |
26-
| | | |
27-
| | |
28-
| 2. Both custom parameters should be added to | |
29-
| the tool in the Master course in Canvas. | |
30-
| | |
31-
| | | |
32-
| | |
33-
| 3. In your LMS "Copy this Course" (or | |
34-
| equivalent term for your LMS) and | |
35-
| create your new course. | |
36-
+-----------------------------------------------+------------------------------------------------------------------------------+
37-
| 4. When completed go to **External Apps** | .. figure:: /img/lti/copy_course.png |
38-
| and edit the existing app connecting | :alt: Copy LMS Course |
39-
| Codio to your LMS. | |
40-
| | |
41-
| | | |
42-
| | |
43-
| 5. Replace the existing custom field that | |
44-
| was set from your original Codio course | |
45-
| with an id of your own (e.g similar to | |
46-
| codio_course_target_id=semester-year) | |
47-
| | |
48-
| | | |
49-
| | |
50-
| 6. Submit | .. figure:: /img/lti/parent_class.png |
51-
| | :width: 400 |
52-
| | | :alt: Parent course ID |
53-
| | |
54-
| 7. In the new course created in your LMS, | |
55-
| open one of the new assignments and this | |
56-
| will then create the new course in Codio | |
57-
| containing the content from your original | |
58-
| Codio course. | |
59-
+-----------------------------------------------+------------------------------------------------------------------------------+
60-
61-
62-
.. note::
63-
If your LMS supports ``lis_course_offering_sourcedid`` you do not need to specify ``codio_course_target_id`` for the copied course, ``lis_course_offering_sourcedid`` will be used automatically to detect the course. For cases when ``lis_course_offering_sourcedid`` is needed for course copy but not available due to privacy settings in Canvas, a custom parameter ``custom_codio_course_offering_sourcedid=$CourseOffering.sourcedId`` can be tried.
67+
6. Submit.
6468

69+
7. Open one of the new assignments in the copied LMS course. This will create the new course in Codio with content from your original course.

‎source/instructors/admin/integration/lti1-3Canvas.rst‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -254,14 +254,6 @@ In Canvas:
254254

255255
5. **Submit → Install**
256256

257-
.. image:: /img/canvasdeployment.png
258-
:width: 450px
259-
260-
6. After you click install, click the gear icon by the tool you just created
261-
262-
7. Select **Deployment ID**
263-
264-
8. Copy the ID displayed, it will be used in Part 3
265257

266258

267259

@@ -304,7 +296,7 @@ Updating the fields in Platform Information
304296

305297
3. **Client ID:** copied from Developer Keys at end of Part 1
306298

307-
4. **Deployment ID:** copied in Part 2
299+
4. **Deployment ID:** leave blank
308300

309301
5. **Public Keyset URL:**
310302

‎source/instructors/setupcourses/course-llm.rst‎

Lines changed: 30 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,52 @@
44

55
.. _course_llm:
66

7+
78
Large Language Model
89
====================
910

10-
Once :ref:`LLM API keys <org_llm>` have been added to your account, the course can use the created keys
11-
.. image:: /img/llm_course_settings.png
12-
:alt: LLMs Course settings
11+
Once :ref:`LLM API keys <org_llm>` have been added to your account, the course can use the created keys.
12+
13+
.. image:: /img/llm_course_settings.png
14+
:alt: LLMs Course settings
1315

14-
When enabled you can set limits for the students in the course.
16+
When enabled, you can set limits for the students in the course.
1517

1618

1719
Reset LLM Keys
18-
**************
20+
--------------
1921

20-
.. image:: /img/llm_course_reset.png
21-
:alt: LLMs Course Reset
22+
.. image:: /img/llm_course_reset.png
23+
:alt: LLMs Course Reset
2224

23-
If students exceed any of the limits set above, they will show in the **Reset LLM Keys** area and the teacher/instructors can reset the keys for them to continue working.
25+
If students exceed any of the limits set above, they will appear in the **Reset LLM Keys** area where instructors can reset their keys to allow them to continue working.
2426

25-
If a student exceeds more than one limit at same time, they will only show once and reetting will reset them for all exceeded limits.
27+
If a student exceeds more than one limit at the same time, they will only appear once and resetting will apply to all exceeded limits.
2628

27-
.. Note:: Students WILL need to restart their box after limits are reset (**Project>Restart Box**). If the top menu has been hidden for students then instructors will need to restart their box for them. Open the student assignment and select **Project>Restart Box** before letting the student know they can continue.
29+
.. note::
30+
Students will need to restart their box after limits are reset (**Project > Restart Box**). If the top menu has been hidden for students, instructors will need to do this for them by opening the student assignment and selecting **Project > Restart Box** before letting the student know they can continue.
2831

29-
LLM Course Usage
30-
*****************
3132

32-
.. image:: /img/llm_course_usage.png
33-
:alt: LLMs Course Usage
33+
LLM Course Usage
34+
----------------
3435

35-
.. Note:: The names showing in this screenshot are example names.
36+
.. image:: /img/llm_course_usage.png
37+
:alt: LLMs Course Usage
3638

37-
Usage will be shown for:
39+
.. note::
40+
The names shown in this screenshot are examples only. The values shown are estimates and may not reflect exact numbers.
3841

42+
Usage is shown for:
3943

40-
- Daily, weekly, monthly, annual, total usage for that course.
44+
- Daily, weekly, monthly, annual, and total usage for the course.
4145
- Daily and monthly top 10 consumers for the course.
4246

43-
.. Note:: The values shown are estimates and may not reflect the exact numbers.
47+
48+
TA Access to LLM Statistics and Limits
49+
---------------------------------------
50+
51+
Teaching Assistants (TAs) can view LLM usage statistics and reset LLM limits for individual students in the same way as teachers and instructors.
52+
53+
If no usage data has been recorded yet, the following message will be displayed:
54+
55+
*There is currently no LLM usage data available for this course.*

0 commit comments

Comments
 (0)