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
2 changes: 1 addition & 1 deletion source/common/develop/ide/editing/connect-github-codio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ To manually import a Git repo into Codio, follow these steps:
.. figure:: /img/github-clone-url.png
:alt: create from GitHub

If you are cloning using SSH, you must have already added the Codio SSH public key as described in :ref:`Upload SSH Key to Remote Server <upload-ssh-key-remote-server>`.
If you are cloning using SSH, you must have already added the Codio SSH public key as described in :ref:`SSH Key <ssh-key>`.

2. Create a :ref:`new project <create-import-project>` or :ref:`add an assignment <add-remove-assignment>` to a course.

Expand Down
30 changes: 13 additions & 17 deletions source/common/develop/ide/editing/git.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,9 @@ To manually import a Git repo into Codio, follow these steps:



.. raw:: html

<div style="margin: 0 0 10px 20px; padding: 10px; background: #f0f0f0; border: 3px solid #00ece5;">
<strong>Note:</strong> If you are cloning using SSH, you must have already added the Codio SSH public key as described in <a href="https://docs.codio.com/common/settings/upload-ssh-key-remote-server.html#upload-ssh-key-remote-server">Upload SSH Key to Remote Server</a>.
</div>
.. note::
If you are cloning using SSH, you must have already added the Codio SSH public key as described in :ref:`SSH Key <ssh-key>`.


Create New GitHub Repo From Codio
---------------------------------
Expand All @@ -89,15 +87,15 @@ If you have code in Codio and want to create a new GitHub (or other remote) repo

1. Create a new project in Codio or open up an existing project.
2. Open the terminal (**Tools > Terminal**), type **git init** and press **Enter** to initialize Git.
3. Create a new, empty repo on GitHub or other remote repo.
4. Copy the repo url to the clipboard.


.. raw:: html

<div style="float: right; width: 350px; margin: 0 0 10px 20px; padding: 10px; background: #f0f0f0; border: 3px solid #00ece5;">
<strong>Note:</strong> If you're using GitHub, use the <strong>SSH url</strong> rather than <strong>https</strong>. Also make sure that your Codio public key is uploaded to your GitHub account or repo settings as described in <a href="https://docs.codio.com/common/settings/upload-ssh-key-remote-server.html#upload-ssh-key-remote-server">Upload SSH Key to Remote Server</a>.
</div>
.. container:: float-right

.. note::
If you're using GitHub, use the **SSH url** rather than **https**. Also make sure that your Codio public key is uploaded to your GitHub account or repo settings as described in :ref:`SSH Key <ssh-key>`.

3. Create a new, empty repo on GitHub or other remote repo.
4. Copy the repo url to the clipboard.
5. In the Codio IDE, click **Tools > Git > Remotes** on the menu.
6. Click the **Edit** icon and enter the **Name** and paste the **URL** into the field. It is recommended you use **origin** as the name to confirm the normal standards. You do not need to specify a username or password if you are using SSH.
7. Click **Save**.
Expand All @@ -108,8 +106,6 @@ Github Commands

GitHub functions normally within Codio, giving you access to all the standard Git commands and GitHub features you're familiar with.

.. raw:: html

<div style="margin: 0 0 10px 20px; padding: 10px; background: #f0f0f0; border: 3px solid #00ece5;">
<strong>Note:</strong> The Guides folder is automatically included in your project, unless you manually remove it</a>.
</div>
.. note::
The Guides folder is automatically included in your project, unless you manually remove it.

Binary file modified source/img/common-cartridge.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/google_integrate.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/lti/LMS-Unit-URL.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/lti/LTIenrolllink.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/lti/LTIintegrationinfo.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/lti/codiolti13settings.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/lti/codioplatformlti1-3.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/lti/enable-lti-new.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/lti/enable-lti.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/lti/enable_class_fork.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/lti/parent_class.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 15 additions & 19 deletions source/instructors/admin/integration/lms-students.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,42 +10,37 @@ When integrating with an external system, you don't need to manually :ref:`add o

Understanding how Codio maps external system users to Codio users is important. Here are the key mapping rules:

.. raw:: html

<div style="float: right; width: 350px; margin: 0 0 10px 20px; padding: 10px; background: #f0f0f0; border: 3px solid #00ece5;">
<strong>Note:</strong> Anonymous students (with no email associated) can access Codio through an LMS. This must be set up within the LMS.
</div>
.. container:: float-right

.. note::
Anonymous students (with no email associated) can access Codio through an LMS. This must be set up within the LMS.


- If students or faculty access Codio via an LMS assignment then Codio will initially use the LMS email address to identify the user and create the Codio account.

- In all subsequent access, the userID will be used so in the event the user changes their email address in the LMS, the user will be mapped to the same Codio account.

- If the user is not known to Codio then we will sign up the user as a new Codio user in the background and take the user directly into the Codio content. The LMS user role will be carried over as well.

.. raw:: html

<div style="float: right; width: 350px; margin: 0 0 10px 20px; padding: 10px; background: #f0f0f0; border: 3px solid #00ece5;">
<strong>Note:</strong> The users LMS password is not passed to Codio so if the user may wish to log into Codio directly in the future, they will need to create a <a href="#password">password</a> for their Codio account (and of course it is always recommended that the same passwords are not used in different applications).
</div>
.. container:: float-right

- If the user is known to Codio then Codio will take them directly into the Codio content without any sign-in required. If they are a Codio user but are not a member of your organization then they will be required to complete a verification via email.
.. note::
The user's LMS password is not passed to Codio so if the user wishes to log in to Codio directly in the future, they will need to create a password for their Codio account (and of course it is always recommended that the same passwords are not used in different applications).

- If a student joins Codio from an LMS a new Codio account will be created even if the student already has a Codio account using the same email address where we do not have a userID + LMS system id.

.. raw:: html
- If the user is known to Codio then Codio will take them directly into the Codio content without any sign-in required. If they are a Codio user but are not a member of your organization then they will be required to complete a verification via email.

<div style="float: right; width: 350px; margin: 0 0 10px 20px; padding: 10px; background: #f0f0f0; border: 3px solid #00ece5;">
<strong>Note:</strong> If you need to reset your password, you can use your username instead of your email address. Alternatively, you can contact your course instructor, who can assist with <a href="https://docs.codio.com/instructors/teaching/resetpassword.html#reset-pass">resetting the password</a>.
</div>
- If a student joins Codio from an LMS a new Codio account will be created even if the student already has a Codio account using the same email address where we do not have a userID + LMS system id.

- After successful mapping of an user's LMS account to their Codio account, if the user has changed their details such as name or email in their LMS account, Codio will automatically update those details the next time the user accesses Codio from their LMS. Codio will not update the email if another user with the same email already exists.

.. raw:: html

<div style="margin: 0 0 10px 20px; padding: 10px; background: #f0f0f0; border: 3px solid #00ece5;">
<strong>Note:</strong> If your organization is in trial mode, student accounts will not be created via LTI integration. Ensure your organization has an active subscription to allow student enrollments.
</div>
.. note::
If you need to reset your password, you can use your username instead of your email address. Alternatively, you can contact your course instructor, who can assist with :ref:`resetting the password <reset-pass>`.

Student accounts are **not** created via LTI integration while an organization is in trial mode. Activate a subscription to enable student enrolments.

Teacher Roles
~~~~~~~~~~~~~
Expand All @@ -68,4 +63,5 @@ If you wish to only allow Mentors to view/manage specific students in the course
LTI Field to Uniquely Identify Students
---------------------------------------

This is a unique identifier for students found in a custom LTI field. This field is automatically added to the CSV export data files, enabling you to map results manually if necessary. You can adjust this option in the **LTI Integrations** section of your Organization Settings.
This is a unique identifier for students found in a custom LTI field. This field is automatically added to the CSV export data files, enabling you to map results manually if necessary. You can adjust this option in the **LTI Integrations** section of your Organization Settings.

19 changes: 11 additions & 8 deletions source/instructors/admin/integration/lms-systems/canvas.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ Integrating with Canvas using LTI App

The **Codio LTI App** method allows for an easy way to integrate and to map Codio course assignments to Canvas. Access the directions at :ref:`LTI App(LTI 1.1 Only) <lti-app>` page. If you are not able to use the LTI App, follow the manual integration directions below.

.. Note:: Configuring your LTI settings using the LTI App is only for the US version of Codio. It will not work with Codio UK (codio.co.uk).
.. Note:: The LTI App configuration works **only** with the US instance of Codio (`codio.com`) and is not supported on Codio UK (`codio.co.uk`).


Integrating with Canvas Manually
--------------------------------
Expand All @@ -32,9 +33,10 @@ Enable LTI for Your Course
| :ref:`Add and Remove Course Assignments | |
| <add-remove-assignment>`) | |
| | |
| 3. Select the **LTI/LMS** tab. | |
| 3. In the left-hand **Admin** menu, open the | |
| **LTI/LMS** section. | |
| | |
| 4. Select the **ENABLE LTI** option. | |
| 4. Toggle **ENABLE LTI** on. | |
| | |
| 5. Click **Save Changes**. | |
+---------------------------------------------------+-----------------------------------------------------------------------------------------+
Expand All @@ -46,13 +48,14 @@ Bring up the LTI Integration Information
| | .. image:: /img/lti/LTIintegrationinfo.png |
| | :alt: Org LTI info |
| | |
| 6. Click your user name in the bottom left of | |
| your dashboard | |
| 6. Click your **username** in the top-right corner| |
| and choose **Organization**. | |
| | |
| 7. Choose your Organization | |
| 7. In **Organizations**, select your | |
| organization’s name. | |
| | |
| 8. Click the **LTI Integrations** tab to bring | |
| up the following settings. | |
| 8. In the left panel, open **LTI Integrations** | |
| to view the settings. | |
+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------+


Expand Down
27 changes: 5 additions & 22 deletions source/instructors/admin/integration/lms-systems/moodle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,9 @@ Please be sure to check out the :ref:`Codio LTI App <lti-app>` which allows for
Setup and Configuration
------------------------

.. raw:: html

<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Important Notice</title>
</head>
<body style="font-family: Arial, sans-serif; padding: 20px;">
<div style="margin: 0 0 10px 20px; padding: 10px; background: #ffffff; border: 5px solid #2baeff;">
<div style="background: #e6f5ff; padding: 5px 8px; margin: -10px -10px 8px -10px; border-radius: 2px;">
<span style="color: #2baeff; font-weight: bold;">!</span> <strong>Important</strong>
</div>
Codio needs the User Role, Email Address and Name of the Moodle user in order to work. It is important that you access the LTI security settings and ensure that these three fields are enabled. If they are not available, contact Moodle support who can help you enable this. If enabled after you have mapped Codio content to Moodle, you may need to re publish for the changes to be implemented.
</div>
</body>
</html>

.. important::
Codio needs the User Role, Email Address and Name of the Moodle user in order to work. It is important that you access the LTI security settings and ensure that these three fields are enabled. If they are not available, contact Moodle support who can help you enable this. If enabled after you have mapped Codio content to Moodle, you may need to re publish for the changes to be implemented.

**Video: Connect Moodle to Codio using the LTI Integration URL**

Expand All @@ -48,11 +33,9 @@ Then in the Moodle course you have created:
- Proceed through the steps.


.. raw:: html

<div style= " margin: 0 0 10px 20px; padding: 10px; background: #f0f0f0; border: 3px solid #00ece5;">
<strong>Note:</strong> Restore is required as Moodle currently does not support importing of <strong>.imscc </strong> files.
</div>
.. note::
Restore is required as Moodle currently does not support importing of **.imscc** files.



To confirm your setup, just click on any assignment available in Moodle. If all configurations are correct, you will be redirected straight to the Teacher view of that assignment in Codio.
Expand Down
36 changes: 27 additions & 9 deletions source/instructors/admin/integration/lms-systems/schoology.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,44 @@ In Codio

The Schoology system administrator should install a Codio external tool for the course so that it is quick and easy for instructors to add material. The Schoology system administrator should follow these directions to install Codio as an external tool:

.. image:: /img/lti/enable-lti-new.png
:alt: enable lti and urls
:width: 400px
:align: right

1. Open the course you would like to connect or create a new course.
2. Make sure you have at least one published assignment or add a new one. (see :ref:`Add and Remove Course Assignments <add-remove-assignment>`)
3. Select the **LTI/LMS** tab.
4. Select the **ENABLE LTI** option.
5. Select the **ENABLE LTI CONSTANT URLS** option.
4. Toggle **ENABLE LTI** on.
5. Toggle **ENABLE LTI CONSTANT URLS** on.
6. Note the **Codio Course Target ID**, you will need that in subsequent steps.
7. Click **Save**.

.. image:: /img/lti/enable-lti-new.png
:alt: enable lti and urls
|
|
|

Bring up the LTI Integration Information
----------------------------------------

8. Click your user name in the bottom left of your dashboard.
9. Select your Organization.
.. image:: /img/lti/LTIintegrationinfo.png
:alt: Org LTI info
:width: 375px
:align: right

|
|
|

8. Click your username in the top-right corner, then select **Organizations** from the menu.
9. In the **Organizations** area, click the name of your organization.
10. Click the **LTI Integrations** tab to bring up the following settings. You will need to enter these into Schoology in the subsequent steps.

.. image:: /img/lti/LTIintegrationinfo.png
:alt: Org LTI info
|
|
|
|
|

In Schoology
~~~~~~~~~~~~
Expand Down Expand Up @@ -81,7 +99,7 @@ In Codio
~~~~~~~~

21. Navigate to the course you would like to integrate with Schoology and go to the **Overview** area.
22. Click the icon with 3 blue dots for each assignment you wish to map and select **LTI Integration URL.** Select the clipboard to copy the link.
22. Click the 3 vertical dots to the right of the assignment for each assignment you wish to map and select **LTI Integration URL.** Select the clipboard to copy the link.

.. figure:: /img/lti/LMS-Unit-URL.png
:alt: Unit URL
Expand Down
Loading