Skip to content
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions content/education/guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Administer a classroom, assign and review work from your students, and teach the

- [Basics of setting up {% data variables.product.prodname_classroom %} ](/education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom)
- [Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms)
- [Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)
- [Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)
- [Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)
- [Create an assignment from a template repository](/education/manage-coursework-with-github-classroom/create-an-assignment-from-a-template-repository)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@ children:
- /integrate-github-classroom-with-an-ide
- /learn-with-github-classroom
---

Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ redirect_from:
- /education/manage-coursework-with-github-classroom/probot-settings
children:
- /manage-classrooms
- /use-the-git-and-github-starter-assignment
- /create-an-individual-assignment
- /create-a-group-assignment
- /create-an-assignment-from-a-template-repository
- /leave-feedback-with-pull-requests
- /use-autograding
- /connect-a-learning-management-system-to-github-classroom
---

Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
---
title: Manage classrooms
intro: 'You can create and manage a classroom for each course that you teach using {% data variables.product.prodname_classroom %}.'
intro: You can create and manage a classroom for each course that you teach using {% data variables.product.prodname_classroom %}.
permissions: Organization owners can manage a classroom for an organization.
versions:
free-pro-team: '*'
redirect_from:
- /education/manage-coursework-with-github-classroom/archive-a-classroom
- /education/manage-coursework-with-github-classroom/manage-classrooms
---

### About classrooms

{% data reusables.classroom.about-classrooms %}
Expand Down Expand Up @@ -45,7 +46,7 @@ You must authorize the OAuth app for {% data variables.product.prodname_classroo
!["New classroom" button](/assets/images/help/classroom/click-new-classroom-button.png)
{% data reusables.classroom.guide-create-new-classroom %}

After you create a classroom, you can begin creating assignments for students. For more information, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)" or "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)."
After you create a classroom, you can begin creating assignments for students. For more information, see "[Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)," "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)," or "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)."

### Creating a roster for your classroom

Expand All @@ -58,10 +59,8 @@ If your course already has a roster, you can update the students on the roster o
{% 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.
- 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. To create a roster manually, type your student identifiers. Optionally, click **Upload a CSV or text file** to upload a file containing the 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**.
!["Create roster" button](/assets/images/help/classroom/click-create-roster-button.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
title: Use the Git and GitHub starter assignment
intro: You can use the Git & {% data variables.product.company_short %} starter assignment to give students an overview of Git and {% data variables.product.company_short %} fundamentals.
versions:
free-pro-team: '*'
redirect_from:
- /education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment
---

{% note %}

**Note:** The Git & {% data variables.product.company_short %} starter assignment is in beta and subject to change.

{% endnote %}

The Git & {% data variables.product.company_short %} starter assignment is a pre-made course that summarizes the basics of Git and {% data variables.product.company_short %} and links students to resources to learn more about specific topics.

### Prerequisites

{% data reusables.classroom.assignments-classroom-prerequisite %}

### Creating the starter assignment

#### If there are no existing assignments in the classroom

1. Sign into {% data variables.product.prodname_classroom_with_url %}.
2. Navigate to a classroom.
3. In the {% octicon "repo" aria-label="The repo icon" %} **Assignments** tab, click **Use starter assignment**.

<div class="procedural-image-wrapper">
<img alt="Creating your first assignment" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-create-first-assignment.png">
</div>

#### If there already are existing assignments in the classroom

1. Sign into {% data variables.product.prodname_classroom_with_url %}.
2. Navigate to a classroom.
3. In the {% octicon "repo" aria-label="The repo icon" %} **Assignments** tab, click the link on the blue banner.

<div class="procedural-image-wrapper">
<img alt="The 'New assignment' button" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-click-new-starter-assignment-button.png">
</div>

### Setting up the basics for an assignment

Import the starter course into your organization, name your assignment, decide whether to assign a deadline, and choose the visibility of assignment repositories.

- [Importing the assignment](#importing-the-assignment)
- [Naming an assignment](#naming-an-assignment)
- [Assigning a deadline for an assignment](#assigning-a-deadline-for-an-assignment)
- [Choosing an assignment type](#choosing-an-assignment-type)
- [Choosing a visibility for assignment repositories](#choosing-a-visibility-for-assignment-repositories)

#### Importing the assignment

You first need to import the Git & {% data variables.product.product_name %} starter assignment into your organization.

<div class="procedural-image-wrapper">
<img alt="The `Import the assignment` button" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-import-starter-assignment.png">
</div>

#### Naming the assignment

For an individual assignment, {% data variables.product.prodname_classroom %} names repositories by the repository prefix and the student's {% data variables.product.product_name %} username. By default, the repository prefix is the assignment title. For example, if you name an assignment "assignment-1" and the student's username on {% data variables.product.product_name %} is @octocat, the name of the assignment repository for @octocat will be `assignment-1-octocat`.

{% data reusables.classroom.assignments-type-a-title %}

#### Assigning a deadline for an assignment

{% data reusables.classroom.assignments-guide-assign-a-deadline %}

#### Choosing a visibility for assignment repositories

The repositories for an assignment can be public or private. If you use private repositories, only the student can see the feedback you provide. Under "Repository visibility," select a visibility.

When you're done, click **Continue**. {% data variables.product.prodname_classroom %} will create the assignment and bring you to the assignment page.

<div class="procedural-image-wrapper">
<img alt="'Continue' button" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-click-continue-button.png">
</div>

### Inviting students to an assignment

{% data reusables.classroom.assignments-guide-invite-students-to-assignment %}

You can see whether a student has joined the classroom and accepted or submitted an assignment in the **All students** tab for the assignment. {% data reusables.classroom.assignments-to-prevent-submission %}

<div class="procedural-image-wrapper">
<img alt="Individual assignment" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignment-individual-hero.png">
</div>

The Git & {% data variables.product.company_short %} starter assignment is only available for individual students, not for groups. Once you create the assignment, students can start work on the assignment.

### Next steps

- Make additional assignments customized to your course. For more information, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)" and "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)."

### Further reading

- "[Use {% data variables.product.prodname_dotcom %} in your classroom and research](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research)"
- "[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)"
1 change: 1 addition & 0 deletions content/education/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ You've created a classroom, and you're ready to enrich your course with {% data

- Watch some videos about {% data variables.product.prodname_classroom %}. For more information, see "[Basics of setting up {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom)."
- Manage your classrooms and classroom admins, and create a roster of students for your classroom. For more information, see "[Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms)."
- Use the Git and {% data variables.product.company_short %} starter assignment to give students an overview of Git and {% data variables.product.product_name %} fundamentals. For more information, see "[Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)."
- Create an assignment for individual students or teams. {% data reusables.classroom.for-more-information-about-assignment-creation %}
- Write and implement automated tests to provide immediate feedback to students directly in assignment repositories. For more information, see "[Use autograding](/education/manage-coursework-with-github-classroom/use-autograding)."
- Participate in {% data variables.product.prodname_education_community_with_url %}.
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ An overview of some of the most common actions that are recorded as events in th
| `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
| `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)")
| `sponsor_sponsorship_payment_complete` | Triggered after you sponsor an account and your payment has been processed (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)")
| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)")
| `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -643,6 +643,7 @@ For more information, see "[Managing the publication of {% data variables.produc
| `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
| `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)")
| `sponsor_sponsorship_payment_complete` | Triggered after you sponsor an account and your payment has been processed (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)")
| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored account (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)")
| `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)")
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,22 @@
To create an assignment, sign into {% data variables.product.prodname_classroom_with_url %} and navigate to a classroom. In the {% octicon "repo" aria-label="The repo icon" %} **Assignments** tab, click **New assignment**.
#### If there are no existing assignments in the classroom

To create your first assignment:

1. Sign into {% data variables.product.prodname_classroom_with_url %}.
1. Navigate to a classroom.
1. In the {% octicon "repo" aria-label="The repo icon" %} **Assignments** tab, click **Create an assignment**.

<div class="procedural-image-wrapper">
<img alt="Creating your first assignment" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-create-first-assignment.png">
</div>

#### If there already are existing assignments in the classroom

To create an assignment:

1. Sign into {% data variables.product.prodname_classroom_with_url %}.
1. Navigate to a classroom.
1. In the {% octicon "repo" aria-label="The repo icon" %} **Assignments** tab, click **New assignment**.

<div class="procedural-image-wrapper">
<img alt="The 'New assignment' button" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-click-new-assignment-button.png">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,8 @@ Stripe | Stripe Live API Restricted Key | stripe_live_restricted_key{% endif %}
Stripe | Stripe Test API Restricted Key | stripe_test_restricted_key{% endif %}
{%- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
Stripe | Stripe Webhook Signing Secret | stripe_webhook_signing_secret{% endif %}
{%- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
Telegram | Telegram Bot Token | telegram_bot_token{% endif %}
{%- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@next" %}
Tencent Cloud | Tencent Cloud Secret ID | tencent_cloud_secret_id{% endif %}
{%- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@next" %}
Expand Down
2 changes: 1 addition & 1 deletion data/reusables/webhooks/sponsorship_webhook_properties.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Key | Type | Description
----|------|-------------
`action` |`string` | The action that was performed. This can be one of `created`, `cancelled`, `edited`, `tier_changed`, `pending_cancellation`, or `pending_tier_change`.
`action` |`string` | The action that was performed. This can be one of `created`, `cancelled`, `edited`, `tier_changed`, `pending_cancellation`, or `pending_tier_change`. Note: The `created` action is only triggered after payment is processed.
Loading