diff --git a/.coderabbit.yaml b/.coderabbit.yaml index f5bd95f1..911c3f1e 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -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). diff --git a/source/img/canvascoursecoursetselect.png b/source/img/canvascoursecoursetselect.png new file mode 100644 index 00000000..b7c5ce50 Binary files /dev/null and b/source/img/canvascoursecoursetselect.png differ diff --git a/source/img/lti-json-url.png b/source/img/lti-json-url.png new file mode 100644 index 00000000..1f7aa89f Binary files /dev/null and b/source/img/lti-json-url.png differ diff --git a/source/instructors/admin/integration/lti1-3Canvas.rst b/source/instructors/admin/integration/lti1-3Canvas.rst index 405b81df..ce2b4d03 100644 --- a/source/instructors/admin/integration/lti1-3Canvas.rst +++ b/source/instructors/admin/integration/lti1-3Canvas.rst @@ -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. @@ -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| @@ -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 @@ -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::