diff --git a/assets/images/help/classroom/canvas-sync-roster.png b/assets/images/help/classroom/canvas-sync-roster.png new file mode 100644 index 0000000000..67594c7a8e Binary files /dev/null and b/assets/images/help/classroom/canvas-sync-roster.png differ diff --git a/assets/images/help/classroom/classroom-settings-click-google-classroom.png b/assets/images/help/classroom/classroom-settings-click-google-classroom.png index f43d23817c..ce8bf4dbc6 100644 Binary files a/assets/images/help/classroom/classroom-settings-click-google-classroom.png and b/assets/images/help/classroom/classroom-settings-click-google-classroom.png differ diff --git a/assets/images/help/classroom/import-from-connected-lms.png b/assets/images/help/classroom/import-from-connected-lms.png new file mode 100644 index 0000000000..bfdb974b2d Binary files /dev/null and b/assets/images/help/classroom/import-from-connected-lms.png differ diff --git a/assets/images/help/classroom/moodle-sync-roster.png b/assets/images/help/classroom/moodle-sync-roster.png new file mode 100644 index 0000000000..a62d8e23b6 Binary files /dev/null and b/assets/images/help/classroom/moodle-sync-roster.png differ diff --git a/assets/images/help/classroom/register-canvas-with-github-classroom.png b/assets/images/help/classroom/register-canvas-with-github-classroom.png new file mode 100644 index 0000000000..2b8242db69 Binary files /dev/null and b/assets/images/help/classroom/register-canvas-with-github-classroom.png differ diff --git a/assets/images/help/classroom/register-moodle-with-github-classroom.png b/assets/images/help/classroom/register-moodle-with-github-classroom.png new file mode 100644 index 0000000000..59e6b7d3ed Binary files /dev/null and b/assets/images/help/classroom/register-moodle-with-github-classroom.png differ diff --git a/assets/images/help/classroom/register-sakai-with-github-classroom.png b/assets/images/help/classroom/register-sakai-with-github-classroom.png new file mode 100644 index 0000000000..b0720fab42 Binary files /dev/null and b/assets/images/help/classroom/register-sakai-with-github-classroom.png differ diff --git a/assets/images/help/classroom/sakai-sync-roster.png b/assets/images/help/classroom/sakai-sync-roster.png new file mode 100644 index 0000000000..087d6521e1 Binary files /dev/null and b/assets/images/help/classroom/sakai-sync-roster.png differ diff --git a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md b/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md index 68f7ecbc53..7dbe7adf3d 100644 --- a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md +++ b/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md @@ -44,7 +44,7 @@ An identifier in {% data variables.product.prodname_classroom %} is a unique ID ## roster -A roster allows a teacher to manage students and assignment submissions in a classroom on {% data variables.product.prodname_classroom %}. Teachers can create a roster by entering a list of student identifiers, or by connecting {% data variables.product.prodname_classroom %} to a learning management system (LMS). For more information about identifiers, see the definition of "[identifier](#identifier)." For more information about connecting {% data variables.product.prodname_classroom %} to an LMS, see "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)." +A roster allows a teacher to manage students and assignment submissions in a classroom on {% data variables.product.prodname_classroom %}. Teachers can create a roster by entering a list of student identifiers, or by connecting {% data variables.product.prodname_classroom %} to a learning management system (LMS). For more information about identifiers, see the definition of "[identifier](#identifier)." For more information about connecting {% data variables.product.prodname_classroom %} to an LMS, see "[Connect a learning management system course to a classroom](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)." --- diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md new file mode 100644 index 0000000000..2e3140ded0 --- /dev/null +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md @@ -0,0 +1,124 @@ +--- +title: Connect a learning management system course to a classroom +intro: 'You can configure an LTI-compliant learning management system (LMS) course to connect to {% data variables.product.prodname_classroom %} so that you can import a roster for your classroom.' +versions: + fpt: '*' +permissions: 'Organization owners who are admins for a classroom can connect learning management systems to {% data variables.product.prodname_classroom %}. {% data reusables.classroom.classroom-admins-link %}' +redirect_from: + - /education/manage-coursework-with-github-classroom/configuring-a-learning-management-system-for-github-classroom + - /education/manage-coursework-with-github-classroom/connect-to-lms + - /education/manage-coursework-with-github-classroom/generate-lms-credentials + - /education/manage-coursework-with-github-classroom/setup-canvas + - /education/manage-coursework-with-github-classroom/setup-generic-lms + - /education/manage-coursework-with-github-classroom/setup-moodle + - /education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom +shortTitle: Connect an LMS course +--- +## About connecting an LMS to your classroom + +You can connect a learning management system (LMS) to {% data variables.product.prodname_classroom %} and import a roster of student identifiers from the LMS. + +## Prerequisites + +Before you can connect your LMS to a classroom, an administrator for your LMS instance needs to register your LMS with GitHub Classroom to initiate the OAuth handshake. An admin only needs to do this registration process once, then any teacher who uses their LMS instance may sync their LMS courses to classrooms. For more information, see "[Register a learning management system with GitHub Classroom](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom)." + +{% note %} + +**Note:** {% data reusables.classroom.google-classroom-note %} + +{% endnote %} + +To configure an LMS to connect to {% data variables.product.prodname_classroom %}, you must first create a classroom. For more information, see "[Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-classroom)." + +## Supported LMSes + +{% data reusables.classroom.supported-lmses %} + +## Linking a Canvas course with a classroom + +You can link your Moodle course with a classroom in {% data variables.product.prodname_classroom %}. For more information about Canvas, see the [Canvas website](https://www.instructure.com/canvas/). + +An administrator needs to register your LMS instance with classroom before you can link an LMS course. For more information, see "[Configuring Canvas for {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom#configuring-canvas-for-github-classroom)." + +1. Sign into [Canvas](https://www.instructure.com/canvas/#login). +1. Select the Canvas course to integrate with {% data variables.product.prodname_classroom %}. +2. Click "Settings" in the left sidebar, then click the "Apps" tab. +3. Click the **+ App** button. +4. Under "Configuration Type", select **By Client ID** from the dropdown menu. +5. Under "Client ID", input the Client ID that your LMS administrator created when registering your LMS instance with {% data variables.product.prodname_classroom %}. +6. Click **Submit**, then click **Install**. +7. Refresh the page, and you should see a **GitHub Classroom** link in the course sub-navigation menu on the right hand side of the course details page. Note that the name may be different if your LMS admin named it something else when registering your LMS. +8. Clicking the **GitHub Classroom** link will launch you into {% data variables.product.prodname_classroom %}, where you can select a classroom to link with your LMS course. + +Once your course is linked, you can import your roster from your LMS course to your classroom. For more information, see "[Importing a roster from your LMS](#importing-a-roster-from-your-lms)." +## Linking a Moodle course with a classroom + +You can link your Moodle course with a classroom in {% data variables.product.prodname_classroom %}. For more information about Moodle, see the [Moodle website](https://moodle.org). + +An administrator needs to register your LMS instance with classroom before you can link an LMS course. For more information, see "[Configuring Moodle for {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom#configuring-moodle-for-github-classroom)." + +You must be using Moodle version 3.0 or greater. + +1. Sign into [Moodle](https://moodle.org/login/). +1. Select the Moodle course to integrate with {% data variables.product.prodname_classroom %}. +2. Under "External Tools, under "General", you should see a button with the name "GitHub Classroom". Note that the name may be different if your LMS admin named it something else when registering your LMS. +3. Clicking the **GitHub Classroom** button will launch you into {% data variables.product.prodname_classroom %}, where you can select a classroom to link with your LMS course. + +Once your course is linked, you can import your roster from your LMS course to your classroom. For more information, see "[Importing a roster from your LMS](#importing-a-roster-from-your-lms)." +## Linking a Sakai course with a classroom + +You can link your Sakai course with a classroom in {% data variables.product.prodname_classroom %}. For more information about Sakai, see the [Sakai website](https://www.sakailms.org/). + +An administrator needs to register your LMS instance with classroom before you can link an LMS course. For more information, see "[Configuring Moodle for {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom#configuring-moodle-for-github-classroom)." + +1. Sign into your Sakai instance. +2. Select the Sakai course to integrate with {% data variables.product.prodname_classroom %}. +3. Click on **External Tools**. +4. Click on **Tool Links**. +5. Clicking the "GitHub Classroom" link will launch you into {% data variables.product.prodname_classroom %}, where you can select a classroom to link with your LMS course. + +Once your course is linked, you can import your roster from your LMS course to your classroom. For more information, see "[Importing a roster from your LMS](#importing-a-roster-from-your-lms)." + + +## Importing a roster from your LMS + +To import your roster from your LMS: +1. Open your linked classroom in {% data variables.product.prodname_classroom %} and select the "Students" tab. +2. Click the **Import from...** button containing the name of your LMS (Canvas, Sakai, or Moodle). + + ![Import from Canvas button](/assets/images/help/classroom/import-from-connected-lms.png) + +3. Select which identifier you'd like to use for your students, then click **Import roster entries**, and your roster will be imported. + +To update an existing roster: + 1. Open your linked classroom in {% data variables.product.prodname_classroom %} and select the "Students" tab. + 2. Click the **Sync from...** button containing the name of your LMS (Canvas, Sakai, or Moodle). + +![Sync from Moodle button](/assets/images/help/classroom/moodle-sync-roster.png) + +## Importing a roster from Google Classroom + +Google Classroom does not use the LTI protocol so does not need to be connected to GitHub Classroom before importing the roster. + +{% data reusables.classroom.sign-into-github-classroom %} +{% data reusables.classroom.click-classroom-in-list %} +{% data reusables.classroom.click-students %} +1. If your classroom already has a roster, you can either update the roster or delete the roster and create a new roster. + - For more information about deleting and creating a roster, see "[Deleting a roster for a classroom](/education/manage-coursework-with-github-classroom/manage-classrooms#deleting-a-roster-for-a-classroom)" and "[Creating a roster for your classroom](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." + - For more information about updating a roster, see "[Adding students to the roster for your classroom](/education/manage-coursework-with-github-classroom/manage-classrooms#adding-students-to-the-roster-for-your-classroom)." +1. In the list of LMSes, click **Google Classroom**. + !["Google Classroom" button](/assets/images/help/classroom/classroom-settings-click-google-classroom.png) +1. Sign in to Google, then select the Classroom to link to. + +## Disconnecting your LMS + +You can disconnect your classroom from your LMS in {% data variables.product.prodname_classroom %} settings. + +{% data reusables.classroom.sign-into-github-classroom %} +{% data reusables.classroom.click-classroom-in-list %} +{% data reusables.classroom.click-settings %} +1. Under "Connect to a learning management system (LMS)", click **Connection Settings**. + !["Connection settings" link in classroom settings](/assets/images/help/classroom/classroom-settings-click-connection-settings.png) +1. Under "Delete Connection to your learning management system", click **Disconnect from your learning management system**. + !["Disconnect from your learning management system" button in connection settings for classroom](/assets/images/help/classroom/classroom-settings-click-disconnect-from-your-lms-button.png) diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md deleted file mode 100644 index 1b80c3756a..0000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Connect a learning management system to GitHub Classroom -intro: 'You can configure an LTI-compliant learning management system (LMS) to connect to {% data variables.product.prodname_classroom %} so that you can import a roster for your classroom.' -versions: - fpt: '*' -permissions: 'Organization owners who are admins for a classroom can connect learning management systems to {% data variables.product.prodname_classroom %}. {% data reusables.classroom.classroom-admins-link %}' -redirect_from: - - /education/manage-coursework-with-github-classroom/configuring-a-learning-management-system-for-github-classroom - - /education/manage-coursework-with-github-classroom/connect-to-lms - - /education/manage-coursework-with-github-classroom/generate-lms-credentials - - /education/manage-coursework-with-github-classroom/setup-canvas - - /education/manage-coursework-with-github-classroom/setup-generic-lms - - /education/manage-coursework-with-github-classroom/setup-moodle - - /education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom -shortTitle: Connect an LMS ---- -## About configuration of your LMS - -You can connect a learning management system (LMS) to {% data variables.product.prodname_classroom %}, and {% data variables.product.prodname_classroom %} can import a roster of student identifiers from the LMS. To connect your LMS to {% data variables.product.prodname_classroom %}, you must enter configuration credentials for {% data variables.product.prodname_classroom %} in your LMS. - -## Prerequisites - -To configure an LMS to connect to {% data variables.product.prodname_classroom %}, you must first create a classroom. For more information, see "[Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-classroom)." - -## Supported LMSes - -{% note %} - -**Note:** {% data variables.product.prodname_classroom %} previously supported import of roster data from LMSes that implement Learning Tools Interoperability (LTI) versions 1.0 and 1.1. On June 30, 2022, the Instructional Management System (IMS) Global Learning Consortium [ended support for LTI versions 1.0 and 1.1](https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule). In the interest of keeping sensitive student information safe and secure, {% data variables.product.company_short %} has temporarily disabled importing roster data from LTI-compliant LMSes.

- -Support for the latest version of Learning Tools Interoperability, [LTI 1.3](https://www.imsglobal.org/activity/learning-tools-interoperability), is currently being worked on and will be made available in {% data variables.product.prodname_classroom %} very soon. - -{% endnote %} - -LTI is an industry-standard protocol and GitHub Classroom's use of LTI is certified by the Instructional Management System (IMS) Global Learning Consortium. For more information, see [Learning Tools Interoperability](https://www.imsglobal.org/activity/learning-tools-interoperability) and [About IMS Global Learning Consortium](http://www.imsglobal.org/aboutims.html) on the IMS Global Learning Consortium website. - -{% data variables.product.company_short %} has tested import of roster data from the following LMSes into {% data variables.product.prodname_classroom %}. - -- Google Classroom - - -## Connecting to Google Classroom - -{% data reusables.classroom.sign-into-github-classroom %} -{% data reusables.classroom.click-classroom-in-list %} -{% data reusables.classroom.click-students %} -1. If your classroom already has a roster, you can either update the roster or delete the roster and create a new roster. - - For more information about deleting and creating a roster, see "[Deleting a roster for a classroom](/education/manage-coursework-with-github-classroom/manage-classrooms#deleting-a-roster-for-a-classroom)" and "[Creating a roster for your classroom](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." - - For more information about updating a roster, see "[Adding students to the roster for your classroom](/education/manage-coursework-with-github-classroom/manage-classrooms#adding-students-to-the-roster-for-your-classroom)." -1. In the list of LMSes, click Google Classroom. - ![Google Classroom](/assets/images/help/classroom/classroom-settings-click-google-classroom.png) -1. Sign in to Google, then select the Classroom to link to. - - -## Connecting to Canvas, Moodle, Sakai, and other LMSes - -Connecting to other LMSes is temporarily unavailable as {% data variables.product.company_short %} updates to Learning Tools Interoperability (LTI) version 1.3. For more information, see "[Supported LMSes](#supported-lmses)." - -In the meantime, you may manually input your roster for your class. For more information about manually importing the roster from your LMS into {% data variables.product.prodname_classroom %}, see "[Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." - -## Disconnecting your LMS - -{% data reusables.classroom.sign-into-github-classroom %} -{% data reusables.classroom.click-classroom-in-list %} -{% data reusables.classroom.click-settings %} -1. Under "Connect to a learning management system (LMS)", click **Connection Settings**. - !["Connection settings" link in classroom settings](/assets/images/help/classroom/classroom-settings-click-connection-settings.png) -1. Under "Delete Connection to your learning management system", click **Disconnect from your learning management system**. - !["Disconnect from your learning management system" button in connection settings for classroom](/assets/images/help/classroom/classroom-settings-click-disconnect-from-your-lms-button.png) diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md index bf7d11e742..66cdb5d8b3 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md @@ -151,5 +151,5 @@ The assignment overview page displays information about your assignment acceptan ## Further reading - [{% data variables.product.prodname_global_campus %} for teachers](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers) -- "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)" +- "[Connect a learning management system course to a classroom](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)" - [Using Existing Teams in Group Assignments?](https://education.github.community/t/using-existing-teams-in-group-assignments/6999) in the {% data variables.product.prodname_education %} Community diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md index 077633c1ca..4238415a6b 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md @@ -130,4 +130,4 @@ The assignment overview page provides an overview of your assignment acceptances ## Further reading - "[{% data variables.product.prodname_global_campus %} for teachers](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers)" -- "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)" +- "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)" diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md index 6965aa9d05..3f11c9db9d 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md @@ -15,7 +15,8 @@ children: - /create-an-assignment-from-a-template-repository - /leave-feedback-with-pull-requests - /use-autograding - - /connect-a-learning-management-system-to-github-classroom + - /register-a-learning-management-system-with-github-classroom + - /connect-a-learning-management-system-course-to-a-classroom shortTitle: Teach --- diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md index b15272fbcf..a71b690947 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md @@ -59,13 +59,19 @@ If your course already has a roster, you can update the students on the roster o {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-students %} -1. To connect {% data variables.product.prodname_classroom %} to your LMS and import a roster, click {% octicon "mortar-board" aria-label="The mortar board icon" %} **Import from a learning management system** and follow the instructions. For more information, see "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)." - !["Import from a learning management system" button](/assets/images/help/classroom/click-import-from-a-learning-management-system-button.png) -1. Provide the student identifiers for your roster. +1. To connect {% data variables.product.prodname_classroom %} to your LMS and import a roster, your LMS administrator will first need to register your LMS instance and then you will need to connect your LMS course to your classroom. Once connected, you can click the **Import from...** button to import a roster from your LMS course. For more information, see "[Connect a learning management system course to a classroom](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)." + + {% note %} + + **Note:** {% data reusables.classroom.google-classroom-note %} + + {% endnote %} + +2. Provide the student identifiers for your roster. - To import a roster by uploading a file containing student identifiers, click **Upload a CSV or text file**. - To create a roster manually, type your student identifiers. ![Text field for typing student identifiers and "Upload a CSV or text file" button](/assets/images/help/classroom/type-or-upload-student-identifiers.png) -1. Click **Create roster**. +3. Click **Create roster**. !["Create roster" button](/assets/images/help/classroom/click-create-roster-button.png) ## Adding students to the roster for your classroom @@ -75,10 +81,15 @@ Your classroom must have an existing roster to add students to the roster. For m {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-students %} -1. To the right of "Classroom roster", click **Update students**. +1. To the right of "Classroom roster", click **Update students**. If you have already linked your classroom to an LMS course, then you will see a **Sync from...** button instead. !["Update students" button to the right of "Classroom roster" heading above list of students](/assets/images/help/classroom/click-update-students-button.png) 1. Follow the instructions to add students to the roster. - - To import students from an LMS, click **Sync from a learning management system**. For more information about importing a roster from an LMS, see "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)." + - To import students from an LMS, your LMS administrator will first need to register your LMS instance and then you will need to connect your LMS course to your classroom. Once connected, you can click the **Sync from...** button. For more information, see "[Connect a learning management system course to a classroom](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)." + {% note %} + + **Note:** {% data reusables.classroom.google-classroom-note %} + + {% endnote %} - To manually add students, under "Manually add students", click **Upload a CSV or text file** or type the identifiers for the students, then click **Add roster entries**. ![Modal for choosing method of adding students to classroom](/assets/images/help/classroom/classroom-add-students-to-your-roster.png) diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md new file mode 100644 index 0000000000..967dbbda07 --- /dev/null +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md @@ -0,0 +1,163 @@ +--- +title: Register a learning management system with GitHub Classroom +intro: 'You can configure an LTI-compliant learning management system (LMS) with {% data variables.product.prodname_classroom %}.' +versions: + fpt: '*' +permissions: 'Organization owners who are admins for a classroom can connect learning management systems to {% data variables.product.prodname_classroom %}.' +shortTitle: Register an LMS +--- +## About registering an LMS to your classroom + +Before you can connect your LMS to a classroom, an administrator for your LMS instance needs to configure your LMS to allow {% data variables.product.prodname_classroom %} and then register your LMS with {% data variables.product.prodname_classroom %} to initiate the OAuth handshake. An admin only needs to do this registration process once, then any teacher who uses their LMS instance may sync their LMS courses to classrooms. For more information on connecting an LMS course to a classroom, see "[Connect a learning management system course to a classroom](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)." + +{% note %} + +**Note:** {% data reusables.classroom.google-classroom-note %} + +{% endnote %} + +## Supported LMSes + +{% data reusables.classroom.supported-lmses %} + +## Configuring Canvas for {% data variables.product.prodname_classroom %} + +You can register your Canvas installation with {% data variables.product.prodname_classroom %} to enable teachers to import roster data into their classrooms. For more information about Canvas, see the [Canvas website](https://www.instructure.com/canvas/). + +### 1. Register {% data variables.product.prodname_classroom %} Developer Keys in Canvas + +1. Sign into [Canvas](https://www.instructure.com/canvas/#login). +2. In the left sidebar on the home page, click **Admin**, then click **Site Admin**. +3. Click **Developer Keys**. +4. Under "Developer Keys", click the **+ Developer Key** button, then select **+ LTI Key** from the dropdown menu. +5. On the "Key Settings" configuration screen, set the fields to the following values: + + | Field in Canvas app configuration | Value or setting | + | :- | :- | + | **Method** | `Manual Entry` | + | **Title** | `GitHub Classroom`

**Note**: You can use any name, but if you set this to something else, be sure this is communicated to teachers. | + | **Description** | `Sync Canvas course rosters to GitHub Classroom` (or something similar) | + | **Target Link URI** | `https://classroom.github.com/context-link` | + | **OpenID Connect Initiation URL** | `https://classroom.github.com/lti1p3/openid-connect/auth` | + | **JWK Method** | `Public JWK URL` | + | **Public JWK URL** | `https://classroom.github.com/.well-known/jwks.json` | + | **Redirect URIs** | `https://classroom.github.com/lti1p3/openid-connect/redirect` | + | **LTI Advantage Services** dropdown | Select the "Can retrieve user data associated with the context the tool is installed in" checkbox. | + | **Additional Settings** dropdown | Under "Privacy Level", select `Public` | + | **Placements** | Select `Course Settings Sub Navigation`.

**Note**: If you set the placement to something else, this must be communicated to teachers. Our documentation will expect that this is the placement of the button. | +6. Click **Save**. +7. In the table on the "Developer Keys" page, in the row for the GitHub Classroom developer key, take note of the value of the client ID in the "Details" column -- this must be communicated to teachers for them to finish setup. +8. In the table on the "Developer Keys" page, under the "State" column, toggle the state of the key to "On". + +### 2. Register your developer keys with {% data variables.product.prodname_classroom %} + +1. Go to https://classroom.github.com/register-lms. +2. Fill in the following information: + - Under "LMS Type", choose "Canvas" from the dropdown menu. + - "Issuer Identifier": `https://canvas.instructure.com` + - "Domain": The base URL to your Canvas instance + - "Client ID": The "Client ID" under "Details" from the developer key you created + - "OIDC Authorization end-point": The base URL to your Canvas instance with `/login/oauth2/token` appended at the end. + - "OAuth 2.0 Token Retrieval URL": The base URL to your Canvas instance with `/api/lti/authorize_redirect` appended at the end. + - "Key Set URL": The base URL to your Canvas instance with `/api/lti/security/jwks` appended at the end. + + ![Register Canvas instance with GitHub Classroom](/assets/images/help/classroom/register-canvas-with-github-classroom.png) + +3. Click **Register**. +4. You should see the "Successfully registered LMS" banner at the top of the screen, which means that you've registered your LMS instance and teachers can now link their classrooms. + +## Configuring Moodle for {% data variables.product.prodname_classroom %} + +You can register your Moodle installation with {% data variables.product.prodname_classroom %} to enable teachers to import roster data into their classrooms. For more information about Moodle, see the [Moodle website](https://moodle.org). + +You must be using Moodle version 3.0 or greater. + +### 1. Enable publishing as an LTI tool in Moodle + +1. Sign into [Moodle](https://moodle.org/login/). +2. Click the "Site administration" tab in the top level menu. +3. On the "Site administration" page, click the "Plugins" tab, then scroll down to the "Authentication" section and click **Manage authentication**. +4. Next to the "LTI" field, click the toggle button to enable LTI. +5. Click the "Plugins" tab again, then scroll down to "Enrolments" and click **Manage enrol plugins**. +6. Next to the "Publish as LTI tool" field, click the toggle button to enable publishing as an LTI tool. +7. Return to the "Site administration" page by clicking on the "Site administration" tab in the top level menu, then scroll down to the "Security" section and click **HTTP Security**. +8. Next to "Allow frame embedding", select the checkbox to enable frame embedding, then click **Save changes**. + +### 2. Register {% data variables.product.prodname_classroom %} as an external tool + +1. Return to the Moodle "Site administration" page by clicking on the "Site administration" tab in the top level menu. +2. Click the "Plugins" tab, then next to the "Activity modules" section, under "External tool", click **Manage tools**. +3. Click **Configure a tool manually**. +4. Enter the following values in the fields: + + | Field in Moodle app configuration | Value or setting | + | :- | :- | + | **Tool name** | `GitHub Classroom`

**Note**: You can use any name, but if you set this to something else, be sure this is communicated to teachers. | + | **Tool URL** | `https://classroom.github.com` | + | **LTI version** | `LTI 1.3` | + | **Public Key type** | `Keyset URL` | + | **Public keyset** | `https://classroom.github.com/.well-known/jwks.json` | + | **Initiate login URL** | `https://classroom.github.com/lti1p3/openid-connect/auth` | + | **Redirection URI(s)** | `https://classroom.github.com/lti1p3/openid-connect/redirect` | + | **Default launch container** | `New window` | + +5. Select the **Supports Deep Linking (Content-Item Message)** checkbox. +6. Under the "Services" dropdown, next to "IMS LTI Names and Role Provisioning", select "Use this service to retrieve members' information as per privacy settings" from the dropdown menu. +7. Click **Save changes**. +8. GitHub Classroom has now been registered as an external tool. Under "Tools", on the 'GitHub Classroom" box, click the menu icon to see the "Tool configuration details" screen. This screen contains important information you'll need to input in the last step of registering your instance in {% data variables.product.prodname_classroom %} below. + +### 3. Registering your Moodle instance with {% data variables.product.prodname_classroom %} + +1. Go to https://classroom.github.com/register-lms. +2. Fill in the following information: + - Under "LMS Type", choose "Moodle" from the dropdown menu. + - "Issuer Identifier": The "Platform ID" from the "Tool configuration details" of the external tool you created in Moodle + - "Domain": The base URL to your Moodle instance + - "Client ID": The "Client ID" from the "Tool configuration details" of the external tool you created in Moodle + - "Authentication request URL": The "Authentication Request URL" from the "Tool configuration details" of the external tool you created in Moodle + - "Access token URL": The "Access token URL" from the "Tool configuration details" of the external tool you created in Moodle + - "Key Set URL": The "Public keyset URL" from the "Tool configuration details" of the external tool you created in Moodle + + ![Register Moodle instance with GitHub Classroom](/assets/images/help/classroom/register-moodle-with-github-classroom.png) + +3. Click **Register**. +4. You should see the "Successfully registered LMS" banner at the top of the screen, which means that you've registered your LMS instance and teachers can now link their classrooms. + +## Configuring Sakai for {% data variables.product.prodname_classroom %} + +### 1. Register {% data variables.product.prodname_classroom %} as an external tool + +1. Go to Sakai and log in. +2. Go to "Administration Workspace" and select **External Tools** in the left hand sidebar. +3. Click **Install LTI 1.x Tool**. +4. Enter the following values in the fields: + + | Field in Sakai app configuration | Value or setting | + | :- | :- | + | **Tool name** | GitHub Classroom - [Your Course Name]

**Note**: You can use any name, but if you set this to something else, be sure this is communicated to teachers. | + | **Button Text** (Text in tool menu) | What the teacher will see on the button to launch to {% data variables.product.prodname_classroom %}. For example, the value could be `sync`. | + | **Launch URL** | `https://classroom.github.com/context-link` | + | **Send User Names to External Tool** | Select this checkbox. | + | **Provide Roster to External Tool** | Select this checkbox. | + | **Tool supports LTI 1.3** | Select this checkbox. | + | **LTI 1.3 Tool Keyset URL** | https://classroom.github.com/.well-known/jwks.json | + | **LTI 1.3 Tool OpenID Connect/Initialization Endpoint** | https://classroom.github.com/lti1p3/openid-connect/auth | + | **LTI 1.3 Tool Redirect Endpoint** | https://classroom.github.com/lti1p3/openid-connect/redirect | +5. Upon submitting, Sakai will show you the information you need to register your Sakai instance with {% data variables.product.prodname_classroom %}. + +### 2. Registering your Sakai instance with {% data variables.product.prodname_classroom %} + +1. Go to https://classroom.github.com/register-lms. +2. Fill in the following information: + - Under "LMS Type", choose "Sakai" from the dropdown menu. + - "LTI 1.3 Platform Issuer": The "LTI 1.3 Platform Issuer" field as provided by Sakai + - "Domain": The base URL to your Sakai instance + - "LTI 1.3 Client ID": The "LTI 1.3 Client ID" field as provided by Sakai + - "LTI 1.3 Platform OIDC Authentication URL": The "LTI 1.3 Platform OIDC Authentication URL" field as provided by Sakai + - "LTI 1.3 Platform OAuth2 Bearer Token Retrieval URL": The "LTI 1.3 Platform OAuth2 Bearer Token Retrieval URL" field as provided by Sakai + - "LTI 1.3 Platform OAuth2 Well-Known/KeySet URL": The "LTI 1.3 Platform OAuth2 Well-Known/KeySet URL" field as provided by Sakai + + ![Register Sakai instance with GitHub Classroom](/assets/images/help/classroom/register-sakai-with-github-classroom.png) + +3. Click **Register**. +4. You should see the "Successfully registered LMS" banner at the top of the screen, which means that you've registered your LMS instance and teachers can now link their classrooms. \ No newline at end of file diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md index f0f059cb40..115f623678 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md @@ -101,4 +101,4 @@ The Git & {% data variables.product.company_short %} starter assignment is only ## Further reading - "[{% data variables.product.prodname_global_campus %} for teachers](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers)" -- "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)" +- "[Connect a learning management system course to a classroom](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)" diff --git a/data/reusables/classroom/google-classroom-note.md b/data/reusables/classroom/google-classroom-note.md new file mode 100644 index 0000000000..5225cd8799 --- /dev/null +++ b/data/reusables/classroom/google-classroom-note.md @@ -0,0 +1 @@ +Google Classroom does not use the LTI protocol, so does not need to be connected to GitHub Classroom before importing the roster. For more information, see "[Importing a roster from Google Classroom](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom#importing-a-roster-from-google-classroom)." diff --git a/data/reusables/classroom/supported-lmses.md b/data/reusables/classroom/supported-lmses.md new file mode 100644 index 0000000000..5755484c4e --- /dev/null +++ b/data/reusables/classroom/supported-lmses.md @@ -0,0 +1,21 @@ +{% data variables.product.prodname_classroom %} supports connecting with LMSes that implement Learning Tools Interoperability (LTI) standards. + +- LTI version 1.3 +- LTI Advantage + +Using LTI helps keep your information safe and secure. LTI is an industry-standard protocol and GitHub Classroom's use of LTI is certified by the Instructional Management System (IMS) Global Learning Consortium. For more information, see [Learning Tools Interoperability](https://www.imsglobal.org/activity/learning-tools-interoperability) and [About IMS Global Learning Consortium](http://www.imsglobal.org/aboutims.html) on the IMS Global Learning Consortium website. + +{% data variables.product.company_short %} has tested and verified registration, connection and the import of roster data from the following LMSes into {% data variables.product.prodname_classroom %}. + +- Canvas +- Moodle +- Sakai +- Google Classroom + +{% note %} + +**Note:** Other LMSes that implement LTI 1.3 may also work with {% data variables.product.prodname_classroom %}, but have not yet been verified. LMS admins may need to configure custom settings around privacy and button placement and may need to provide teachers with documentation on how to launch into {% data variables.product.prodname_classroom %} from the LMS. + +{% endnote %} + +{% data reusables.classroom.google-classroom-note %} \ No newline at end of file