Skip to content
Merged
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
83 changes: 47 additions & 36 deletions source/instructors/setupcourses/import-from-github-classroom.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,57 +5,68 @@


Importing from GitHub Classroom
================================
===============================

If you have a GitHub Classroom you would like to import to Codio, please follow the steps below or watch the video walkthrough.
You can import an existing GitHub Classroom into Codio. Each assignment repository in the classroom is created as an assignment in a new Codio course.

.. important::
Ensure you have the necessary permissions in both GitHub Classroom and Codio before beginning the import process.
Choose an Import Method
-----------------------

Steps
-----
There are two ways to migrate your assignments from GitHub into Codio:

- **GitHub Classroom Import** — Import your entire classroom as is.
- **Smart Import** — Import individual assignments and automatically add Codio native features (Guides).

1. Go to `codio.com <https://www.codio.com>`_ and select the user icon at the top.
Use the table below to decide which method fits your course.

2. Enter your login credentials if you have an existing Codio account.
.. list-table::
:header-rows: 1
:stub-columns: 1
:widths: 20 40 40

.. note::
If you do not have an account, select **Free Instructor Account**, enter your
information, and select that you are an instructor and a GitHub Classroom user.
* -
- :ref:`GitHub Classroom Import <githubclassroomimportsteps>`
- :ref:`Smart Import <smartimport>`
* - **What it does**
- Imports your entire classroom as is. Each repository becomes a Codio assignment.
- Imports repositories one at a time and automatically converts them into assignments with Codio Guides.
* - **Guides**
- No — content stays as README files.
- Yes — README content becomes interactive Guide pages.
* - **Best for**
- Moving a whole course over quickly.
- Getting the most out of Codio's native features.

3. Once your account is created, sign in to Codio.
To use Smart Import, see :ref:`smartimport`. To import your entire classroom, follow the steps below.

4. To import your GitHub Classroom, click the **New Course** dropdown button in the top
right and select **Import from GitHub Classroom**.

5. If you are already signed in to your GitHub Classroom account in this browser session,
your classroom organizations will automatically populate. Otherwise, you will be
prompted to log in.
.. _githubclassroomimportsteps:

6. Once logged in, select the classroom you want to import.
Steps
-----

1. Go to `codio.com <https://www.codio.com>`_ and click the user icon at the top of the page.

2. Sign in with your Codio credentials.

.. note::
If you do not have a Codio account, click **Free Instructor Account**, enter your
information, and indicate that you are an instructor and a GitHub Classroom user.
Once your account is created, sign in to Codio.

7. Select **OK**. Each assignment repository will be created as an assignment inside the
Codio course.
3. Click **Import** in the top right corner.

8. To import multiple courses, return to the Courses dashboard and repeat the process.
4. Sign in to your GitHub account when prompted. If you are already signed in to GitHub
in this browser session, your classroom organizations populate automatically.

5. Select the classroom you want to import.

Video Walkthrough
-----------------
6. In the pop-up window, select the organization to import to. If you belong to only
one organization, it is the only option shown.

This video walks through how to add your GitHub Classroom content into Codio:
7. Select the technology stack that matches the coding language of your content.
Comment thread
LolaValente marked this conversation as resolved.

.. raw:: html
8. Click **Import** in the bottom right corner. Each assignment repository is created
as an assignment in the Codio course.

<script src="https://fast.wistia.com/player.js" async></script>
<script src="https://fast.wistia.com/embed/hcpi6qbepz.js" async type="module"></script>
<style>
wistia-player[media-id='hcpi6qbepz']:not(:defined) {
background: center / contain no-repeat url('https://fast.wistia.com/embed/medias/hcpi6qbepz/swatch');
display: block;
filter: blur(5px);
padding-top: 56.25%;
}
</style>
<wistia-player media-id="hcpi6qbepz" aspect="1.7777777777777777"></wistia-player>
9. To import additional classrooms, return to the **Courses** dashboard and repeat Steps 3–8.