| | +| 18. Click Save in bottom-right corner
| | | 19. You will be back at the list of developer keys.
| | | 20. Update State to: on
| | | 21. Copy the number in the Details column (for use in Parts 2 and 3) | | @@ -234,29 +245,49 @@ The Canvas user who carries out these steps must be a system administrator. +-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. |image1| image:: /instructors/admin/integration/CodioLTI1.3Integration.png - :width: 1500px -.. |image2| image:: /img/lti/canvasdeveloperkey.png - :width: 1500px -.. |image3| image:: /img/lti/developerkeyvalues.png - :width: 1500px -.. |image4| image:: /img/lti/canvasJWK.png - :width: 1500px -.. |image5| image:: /img/lti/canvasadvantage.png - :width: 1500px -.. |image6| image:: /img/lti/canvasplacements.png - :width: 1500px -.. |image7| image:: /img/lti/canvaslinkselect.png - :width: 1500px -.. |image8| image:: /img/lti/canvaseditorbutton.png - :width: 1500px -.. |image9| image:: /img/lti/canvasassignment.png - :width: 1500px -.. |image10| image:: /img/lti/canvasnavigation.png - :width: 1500px -.. |image11| image:: /img/lti/canvasdetails.png - :width: 1500px + .. |image1| image:: /instructors/admin/integration/CodioLTI1.3Integration.png + :alt: LTI 1.3 integration fields in Codio + :width: 1500px + + .. |image2| image:: /img/lti/canvasdeveloperkey.png + :alt: Canvas Developer Keys page + :width: 1500px + + .. |image3| image:: /img/lti/developerkeyvalues.png + :alt: Canvas LTI key configuration fields + :width: 1500px + + .. |image4| image:: /img/lti/canvasJWK.png + :alt: Canvas JWK settings + :width: 1500px + + .. |image5| image:: /img/lti/canvasadvantage.png + :alt: LTI Advantage Services toggles in Canvas + :width: 1500px + + .. |image6| image:: /img/lti/canvasplacements.png + :alt: Canvas placements configuration + :width: 1500px + + .. |image7| image:: /img/lti/canvaslinkselect.png + :alt: Canvas Link Selection placement + :width: 1500px + + .. |image8| image:: /img/lti/canvaseditorbutton.png + :alt: Canvas Editor Button placement + :width: 1500px + + .. |image9| image:: /img/lti/canvasassignment.png + :alt: Canvas Assignment Selection placement + :width: 1500px + .. |image10| image:: /img/lti/canvasnavigation.png + :alt: Canvas Course Navigation placement + :width: 1500px + + .. |image11| image:: /img/lti/canvasdetails.png + :alt: Canvas Developer Key list with details + :width: 1500px @@ -297,6 +328,7 @@ Part 3: Create an LTI configuration in Codio In Codio: ~~~~~~~~~ + +-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ | .. raw:: html | | | | | @@ -310,56 +342,69 @@ In Codio: | | | |
| |
| Updating the fields in Platform Information
| | -| Note: replace [CANVAS DOMAIN] with your institution’s | | +| Note: replace [CANVAS DOMAIN] with your institution's | | | domain in steps 5–7. Remove the brackets. Example: | | | https://yourinstitution.instructure.com/api/lti/security/jwks
| .. image:: /img/lti/canvasplatform25.png | -| 2. Platform ID: | | +| 2. Platform ID:
| | | https://canvas.instructure.com | | | | | -|
| | -|
| | -| | | +| | | +|
| | | 3. Client ID: copied from Developer Keys at end of Part 1
| | | 4. Deployment ID: copied in Part 2
| | | | | -| 5. Public Keyset URL: | | +| 5. Public Keyset URL:
| | | https://[CANVAS DOMAIN]/api/lti/security/jwks | | | | | -|
| | -|
| | -| | | -| 6. Access Token URL: | | +|
| | +| 6. Access Token URL:
| | | https://[CANVAS DOMAIN]/login/oauth2/token | | | | | -|
| | -|
| | -| | | -| 7. Authentication Request URL: | | +|
| | +| 7. Authentication Request URL:
| | | https://[CANVAS DOMAIN]/api/lti/authorize_redirect | | | | | -|
| | -|
| | -| | | +|
| | | 8. Click Create | | | | | |
| |
+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
+| .. raw:: html |
+| |
+| |
++-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
+
Part 4: Adding a resource
@@ -370,7 +415,8 @@ In Canvas:
| .. raw:: html | .. image:: /img/lti/createassignment.png |
| | |
| | | -| Note: replace [CANVAS DOMAIN] with your institution’s | | +| Note: replace [CANVAS DOMAIN] with your institution's | | | domain in steps 5–7. Remove the brackets. Example: | | | https://yourinstitution.instructure.com/api/lti/security/jwks
| .. image:: /img/lti/canvasplatform25.png | -| 2. Platform ID: | | +| 2. Platform ID:
| | | https://canvas.instructure.com | | | | | -|
| | -|
| | -| | | +| | | +|
| | | 3. Client ID: copied from Developer Keys at end of Part 1
| | | 4. Deployment ID: copied in Part 2
| | | | | -| 5. Public Keyset URL: | | +| 5. Public Keyset URL:
| | | https://[CANVAS DOMAIN]/api/lti/security/jwks | | | | | -|
| | -|
| | -| | | -| 6. Access Token URL: | | +|
| | +| 6. Access Token URL:
| | | https://[CANVAS DOMAIN]/login/oauth2/token | | | | | -|
| | -|
| | -| | | -| 7. Authentication Request URL: | | +|
| | +| 7. Authentication Request URL:
| | | https://[CANVAS DOMAIN]/api/lti/authorize_redirect | | | | | -|
| | -|
| | -| | | +|
| | | 8. Click Create | | | | | |
| |
-| 1. Go to Assignments in your course, select Assignment
. | | +| 1. Go to Assignments in your course, then click | | +| Assignment.
| | | 2. Give your assignment a name.
| | | 3. Select a number of points.
| | | 4. Under Submission Type, select External Tool.
| | diff --git a/source/instructors/admin/organization/llms.rst b/source/instructors/admin/organization/llms.rst index 4db01e59..2f4d68cc 100644 --- a/source/instructors/admin/organization/llms.rst +++ b/source/instructors/admin/organization/llms.rst @@ -3,8 +3,8 @@ .. _org_llm: -Large Language Model -==================== +Large Language Models +===================== You can add your own LLM API keys to your Codio organization to use in your :ref:`Course` from the **Organization > LLMs** page in Codio.
@@ -57,11 +57,11 @@ Examples of how to use a custom LLM provider
- name: your openai custom name (custom value)
- provider: openai (custom value)
- endpoint: https://api.openai.com
-- api key: your api key from openai
+- API key: your API key from openai
- authentication: Header
- auth template: Authorization: Bearer {{apikey}}
-- endpoint environment variable: OPENAI_CUSTOM_KEY (custom value)
-- api key environment variable: OPENAI_CUSTOM_KEY (custom value)
+- endpoint environment variable: OPENAI_CUSTOM_URL (custom value)
+- API key environment variable: OPENAI_CUSTOM_KEY (custom value)
After saving the parameters in the organization and enabling the provider in the course, run the script below in the assignment.
@@ -80,11 +80,11 @@ After saving the parameters in the organization and enabling the provider in the
- name: your gemini custom name (custom value)
- provider: gemini (custom value)
- endpoint: https://generativelanguage.googleapis.com
-- api key: your api key from gemini
+- API key: your API key from gemini
- authentication: Query param
- auth template: key={{apikey}}
- endpoint environment variable: GEMINI_CUSTOM_URL (custom value)
-- api key environment variable: GEMINI_CUSTOM_KEY (custom value)
+- API key environment variable: GEMINI_CUSTOM_KEY (custom value)
The script:
diff --git a/source/instructors/getstarted/howto.rst b/source/instructors/getstarted/howto.rst
index 4a9c9f01..34de7eaa 100644
--- a/source/instructors/getstarted/howto.rst
+++ b/source/instructors/getstarted/howto.rst
@@ -18,7 +18,7 @@ Codio Overview
.. raw:: html
-
+
@@ -29,7 +29,7 @@ Using Codio Resources
.. raw:: html
-
+
@@ -39,7 +39,7 @@ Editing Existing Guide Content
.. raw:: html
-
+
@@ -49,10 +49,18 @@ Adding Students and Test Students
.. raw:: html
-
+
+Creating a Standard Code Test in Codio
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. raw:: html
+
+
+
+
Additional Video Resources
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -89,4 +97,4 @@ Additional tutorial videos are available below to further assist with setup and
.. note::
- All videos are configured to start at the 8-second mark for optimal viewing experience.
\ No newline at end of file
+ All embedded videos start at 8 seconds and are muted by default for a consistent, accessible experience.
\ No newline at end of file
diff --git a/source/instructors/getstarted/support/support.rst b/source/instructors/getstarted/support/support.rst
index 5b665f56..b712d07e 100644
--- a/source/instructors/getstarted/support/support.rst
+++ b/source/instructors/getstarted/support/support.rst
@@ -6,16 +6,23 @@
Codio Support
=============
-If you need support, then the most effective way is to use our integrated support system. You will find this in the dashboard and the IDE.
+For support, use our integrated support system in the Dashboard and IDE.
-Dashboard
-*********
-Support is available in the dashboard by clicking on the **Help** menu item at the top and selecting **Support Chat**.
-IDE
-***
++---------------+-----------------------------------------------------------------------------------+
+| **Dashboard** | Support is available in the dashboard by clicking on the **Help** menu item at |
+| | the top and selecting **Support Chat**. |
+| | |
+| | In the Dashboard: **Help → Support Chat**. |
+| | |
++---------------+-----------------------------------------------------------------------------------+
+| **IDE** | Support is available within the IDE from the **Help** menu item, then |
+| | **Support**. |
+| | |
+| | In the IDE: **Help → Support**. |
+| | |
++---------------+-----------------------------------------------------------------------------------+
-Support is available within the IDE from the **Help** menu item, then **Support**.
Support Dialog
**************
@@ -25,42 +32,56 @@ There is a support dialog that appears when you invoke the support option. This
:alt: Intercom Start
-If you are in Codio, you can see when a reply to your query arrives even if you have closed the support dialog box
-
.. image:: /img/intercomnotification.png
- :alt: Intercom Notification
+ :alt: Intercom Notification
+ :align: right
+ :class: wrap-text
+ :scale: 50%
+
+If you are in Codio, you can see when a reply to your query arrives even if you have closed the support dialog box.
+
+If you don't see a reply within two minutes—or if you're logged out—you'll receive an email notification.
-An email will also be sent to you if you do not see the reply within 2 minutes or have logged out of your Codio account
Feedback
********
+.. image:: /img/codiofeedback.png
+ :alt: Feedback
+ :align: right
+ :class: wrap-text
+
We are always interested to hear from our users about their thoughts/ideas for future improvements. To raise an idea or vote on other ideas already raised, either select **Feedback** from the **Connect** menu at the top or go to `Codio Feedback `_ directly.
- .. image:: /img/codiofeedback.png
- :alt: Feedback
+
Community
*********
-The Codio community forum is a place for Codio users to engage with each other and share best practices. You can access it from the Connect menu or go to `Codio Community ` and/or at the course level, see :ref:`Course Contact URL ` so they can raise questions directly to your preferred area.
-If you set the contact URL for a course, this will override any contact URL you may have set at the organization level.
-Students will then be given the option to report a problem, ask a question related to their course work or access Codio support if they have a problem accessing the Codio platform.
+.. figure:: /img/manage_organization/studentoptions.png
+ :align: right
+ :width: 350px
+ :alt: Student options
- .. image:: /img/manage_organization/studentoptions.png
- :alt: Student options
+You can set a Contact URL for your students at the organization level (see :ref:`Organization Contact URL `) and/or at the course level (see :ref:`Course Contact URL `) so they can raise questions directly in your preferred channel.
+
+If you set the contact URL for a course, this will override any contact URL you may have set at the organization level.
+Students will then be given the option to report a problem, ask a question related to their coursework, or access Codio support if they have a problem accessing the Codio platform.
-**N.B. "Teacher" accounts will not be effected by this setting and they will still be able to contact Codio in the usual manner.**
+
+ .. note::
+ N.B. "Teacher" accounts will not be affected by this setting, and they will still be able to contact Codio in the usual manner.
diff --git a/student-source/students/accessing-codio/joining.rst b/student-source/students/accessing-codio/joining.rst
index fffa49bc..e5358666 100644
--- a/student-source/students/accessing-codio/joining.rst
+++ b/student-source/students/accessing-codio/joining.rst
@@ -12,7 +12,7 @@ If your school is not using an LMS platform, your instructor will provide you on
- Send you an invitation URL that you can copy and paste into your browser.
-- Send you a two-word token that you can enter on the Codio website using `Join Course `_. Enter the token and click **Next**.
+- Send you a multi-word token that you can enter on the Codio website using `Join Course `_. Enter the token and click **Next**.
.. image:: /img/joinclass.png
:alt: Join Course
. | | +| 1. Go to Assignments in your course, then click | | +| Assignment.
| | | 2. Give your assignment a name.
| | | 3. Select a number of points.
| | | 4. Under Submission Type, select External Tool.
| | diff --git a/source/instructors/admin/organization/llms.rst b/source/instructors/admin/organization/llms.rst index 4db01e59..2f4d68cc 100644 --- a/source/instructors/admin/organization/llms.rst +++ b/source/instructors/admin/organization/llms.rst @@ -3,8 +3,8 @@ .. _org_llm: -Large Language Model -==================== +Large Language Models +===================== You can add your own LLM API keys to your Codio organization to use in your :ref:`Course