diff --git a/content/README.md b/content/README.md index d813e7caddc8..4bd3470af79d 100644 --- a/content/README.md +++ b/content/README.md @@ -276,7 +276,7 @@ journeyTracks: - id: ado_migration title: Run your migration guides: - - href: /migrations/ado/understand-migrations-from-azure-devops-to-github + - href: /migrations/using-github-enterprise-importer/ado/understand-migrations-from-azure-devops-to-github ``` ### `contentType` diff --git a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md index d791b74a1205..04b44cbf94a8 100644 --- a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md +++ b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md @@ -413,7 +413,7 @@ ghe-org-admin-promote -a ### ghe-reactivate-admin-login -Use this command to immediately unlock the {% data variables.enterprise.management_console %} after an account lockout. To configure authentication policies for {% data variables.location.product_location %}, see [AUTOTITLE](/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-rate-limits#configuring-authentication-policy-rate-limits). +Use this command to immediately unlock the {% data variables.enterprise.management_console %} after an account lockout. To configure authentication policies for {% data variables.location.product_location %}, see [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-web-ui/managing-access-to-the-management-console#configuring-rate-limits-for-authentication-to-the-management-console). ```shell ghe-reactivate-admin-login @@ -1690,7 +1690,7 @@ GHE_LICENSE_FILE=/path/license ghe-license import ### elm -`elm` is the command-line tool for {% data variables.product.prodname_elm %}, a tool for live migrations to {% data variables.enterprise.data_residency_site %}. See [AUTOTITLE](/migrations/elm/elm-cli-reference). +`elm` is the command-line tool for {% data variables.product.prodname_elm %}, a tool for live migrations to {% data variables.enterprise.data_residency_site %}. See [AUTOTITLE](/migrations/elm/ghes-to-ghecom/elm-cli-reference). ## Security diff --git a/content/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization.md b/content/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization.md index 7acc4f0e17dc..8c51fa108721 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization.md +++ b/content/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization.md @@ -52,8 +52,6 @@ Additionally, ensure that: {% ifversion fpt %} -> [!NOTE] -> If you are a verified educator or a teacher, you must enable {% data variables.product.prodname_github_codespaces %} from a {% data variables.product.prodname_classroom %} to use your {% data variables.product.prodname_codespaces %} Education benefit. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom#about-the-codespaces-education-benefit-for-verified-teachers). {% endif %} diff --git a/content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md b/content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md index 5df068bbf4bb..9d4df74d1b14 100644 --- a/content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md +++ b/content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md @@ -503,13 +503,36 @@ The `totals_by_client` array appears at the top level of each record in per-user | `totals_by_client[].token_usage.avg_tokens_per_request` | `number` | No | Average number of **output** and **prompt** tokens per request, computed as `(output_tokens_sum + prompt_tokens_sum) ÷ request_count`. | | `totals_by_client[].totals_by_model` | `array` | No | Per-model breakdown of the client's requests and token usage. Entries are keyed on `model`, `model_selection_mode`, and `is_custom_enterprise_model`, so the same model can appear more than once. For example, a model used both as an enterprise custom model and as a {% data variables.product.prodname_copilot_short %}-hosted model has two entries. | | `totals_by_client[].totals_by_model[].model` | `string` | No | Model used for the requests. For `code_review`, the model is always reported as `unknown`. Enterprise custom model names that can't be matched to a known model are also reported as `unknown`. | -| `totals_by_client[].totals_by_model[].model_selection_mode` | `string` | No | How the model was selected. Possible values are `user_selected` (a specific model was requested rather than Auto), `product_selected` (the product chose the model, used for all {% data variables.copilot.copilot_code-review_short %} and {% data variables.copilot.copilot_cloud_agent %} requests), `auto` (Auto chose the model), `other` (selection modes that are grouped together and not yet reported individually), and `unknown` (a selection mode sent by the client that couldn't be normalized). | +| `totals_by_client[].totals_by_model[].model_selection_mode` | `string` | No | How the model was selected. See [Model selection mode values](#model-selection-mode-values). | | `totals_by_client[].totals_by_model[].is_custom_enterprise_model` | `boolean` | Yes | Whether the requests used an enterprise custom model. `true` for custom models that an enterprise or organization owner configured in {% data variables.product.github %} settings. `false` for {% data variables.product.prodname_copilot_short %}-hosted models, including when no custom model signal is available. Determined server-side. Omitted for report days before this field was introduced. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/enable-custom-models). | | `totals_by_client[].totals_by_model[].request_count` | `integer` | No | Number of successful model requests from the client that used this model, selection mode, and custom model status. | | `totals_by_client[].totals_by_model[].token_usage.prompt_tokens_sum` | `integer` | No | Total number of prompt tokens sent across these requests. | | `totals_by_client[].totals_by_model[].token_usage.output_tokens_sum` | `integer` | No | Total number of output tokens generated across these requests. | | `totals_by_client[].totals_by_model[].token_usage.avg_tokens_per_request` | `number` | No | Average number of **output** and **prompt** tokens per request, computed as `(output_tokens_sum + prompt_tokens_sum) ÷ request_count`. | +#### Model selection mode values + +The `model_selection_mode` field reports the following values. + +| Value | Description | +|:--|:--| +| `user_selected` | A specific model was requested rather than Auto or {% data variables.copilot.copilot_fusion_short %}. | +| `product_selected` | The product chose the model. Used for all {% data variables.copilot.copilot_code-review_short %} and {% data variables.copilot.copilot_cloud_agent %} requests. | +| `auto` | Auto chose the model, including requests using the Efficiency or Intelligence tier. | +| `fusion_standard` | Requests using the {% data variables.copilot.copilot_fusion_standard %} effort level. Can also include Auto Balance requests. | +| `fusion_high` | Requests using the {% data variables.copilot.copilot_fusion_high %} effort level. | +| `fusion_max` | Requests using the {% data variables.copilot.copilot_fusion_max %} effort level. | +| `fusion_fast` | Requests using the {% data variables.copilot.copilot_fusion_fast %} effort level. This level is used only in {% data variables.product.prodname_vscode %} inline chat. Users can't select it. | +| `unknown` | The selection mode was missing, empty, or couldn't be normalized. | + +Earlier reports can contain `other` for selection modes that were grouped together rather than reported individually. + +For details about the effort levels, see [AUTOTITLE](/copilot/concepts/models/copilot-fusion#copilot-fusion-effort-levels). + +Currently, `fusion_standard` can include Auto Balance requests from clients that don't support {% data variables.copilot.copilot_fusion_short %}. Don't use this value alone to measure {% data variables.copilot.copilot_fusion_short %} adoption. These Auto Balance requests can appear as Auto in billing reports. + +Usage metrics measure activity, not charges. Use billing usage reports to determine billable amounts. Don't infer charges from `model_selection_mode`. See [AUTOTITLE](/billing/reference/billing-reports). + ### Pull request activity fields > [!IMPORTANT] diff --git a/content/education/about-github-education/github-education-for-students/about-github-education-for-students.md b/content/education/about-github-education/github-education-for-students/about-github-education-for-students.md index c12fb3d09db2..f1152600e417 100644 --- a/content/education/about-github-education/github-education-for-students/about-github-education-for-students.md +++ b/content/education/about-github-education/github-education-for-students/about-github-education-for-students.md @@ -44,10 +44,9 @@ Once you are a verified {% data variables.product.prodname_global_campus %} stud * **{% data variables.product.prodname_github_codespaces %}:** {% data reusables.education.student-codespaces-benefit %} For more information on getting started with {% data variables.product.prodname_github_codespaces %}, see [AUTOTITLE](/codespaces/quickstart). > [!NOTE] -> {% data reusables.education.note-on-student-codespaces-usage %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom). +> {% data reusables.education.note-on-student-codespaces-usage %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). ## Further reading * [AUTOTITLE](/education/about-github-education/github-education-for-teachers/about-github-education-for-teachers) * [AUTOTITLE](/education/about-github-education/github-education-for-students/about-github-community-exchange) -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom) diff --git a/content/education/guides.md b/content/education/guides.md index 958ca5a76353..a1b3091c6f2f 100644 --- a/content/education/guides.md +++ b/content/education/guides.md @@ -33,15 +33,6 @@ For teachers: Administer a classroom, assign and review work from your students, and teach the new generation of software developers with {% data variables.product.prodname_classroom %}. * [About {% data variables.product.prodname_global_campus %} for teachers](/education/about-github-education/github-education-for-teachers/about-github-education-for-teachers) -* [Manage classrooms](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms) -* [About assignments](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments) -* [Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment) -* [Create an individual assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment) -* [Create a group assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment) -* [Create an assignment from a template repository](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository) -* [Monitor students' progress with the assignment overview page](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page) -* [Leave feedback with pull requests](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests) -* [Use autograding](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding) ## Learn to develop software diff --git a/content/education/index.md b/content/education/index.md index 3fe3ad721504..7c7499f90317 100644 --- a/content/education/index.md +++ b/content/education/index.md @@ -21,9 +21,7 @@ carousels: - /education/quickstart - /education/about-github-education/github-education-for-students/apply-to-github-education-as-a-student - /education/about-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher - - /education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom - - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment - - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom + - /education/manage-coursework-with-github-classroom - /education/about-github-education/github-education-for-students/about-github-education-for-students - /education/about-github-education/use-github-at-your-educational-institution/about-github-campus-program - /education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange diff --git a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom.md b/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom.md deleted file mode 100644 index a86d39b25111..000000000000 --- a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: About GitHub Classroom -intro: Teachers and school administrators can use {% data variables.product.prodname_classroom %} to create virtual classrooms, make and edit assignments, automatically grade assignment submissions, and more. -versions: - fpt: '*' -contentType: concepts -category: - - Set up GitHub Classroom ---- -{% data reusables.classroom.closing-down-notice %} - -## About {% data variables.product.prodname_classroom %} - -{% data variables.product.prodname_classroom %} is a teaching tool that lets teachers and school administrators create and manage digital classrooms and assignments. You can create assignments for individual students or groups of students, set due dates, and track assignments on your teacher dashboard. Additionally, {% data variables.product.prodname_classroom %} has many features that simplify tasks like providing feedback, grading assignments, and integrating your existing teaching tools. - -## {% data variables.product.prodname_classroom %} features - -{% data variables.product.prodname_classroom %} offers a variety of features to simplify both teaching and learning. - -### Assignment templates - -With {% data variables.product.prodname_classroom %}, you can create assignments that use template repositories with boilerplate code, documentation, and other resources that you think will be useful to your students. Assignments with template repositories create assignment repositories with starter code for your students. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository). - -### Autograding - -Through {% data variables.product.prodname_classroom %}, you can configure tests to automatically grade the work of each student every time that student pushes to their assignment repository. To learn more about autograding with {% data variables.product.prodname_classroom %}, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding). - -### Ability to connect a learning management system - -Optionally, you can connect a learning management system (LMS) to {% data variables.product.prodname_classroom %} to import a student identifier roster for your classroom. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom). - -### Feedback pull requests - -{% data reusables.classroom.about-feedback-pull-requests %} - -### Combination with an integrated development environment (IDE) - -{% data reusables.classroom.about-ide-integration %} - -## Further reading - -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom) -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/learn-with-github-classroom) diff --git a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/export-or-migrate-github-classroom-data.md b/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/export-or-migrate-github-classroom-data.md deleted file mode 100644 index ab66136020b1..000000000000 --- a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/export-or-migrate-github-classroom-data.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Export or migrate GitHub Classroom data -intro: 'Export your GitHub Classroom data to local files or migrate your data to a partner platform.' -versions: - fpt: '*' ---- -{% data reusables.classroom.closing-down-notice %} - -Use the GitHub command line interface to export your Classroom data or migrate to a partner platform. - -## Export your Classroom data to local files - -1. Set up the GitHub command line interface (CLI) tool and install the GitHub Classroom extension. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli). - -1. Download the Classroom Export Utility script to your computer. See the [classroom-export-utility repository](https://github.com/github-education-resources/classroom-export-utility/blob/main/export-classrooms.sh). - -1. Follow the instructions in the [Classroom Export Utility README](https://github.com/github-education-resources/classroom-export-utility/blob/main/README.md) to download your Classroom data. - -1. Verify that all your classroom data has been exported to JSON or CSV files on your local machine. - -## Migrate existing GitHub Classroom data to a partner - -### Migrating to Codio - -Follow the [instructions on the Codio documentation site](https://docs.codio.com/instructors/setupcourses/import-from-github-classroom.html) and watch the video walkthrough to import your GitHub classrooms to the Codio platform. - -You can also book a free consultation to get personalized advice and tips on your classroom setup and migration options at [https://www.codio.com/consultation](https://www.codio.com/consultation). - -Watch the [on-demand webinar about using GitHub with Codio](https://www.codio.com/on-demand-github-codio-webinar). - -### Migrating to Classroom 50 - -> [!NOTE] -> Classroom 50 will become generally available on July 1, 2026. - -Classroom 50 uses GitHub repositories and actions for autograding, so it's very similar to the current GitHub Classroom setup. - -The [Teacher Guide](https://github.com/foundation50/classroom50/wiki/Teacher-Guide) provides instructions for setting up Classroom 50. - -Participate in the [Classroom 50 community discussions](https://github.com/foundation50/classroom50/discussions) if you have questions or suggestions. 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 deleted file mode 100644 index 87e5c60f3ea2..000000000000 --- a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Glossary -intro: 'You can review explanations of terminology for {% data variables.product.prodname_classroom %}.' -versions: - fpt: '*' -redirect_from: - - /education/manage-coursework-with-github-classroom/glossary -category: - - Set up GitHub Classroom ---- -{% data reusables.classroom.closing-down-notice %} - -## assignment - -An assignment is coursework in {% data variables.product.prodname_classroom %}. A teacher can assign an assignment to an individual student or a group of students. Teachers can import starter code for the assignment, assign students, and create a deadline for each assignment. For more information, see the definitions for [individual assignment](#individual-assignment) and [group assignment](#group-assignment). - ---- - -## classroom - -A classroom is the basic unit of {% data variables.product.prodname_classroom %}. Teachers can use a classroom to organize and manage students, teaching assistants, and assignments for a single course. A classroom belongs to an organization on {% data variables.product.prodname_dotcom %}. To administer a classroom, you must be an organization owner for the organization. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms). - ---- - -## {% data variables.product.prodname_classroom %} - -{% data variables.product.prodname_classroom %} is a web application for educators that provides course administration tools integrated with {% data variables.product.prodname_dotcom %}. For more information, see the [{% data variables.product.prodname_classroom %}](https://classroom.github.com/) website. - ---- - -## group assignment - -{% data reusables.classroom.assignments-group-definition %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment). - ---- - -## identifier - -An identifier in {% data variables.product.prodname_classroom %} is a unique ID for a student participating in a course. For example, an identifier can be a student name, alphanumeric ID, or email address. - ---- - -## individual assignment - -{% data reusables.classroom.assignments-individual-definition %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment). - ---- - -## 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 [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom). - ---- - -## Further reading - -* [AUTOTITLE](/get-started/learning-about-github/github-glossary) diff --git a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/index.md b/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/index.md deleted file mode 100644 index 530952951434..000000000000 --- a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Get started with GitHub Classroom -shortTitle: Get started -intro: 'Learn how to configure and use {% data variables.product.prodname_classroom %} to administer your course.' -versions: - fpt: '*' -redirect_from: - - /education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom - - /education/manage-coursework-with-github-classroom/get-started-with-github-classroom/basics-of-setting-up-github-classroom -children: - - /about-github-classroom - - /glossary - - /export-or-migrate-github-classroom-data ---- -{% data reusables.classroom.closing-down-notice %} \ No newline at end of file diff --git a/content/education/manage-coursework-with-github-classroom/index.md b/content/education/manage-coursework-with-github-classroom/index.md index cb3e8daca589..b4d6b010381e 100644 --- a/content/education/manage-coursework-with-github-classroom/index.md +++ b/content/education/manage-coursework-with-github-classroom/index.md @@ -4,13 +4,80 @@ shortTitle: '{% data variables.product.prodname_classroom %}' intro: 'With {% data variables.product.prodname_classroom %}, you can use {% data variables.product.github %} to administer or participate in a course about software development.' versions: fpt: '*' -children: - - /get-started-with-github-classroom - - /teach-with-github-classroom - - /integrate-github-classroom-with-an-ide - - /learn-with-github-classroom +children: [] +redirect_from: + - /education/manage-coursework-with-github-classroom/about-using-makecode-arcade-with-github-classroom + - /education/manage-coursework-with-github-classroom/about-using-replit-with-github-classroom + - /education/manage-coursework-with-github-classroom/about-using-vs-code-with-github-classroom + - /education/manage-coursework-with-github-classroom/adding-tests-for-auto-grading + - /education/manage-coursework-with-github-classroom/archive-a-classroom + - /education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom + - /education/manage-coursework-with-github-classroom/configure-default-settings-for-assignment-repositories + - /education/manage-coursework-with-github-classroom/configuring-a-learning-management-system-for-github-classroom + - /education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom + - /education/manage-coursework-with-github-classroom/connect-to-lms + - /education/manage-coursework-with-github-classroom/create-a-group-assignment + - /education/manage-coursework-with-github-classroom/create-an-assignment-from-a-template-repository + - /education/manage-coursework-with-github-classroom/create-an-individual-assignment + - /education/manage-coursework-with-github-classroom/create-group-assignments + - /education/manage-coursework-with-github-classroom/creating-an-individual-assignment + - /education/manage-coursework-with-github-classroom/generate-lms-credentials + - /education/manage-coursework-with-github-classroom/get-started-with-github-classroom + - /education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom + - /education/manage-coursework-with-github-classroom/get-started-with-github-classroom/basics-of-setting-up-github-classroom + - /education/manage-coursework-with-github-classroom/get-started-with-github-classroom/export-or-migrate-github-classroom-data + - /education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary + - /education/manage-coursework-with-github-classroom/glossary + - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide + - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom + - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-replit-with-github-classroom + - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom + - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide + - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-online-ide + - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/replit-with-github-classroom + - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/run-student-code-in-an-ide + - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/run-student-code-in-an-online-ide + - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom + - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-online-ide + - /education/manage-coursework-with-github-classroom/learn-with-github-classroom + - /education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results + - /education/manage-coursework-with-github-classroom/learn-with-github-classroom/viewing-your-assignments-deadline + - /education/manage-coursework-with-github-classroom/leave-feedback-with-pull-requests + - /education/manage-coursework-with-github-classroom/leaving-feedback-in-github + - /education/manage-coursework-with-github-classroom/manage-classrooms + - /education/manage-coursework-with-github-classroom/online-ide-integrations + - /education/manage-coursework-with-github-classroom/probot-settings + - /education/manage-coursework-with-github-classroom/reviewing-auto-graded-work-students + - /education/manage-coursework-with-github-classroom/reviewing-auto-graded-work-teachers + - /education/manage-coursework-with-github-classroom/run-student-code-in-an-online-ide + - /education/manage-coursework-with-github-classroom/running-student-code + - /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/student-experience-makecode + - /education/manage-coursework-with-github-classroom/student-experience-replit + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments + - /education/manage-coursework-with-github-classroom/teach-with-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-to-github-classroom + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/editing-an-assignment + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/extending-an-assignments-deadline-for-an-individual-or-group + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment + - /education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli + - /education/manage-coursework-with-github-classroom/use-autograding + - /education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment + - /education/manage-coursework-with-github-classroom/using-template-repos-for-assignments + - /education/manage-coursework-with-github-classroom/view-autograding-results --- > [!NOTE] -> As of May 2026, new {% data variables.product.prodname_classroom %} sign-ups are no longer available as we transition to partner solutions. For more information on this transition, please see [the {% data variables.product.prodname_classroom %} transition announcement](https://gh.io/classroom-sunset). - +> As of August 28, 2026, GitHub Classroom has been closed down in favor of partner solutions. For more information on this transition, please refer to the [GitHub Educator Community Discussion](https://gh.io/classroom-sunset). diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md deleted file mode 100644 index cfde30999e71..000000000000 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: About using MakeCode Arcade with GitHub Classroom -shortTitle: About using MakeCode Arcade -intro: 'You can configure MakeCode Arcade as the online IDE for assignments in {% data variables.product.prodname_classroom %}.' -versions: - fpt: '*' -redirect_from: - - /education/manage-coursework-with-github-classroom/student-experience-makecode - - /education/manage-coursework-with-github-classroom/about-using-makecode-arcade-with-github-classroom -category: - - Integrate GitHub Classroom with an IDE ---- -{% data reusables.classroom.closing-down-notice %} - -## About MakeCode Arcade - -MakeCode Arcade is an online integrated development environment (IDE) for developing retro arcade games using drag-and-drop block programming and JavaScript. Students can write, edit, run, test, and debug code in a browser with MakeCode Arcade. For more information about IDEs and {% data variables.product.prodname_classroom %}, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide). - -{% data reusables.classroom.readme-contains-button-for-online-ide %} - -The first time the student clicks the button to visit MakeCode Arcade, the student must sign into MakeCode Arcade with {% data variables.product.github %} credentials. After signing in, the student will have access to a development environment containing the code from the assignment repository, fully configured on MakeCode Arcade. - -For more information about working on MakeCode Arcade, see the [MakeCode Arcade Tour](https://arcade.makecode.com/ide-tour) and [documentation](https://arcade.makecode.com/docs) on the MakeCode Arcade website. - -MakeCode Arcade does not support multiplayer-editing for group assignments. Instead, students can collaborate with Git and {% data variables.product.github %} features like branches and pull requests. - -## About submission of assignments with MakeCode Arcade - -By default, MakeCode Arcade is configured to push to the assignment repository on {% data variables.location.product_location %}. After making progress on an assignment with MakeCode Arcade, students should push changes to {% data variables.location.product_location %} using the {% octicon "mark-github" aria-label="The GitHub mark" %}{% octicon "arrow-up" aria-label="The up arrow icon" %} button at the bottom of the screen. - -![Screenshot of the MakeCode Arcade window. At the bottom of the window, a button is labeled with the Octocat logo and an upwards-facing arrow.](/assets/images/help/classroom/ide-makecode-arcade-version-control-button.png) - -## Further reading - -* [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes) diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md deleted file mode 100644 index fb5693489bbd..000000000000 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: About using Visual Studio Code with GitHub Classroom -shortTitle: About using Visual Studio Code -intro: 'You can configure {% data variables.product.prodname_vscode %} as the preferred editor for assignments in {% data variables.product.prodname_classroom %}.' -versions: - fpt: '*' -redirect_from: - - /education/manage-coursework-with-github-classroom/about-using-vs-code-with-github-classroom -category: - - Integrate GitHub Classroom with an IDE ---- -{% data reusables.classroom.closing-down-notice %} - -> [!NOTE] -> The [{% data variables.product.prodname_classroom %} extension for {% data variables.product.prodname_vscode_shortname %}](https://aka.ms/classroom-vscode-ext) is no longer in active development. The **Open in {% data variables.product.prodname_vscode_shortname %}** badge in student repositories still works, but other features of the extension may not function as expected. - -## About {% data variables.product.prodname_vscode %} - -{% data variables.product.prodname_vscode %} is a lightweight but powerful source code editor which runs on your desktop and is available for Windows, macOS and Linux. With the [{% data variables.product.prodname_classroom %} extension for {% data variables.product.prodname_vscode_shortname %}](https://aka.ms/classroom-vscode-ext), students can easily browse, edit, submit, collaborate, and test their Classroom Assignments. For more information about IDEs and {% data variables.product.prodname_classroom %}, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide). - -### Your student's editor of choice - -The {% data variables.product.prodname_classroom %} integration with {% data variables.product.prodname_vscode_shortname %} provides students with an extension pack which contains: - -1. [{% data variables.product.prodname_classroom %} Extension](https://aka.ms/classroom-vscode-ext) with custom abstractions that make it easy for students to navigate getting started. -1. [Visual Studio Live Share Extension](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare) integrating into a student view for easy access to teaching assistants and classmates for help and collaboration. -1. [{% data variables.product.prodname_dotcom %} Pull Request Extension](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) allowing students to see feedback from their instructors within the editor. - -### How to launch the assignment in {% data variables.product.prodname_vscode_shortname %} - -When creating an assignment, {% data variables.product.prodname_vscode_shortname %} can be added as the preferred editor for an assignment. For more details, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide). - -This will include an "Open in {% data variables.product.prodname_vscode_shortname %}" badge in all student repositories. This badge handles installing {% data variables.product.prodname_vscode_shortname %}, the Classroom extension pack, and opening to the active assignment with one click. - -> [!NOTE] -> The student must have Git installed on their computer to push code from {% data variables.product.prodname_vscode_shortname %} to their repository. This is not automatically installed when clicking the **Open in {% data variables.product.prodname_vscode_shortname %}** button. The student can download Git from [Git download](https://git-scm.com/downloads). - -### How to use {% data variables.product.prodname_classroom %} extension pack - -The {% data variables.product.prodname_classroom %} extension has two major components: the 'Classrooms' view and the 'Active Assignment' view. - -When the student launches the extension for the first time, they are automatically navigated to the Explorer tab in {% data variables.product.prodname_vscode_shortname %}, where they can see the "Active Assignment" view alongside the tree-view of files in the repository. - -The student can push their commits to the latest version of remote, by clicking the **sync changes** button, displayed when hovering over the "Active Assignment" line. This abstracts away source control with Git, allowing instructors to teach Git at their own pace. -Syncing changes also triggers "Tests" to run if a teacher has configured autograding for their assignment. - -The "Group" node under "Active Assignment" will show members of a group, if the assignment is a group project. It will also show the admin members of the repository who can help when a student is stuck. To collaborate on the project, a student can start a Live Share session with anyone in the group node, and they will immediately share the entire context of the repository with them. For more information about Live Share and collaborating with it, see [What is Visual Studio Live Share?](https://docs.microsoft.com/en-us/visualstudio/liveshare/). - -Once a student is done with the assignment, they can also navigate to see other Assignments and Classrooms. These can be found under the {% data variables.product.prodname_dotcom %} tab. diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/index.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/index.md deleted file mode 100644 index 984b5cf219f6..000000000000 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Integrate GitHub Classroom with an IDE -shortTitle: Integrate with an IDE -intro: 'You can help your students write, test, and debug code by preconfiguring a development environment for assignment repositories on {% data variables.product.prodname_classroom %}.' -versions: - fpt: '*' -children: - - /integrate-github-classroom-with-an-ide - - /using-github-codespaces-with-github-classroom - - /about-using-visual-studio-code-with-github-classroom - - /about-using-makecode-arcade-with-github-classroom - - /replit-with-github-classroom - - /run-student-code-in-an-ide ---- -{% data reusables.classroom.closing-down-notice %} diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md deleted file mode 100644 index c381f11a7068..000000000000 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Integrate GitHub Classroom with an IDE -shortTitle: Integrate with an IDE -intro: 'You can preconfigure a supported integrated development environment (IDE) for assignments you create in {% data variables.product.prodname_classroom %}.' -versions: - fpt: '*' -permissions: 'Organization owners who are admins for a classroom can integrate {% data variables.product.prodname_classroom %} with an IDE. {% data reusables.classroom.classroom-admins-link %}' -redirect_from: - - /education/manage-coursework-with-github-classroom/online-ide-integrations - - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-online-ide - - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-online-ide -category: - - Integrate GitHub Classroom with an IDE ---- -{% data reusables.classroom.closing-down-notice %} - -## About integration with an IDE - -{% data reusables.classroom.about-online-ides %} - -After a student accepts an assignment with an IDE, the README file in the student's assignment repository will contain a button to open the assignment in the IDE. The student can begin working immediately, and no additional configuration is necessary. - -## Supported IDEs - -{% data variables.product.prodname_classroom %} supports the following IDEs. You can learn more about the student experience for each IDE. - -| IDE | More information | -| :- | :- | -| {% data variables.product.prodname_github_codespaces %} | [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom) | -| Microsoft MakeCode Arcade | [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom) | -| {% data variables.product.prodname_vscode %} | [{% data variables.product.prodname_classroom %} extension](https://aka.ms/classroom-vscode-ext) in the Visual Studio Marketplace | - -We know cloud IDE integrations are important to your classroom and are working to bring more options. - -## Configuring an IDE for an assignment - -You can choose the IDE you'd like to use for an assignment when you create an assignment. To learn how to create a new assignment that uses an IDE, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment) or [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment). - -## Setting up an assignment in a new IDE - -The first time you configure an assignment using a different IDE, you must ensure that it is set up correctly. - -Unless you use {% data variables.product.prodname_github_codespaces %}, you must authorize the {% data variables.product.prodname_oauth_app %} for the IDE for your organization. For all repositories, grant the app **read** access to metadata, administration, and code, and **write** access to administration and code. For more information, see [AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps). - -{% data variables.product.prodname_github_codespaces %} does not require an {% data variables.product.prodname_oauth_app %}, but you need to enable {% data variables.product.prodname_github_codespaces %} for your organization to be able to configure an assignment with {% data variables.product.prodname_github_codespaces %}. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom#enabling-codespaces-for-your-organization). - -## Further reading - -* [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes) diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/replit-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/replit-with-github-classroom.md deleted file mode 100644 index c7970624bc3d..000000000000 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/replit-with-github-classroom.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Repl.it with GitHub Classroom -shortTitle: Repl.it with GitHub Classroom -intro: 'As of July 13 2021, Repl.it integration is no longer available in {% data variables.product.prodname_classroom %}.' -versions: - fpt: '*' -redirect_from: - - /education/manage-coursework-with-github-classroom/student-experience-replit - - /education/manage-coursework-with-github-classroom/about-using-replit-with-github-classroom - - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-replit-with-github-classroom -category: - - Integrate GitHub Classroom with an IDE ---- -{% data reusables.classroom.closing-down-notice %} - -## What’s changing with Repl.it integration - -As of July 13 2021, Repl.it integration is no longer available. Here’s what’s changed: - -* New private and public repls can no longer be created from within GitHub Classroom. -* Replit Hacker benefits, such as Always On and Boosts, are no longer available for new GitHub Classroom users. - -## What does this mean for existing assignments? - -Your existing GitHub Classroom repls will remain private forever and you can submit work to GitHub Classroom via these repls until September 30 2021. After September 2021, the Replit icon on the assignment README will no longer work. We suggest you remove the instructions from any README using the integration and let students know that the icon will no longer work. - -While you can no longer create private repls from within Classroom, you can continue to create private repls in Replit until September 30th. - -We know cloud IDE integrations are important to your classroom and are working hard to bring you more options. - -## Further reading - -* [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes) diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/run-student-code-in-an-ide.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/run-student-code-in-an-ide.md deleted file mode 100644 index f965ce1a5a60..000000000000 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/run-student-code-in-an-ide.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Run student code in an IDE -intro: You can run the code from a student assignment within the integrated development environment (IDE) that you configured for the assignment. -versions: - fpt: '*' -redirect_from: - - /education/manage-coursework-with-github-classroom/running-student-code - - /education/manage-coursework-with-github-classroom/run-student-code-in-an-online-ide - - /education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/run-student-code-in-an-online-ide -shortTitle: Run code in IDE -category: - - Track assignment progress ---- -{% data reusables.classroom.closing-down-notice %} - -## About student code and IDEs - -If you configure an integrated development environment (IDE) for an assignment, you can run the code within the IDE. You don't need to clone the assignment repository to your computer. - -For more information about IDEs, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide). - -## Running student code in the IDE - -{% data reusables.classroom.sign-into-github-classroom %} -{% data reusables.classroom.click-classroom-in-list %} -{% data reusables.classroom.click-assignment-in-list %} -1. To the right of the submission, click **View IDE**. diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md deleted file mode 100644 index ec257bd2e0e5..000000000000 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Using GitHub Codespaces with GitHub Classroom -shortTitle: Using Codespaces with GitHub Classroom -product: '{% data reusables.gated-features.codespaces-classroom-articles %}' -intro: 'You can use {% data variables.product.prodname_github_codespaces %} as the preferred editor in your assignments to give students access to a browser-based {% data variables.product.prodname_vscode %} environment with one-click setup.' -versions: - fpt: '*' -permissions: 'Organization owners who are admins for a classroom can enable {% data variables.product.prodname_github_codespaces %} for their organization and integrate {% data variables.product.prodname_github_codespaces %} as the supported editor for an assignment. {% data reusables.classroom.classroom-admins-link %}' -category: - - Integrate GitHub Classroom with an IDE ---- -{% data reusables.classroom.closing-down-notice %} - -## About {% data variables.product.prodname_github_codespaces %} - -{% data variables.product.prodname_github_codespaces %} is an instant, cloud-based development environment that uses a container to provide you with common languages, tools, and utilities for development. {% data variables.product.prodname_github_codespaces %} is also configurable, allowing you to create a customized development environment that is the same for all users of your project. See [AUTOTITLE](/codespaces/quickstart). - -Once {% data variables.product.prodname_github_codespaces %} is enabled in an organization or enterprise, users can create a codespace from any branch or commit in an organization or enterprise repository and begin developing using cloud-based compute resources. You can connect to a codespace from the browser or locally using {% data variables.product.prodname_vscode %}. - -{% data reusables.codespaces.links-to-get-started %} - -Setting {% data variables.product.prodname_github_codespaces %} as the preferred editor for an assignment in GitHub Classroom assignments, is beneficial for both students and teachers. {% data variables.product.prodname_github_codespaces %} is a good option for students using loaned devices or without access to a local IDE setup, since each codespace is cloud-based and requires no local setup. Students can launch a codespace for an assignment repository in {% data variables.product.prodname_vscode %} directly in their browser, and begin developing right away without needing any further configuration. - -For assignments with complex setup environments, teachers can customize the dev container configuration for a repository's codespaces. This ensures that when a student creates a codespace, it automatically opens with the development environment configured by the teacher. For more information on dev containers, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). - -> [!NOTE] -> Individual codespaces are automatically deleted if they are stopped and left unused for a prolonged period. See [AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces). - -{% data reusables.education.student-codespaces-benefit %} - -> [!NOTE] -> {% data reusables.education.note-on-student-codespaces-usage %} - -## About the {% data variables.product.prodname_codespaces %} Education benefit for verified teachers - -The {% data variables.product.prodname_codespaces %} Education benefit gives verified teachers a free monthly allowance of {% data variables.product.prodname_github_codespaces %} hours to use in {% data variables.product.prodname_classroom %}. The free allowance is estimated to be enough for a class of 50 with 5 assignments per month, on a 2 core machine with 1 codespace stored per student. - -{% data reusables.classroom.free-limited-codespaces-for-verified-teachers-beta-note %} - -To become a verified teacher, you need to be approved for an educator or teacher benefit. See [AUTOTITLE](/education/about-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher). - -After you have confirmation that you are a verified teacher, visit [{% data variables.product.prodname_global_campus %} for Teachers](https://education.github.com/globalcampus/teacher) to upgrade the organization to GitHub Team. See [GitHub's products](/get-started/learning-about-github/githubs-plans#github-team). - -If you are eligible for the {% data variables.product.prodname_codespaces %} Education benefit, when you enable {% data variables.product.prodname_github_codespaces %} in {% data variables.product.prodname_classroom %} for your organization, GitHub automatically adds a Codespace policy to restrict machine types for all codespaces in the organization to 2 core machines. This helps you make the most of the free {% data variables.product.prodname_github_codespaces %} usage. However, you can change or remove these policies in your organization settings. See [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types). - -When the {% data variables.product.prodname_codespaces %} Education benefit moves out of {% data variables.release-phases.public_preview %}, if your organization exceeds their free allowance for {% data variables.product.prodname_github_codespaces %} usage, your organization will be billed for additional usage. See [AUTOTITLE](/billing/concepts/product-billing/github-codespaces). - -## Enabling {% data variables.product.prodname_codespaces %} for your organization - -{% data variables.product.prodname_github_codespaces %} is available to use with {% data variables.product.prodname_classroom %} for organizations that use {% data variables.product.prodname_team %}. If you are eligible for the {% data variables.product.prodname_codespaces %} Education benefit, you must enable {% data variables.product.prodname_github_codespaces %} through {% data variables.product.prodname_classroom %}, instead of enabling it directly in your organization settings. Otherwise, your organization will be billed directly for all usage of {% data variables.product.prodname_github_codespaces %}. - -### Enabling Codespaces for an organization when creating a new classroom - -{% data reusables.classroom.sign-into-github-classroom %} -1. On the right side of the page, click **New classroom**. -1. In the list of organizations, click the organization you'd like to use for your classroom. Organizations that are eligible for {% data variables.product.prodname_github_codespaces %} will have a note showing that they are eligible. Optionally, you can create a new organization. See [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch). -1. In the "Name your classroom" page, under "{% data variables.product.prodname_codespaces %} in your Classroom", click **Enable**. Note that this will enable {% data variables.product.prodname_github_codespaces %} for all repositories and users in the organization. -1. When you are ready to create the new classroom, click **Create classroom**. - -### Enabling Codespaces for an organization via an existing classroom - -{% data reusables.classroom.sign-into-github-classroom %} -{% data reusables.classroom.click-classroom-in-list %} -{% data reusables.classroom.click-settings %} -1. Under "{% data variables.product.prodname_github_codespaces %}", click **Enable**. This will enable {% data variables.product.prodname_github_codespaces %} for all repositories and users in the organization. A new Codespace policy is also added to restrict machine types for all codespaces in the organization to 2 core machines. - -You can use the same methods as above to disable {% data variables.product.prodname_github_codespaces %} for your organization as well. Note that this will disable {% data variables.product.prodname_github_codespaces %} for all users and repositories in the organization. - -## Configuring an assignment to use {% data variables.product.prodname_codespaces %} - -To make {% data variables.product.prodname_github_codespaces %} available to students for an assignment, you can choose {% data variables.product.prodname_github_codespaces %} as the supported editor for the assignment. When creating a new assignment, in the "Add your starter code and choose your optional online IDE" page, under "Add a supported editor", select **{% data variables.product.prodname_github_codespaces %}** from the dropdown menu. - -If you use a template repository for an assignment, you can define a dev container in the repository to customize the tools and runtimes available to students when they launch a codespace to work on the assignment. If you do not define a dev container, {% data variables.product.prodname_github_codespaces %} will use a default configuration, which contains many of the common tools that your students might need for development. For more information on defining a dev container, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration). - -## Launching an assignment using {% data variables.product.prodname_github_codespaces %} - -When a student opens an assignment, the repository's README file includes their teacher's recommendation of the IDE they should use for the work. - -Students can launch a new or existing codespace by clicking the **Open in GitHub Codespace** button in the README, or by clicking the **{% octicon "code" aria-hidden="true" aria-label="code" %} Code** button on the main page of the assignment repository, then selecting the **Codespaces** tab. From the **Codespaces** tab you can select an existing codespace or create a new one. See [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository). - -![Screenshot of the assignment repository. The "Code" dropdown menu to launch a new codespace is expanded.](/assets/images/help/classroom/student-launch-new-codespace.png) - -Teachers can view each student's codespace for an assignment in the assignment overview page. You can click on the Codespaces icon on the right side of each student row to launch the codespace. - -![Screenshot of the assignment overview. The Codespaces icon is outlined in dark orange.](/assets/images/help/classroom/teacher-assignment-view-with-codespaces.png) - -When you connect to a codespace through a browser, auto-save is enabled automatically. If you want to save changes to the repository, you will need to commit the changes and push them to a remote branch. If you leave your codespace running without interaction for 30 minutes by default, the codespace will timeout and stop running. Your data will be preserved from the last time you made a change. For more information on the lifecycle of a codespace, see [AUTOTITLE](/codespaces/about-codespaces/understanding-the-codespace-lifecycle). diff --git a/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/index.md b/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/index.md deleted file mode 100644 index cdb6226f259f..000000000000 --- a/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Learn with GitHub Classroom -intro: 'You can participate in coursework in {% data variables.product.prodname_classroom %} and see results from your teacher.' -versions: - fpt: '*' -children: - - /view-autograding-results - - /viewing-your-assignments-deadline -shortTitle: Learn with Classroom ---- -{% data reusables.classroom.closing-down-notice %} \ No newline at end of file diff --git a/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md b/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md deleted file mode 100644 index 8f4e35d7d755..000000000000 --- a/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: View autograding results -intro: You can see results from autograding within the repository for your assignment. -versions: - fpt: '*' -redirect_from: - - /education/manage-coursework-with-github-classroom/reviewing-auto-graded-work-students - - /education/manage-coursework-with-github-classroom/view-autograding-results -category: - - Track assignment progress ---- -{% data reusables.classroom.closing-down-notice %} - -## About autograding - -Your teacher can configure tests that automatically check your work when you push to an assignment repository on {% data variables.location.product_location %}. - -If you're a student and your instructor has configured autograding for your assignment in {% data variables.product.prodname_classroom %}, you'll find autograding test results throughout your assignment repository. If all tests succeed for a commit, you'll see a green checkmark. If any tests fail for a commit, you'll see a red X. You can see detailed logs by clicking the green checkmark or red X. - -## Viewing autograding results for an assignment repository - -{% data variables.product.prodname_classroom %} uses {% data variables.product.prodname_actions %} to run autograding tests. For more information about viewing the logs for an autograding test, see [AUTOTITLE](/actions/how-tos/monitor-workflows/use-workflow-run-logs#viewing-logs-to-diagnose-failures). - -The **Actions** tab shows the full history of test runs. - -![Screenshot of the "Actions" tab with "All workflows" option in the left sidebar selected.](/assets/images/help/classroom/autograding-actions-tab.png) - -You can click a specific test run to review log output, like compilation errors and test failures. - -## Further reading - -* [AUTOTITLE](/pull-requests/reference/status-checks) diff --git a/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/viewing-your-assignments-deadline.md b/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/viewing-your-assignments-deadline.md deleted file mode 100644 index db4a59f91017..000000000000 --- a/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/viewing-your-assignments-deadline.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Viewing your assignment's deadline -intro: You can view the deadline for an assignment at any time through the README of your assignment repository. -versions: - fpt: '*' -shortTitle: View deadline -category: - - Track assignment progress ---- -{% data reusables.classroom.closing-down-notice %} - -## About assignment deadlines - -Your teacher can set an assignment deadline for assignments on {% data variables.product.prodname_classroom %}. If your teacher makes a deadline a hard cutoff, unless you or your group have received an extension, you will lose write access to your assignment repository after the deadline passes. You can easily monitor the deadline for an assignment through the README in your assignment repository. - -## Viewing an assignment's deadline - -1. Navigate to your assignment repository. -1. On the main page of your repository, scroll down until you see the repository's README, then click **{% octicon "calendar" aria-hidden="true" aria-label="calendar" %} Review the assignment due date**. Your assignment deadline is visible below the link to your assignment repository. The deadline shown updates automatically any time your teacher alters the assignment deadline. diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments.md deleted file mode 100644 index 54226e5c3041..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: About assignments -intro: You can use individual or group assignments in {% data variables.product.prodname_classroom %} to teach students and grade their work. -shortTitle: About assignments -versions: - fpt: '*' -contentType: concepts -category: - - Create and manage assignments ---- -{% data reusables.classroom.closing-down-notice %} - -## About assignments in {% data variables.product.prodname_classroom %} - -Assignments are coursework created for students in {% data variables.product.prodname_classroom %}. You can use assignments to test and grade your students, or to help your students practice their learnings. - -With {% data variables.product.prodname_classroom %}, you can create individual assignments, to be completed by a single student, or group assignments, to be completed in teams. For more information, see [Types of assignments](#types-of-assignments). - -{% data reusables.classroom.about-assignments %} - -{% data reusables.classroom.about-feedback-pull-requests %} - -{% data reusables.classroom.about-ide-integration %} - -{% data reusables.classroom.reuse-assignment-link %} - -> [!NOTE] -> {% data reusables.classroom.assignments-classroom-prerequisite %} - -## Types of assignments - -You can create both individual assignments and group assignments with {% data variables.product.prodname_classroom %}. - -### Individual assignments - -{% data reusables.classroom.assignments-individual-definition %} - -{% data reusables.classroom.classroom-creates-individual-repositories %} - -For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment). - -### Group assignments - -{% data reusables.classroom.assignments-group-definition %} Students can work together on a group assignment in a shared repository, like a team of professional developers. - -{% data reusables.classroom.about-teams-in-group-assignment %} - -For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment). - -## Further reading - -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment) -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment) -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment) 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 deleted file mode 100644 index c480cfddc561..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -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 -category: - - Set up GitHub Classroom ---- -{% data reusables.classroom.closing-down-notice %} - -## 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 [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom). - -> [!NOTE] -> {% data reusables.classroom.google-classroom-note %} - -To configure an LMS to connect to {% data variables.product.prodname_classroom %}, you must first create a classroom. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#creating-a-classroom). - -## Supported LMSes - -{% data reusables.classroom.supported-lmses %} - -## Linking a Blackboard course with a classroom - -You can link your Blackboard course with a classroom in {% data variables.product.prodname_classroom %}. For more information about Blackboard, see the [Blackboard website](https://www.anthology.com/products/teaching-and-learning/learning-effectiveness/blackboard). - -An administrator needs to register your LMS instance with classroom before you can link an LMS course. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom#configuring-blackboard-for-github-classroom). - -1. Sign into your **Blackboard** instance. -1. Select the Blackboard course or organization to integrate with {% data variables.product.prodname_classroom %}. -1. In the right sidebar on the course page, click **Books & Tools**, then click **GitHub Classroom**. Note that the name may be different if your LMS administrator named it something else when registering your LMS. -1. Click **{% data variables.product.prodname_classroom %}**. -1. In {% data variables.product.prodname_classroom %}, select a classroom to link with your LMS course. - - > [!NOTE] This step might give you an error message, "Unable to launch link. The Tool Provider has been disabled by the System Administrator: {% data variables.product.prodname_classroom %}". To resolve this error, ensure that the status of the “{% data variables.product.prodname_classroom %}” tool is set to `Approved`. In the "Admin Panel," click **LTI Tool Providers**. Hover on the name next to {% data variables.product.prodname_classroom %} and click **Approve**. - -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 Canvas course with a classroom - -You can link your Canvas 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 [AUTOTITLE](/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 %}. -1. Click **Setting** in the left sidebar, then click the **Apps** tab. -1. Click the **+ App** button. -1. Under "Configuration Type", select **By Client ID** from the dropdown menu. -1. Under "Client ID", input the Client ID that your LMS administrator created when registering your LMS instance with {% data variables.product.prodname_classroom %}. -1. Click **Submit**, then click **Install**. -1. 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. -1. 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 [AUTOTITLE](/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 %}. -1. 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. -1. 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 [AUTOTITLE](/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. -1. Select the Sakai course to integrate with {% data variables.product.prodname_classroom %}. -1. Click on **External Tools**. -1. Click on **Tool Links**. -1. 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. -1. Click the **Import from...** button containing the name of your LMS (Canvas, Sakai, or Moodle). -1. 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. -1. Click the **Sync from...** button containing the name of your LMS (Canvas, Sakai, or Moodle). - -## 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 [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#deleting-a-roster-for-a-classroom) and [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom). - * For more information about updating a roster, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#adding-students-to-the-roster-for-your-classroom). -1. In the list of LMSes, click **Google Classroom**. -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**. -1. Under "Delete Connection to your learning management system", click **Disconnect from your learning management system**. 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 deleted file mode 100644 index a267f961e175..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: Create a group assignment -intro: You can create a collaborative assignment for teams of students who participate in your course. -versions: - fpt: '*' -permissions: 'Organization owners who are admins for a classroom can create and manage group assignments for a classroom. {% data reusables.classroom.classroom-admins-link %}' -redirect_from: - - /education/manage-coursework-with-github-classroom/create-group-assignments - - /education/manage-coursework-with-github-classroom/create-a-group-assignment -category: - - Create and manage assignments ---- -{% data reusables.classroom.closing-down-notice %} - -## About group assignments - -{% data reusables.classroom.assignments-group-definition %} Students can work together on a group assignment in a shared repository, like a team of professional developers. - -{% data reusables.classroom.about-teams-in-group-assignment %} - -{% data reusables.classroom.classroom-creates-group-repositories %} - -{% data reusables.classroom.about-assignments %} - -You can decide how many teams one assignment can have, and how many members each team can have. Each team that a student creates for an assignment is a team within your organization on {% data variables.product.github %}. The visibility of the team is secret. Teams that you create on {% data variables.product.github %} will not appear in {% data variables.product.prodname_classroom %}. For more information, see [AUTOTITLE](/organizations/organizing-members-into-teams/about-teams). - -{% data reusables.classroom.reuse-assignment-link %} - -## Prerequisites - -{% data reusables.classroom.assignments-classroom-prerequisite %} - -## Creating an assignment - -{% data reusables.classroom.assignments-guide-create-the-assignment %} - -## Setting up the basics for an assignment - -Name your assignment, decide whether to assign a deadline, define teams, and choose the visibility of assignment repositories. - -* [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) -* [Defining teams for an assignment](#defining-teams-for-an-assignment) -* [Choosing a visibility for assignment repositories](#choosing-a-visibility-for-assignment-repositories) - -### Naming an assignment - -For a group assignment, {% data variables.product.prodname_classroom %} names repositories by the repository prefix and the name of the team. By default, the repository prefix is the assignment title. For example, if you name an assignment "assignment-1" and the team's name on {% data variables.product.github %} is "student-team", the name of the assignment repository for members of the team will be `assignment-1-student-team`. - -{% data reusables.classroom.assignments-type-a-title %} - -### Assigning a deadline for an assignment - -{% data reusables.classroom.assignments-guide-assign-a-deadline %} - -{% data reusables.classroom.assignments-guide-make-cutoff-date %} - -### Choosing an assignment type - -Under "Individual or group assignment", select the drop-down menu, then click **Group assignment**. You can't change the assignment type after you create the assignment. If you'd rather create an individual assignment, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment). - -### Defining teams for an assignment - -If you've already created a group assignment for the classroom, you can reuse a set of teams for the new assignment. To create a new set with the teams that your students create for the assignment, type the name for the set. Optionally, type the maximum number of team members and total teams. - -> [!NOTE] -> * We recommend including details about the set of teams in the name for the set. For example, if you want to use the set of teams for one assignment, name the set after the assignment. If you want to reuse the set throughout a semester or course, name the set after the semester or course. -> * If you'd like to assign students to a specific team, give your students a name for the team and provide a list of members. - -### Choosing a visibility for assignment repositories - -{% data reusables.classroom.assignments-repository-visibility-and-permissions %} - -{% data reusables.classroom.assignments-guide-choose-visibility %} - -{% data reusables.classroom.assignments-guide-click-continue-after-basics %} - -## Adding starter code and configuring a development environment - -{% data reusables.classroom.assignments-guide-intro-for-environment %} - -* [Choosing a template repository](#choosing-a-template-repository) -* [Choosing an integrated development environment (IDE)](#choosing-an-integrated-development-environment-ide) - -### Choosing a template repository - -By default, a new assignment will create an empty repository for each team that a student creates. {% data reusables.classroom.you-can-choose-a-template-repository %} - -{% data reusables.classroom.assignments-guide-choose-template-repository %} - -### Choosing an integrated development environment (IDE) - -{% data reusables.classroom.about-online-ides %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide). - -{% data reusables.classroom.classroom-codespaces-link %} - -{% data reusables.classroom.assignments-guide-choose-an-online-ide %} - -{% data reusables.classroom.assignments-guide-click-continue-after-starter-code-and-feedback %} - -## Providing feedback - -Optionally, you can automatically grade assignments and create a space for discussing each submission with the team. - -* [Testing assignments automatically](#testing-assignments-automatically) -* [Creating a pull request for feedback](#creating-a-pull-request-for-feedback) - -### Testing assignments automatically - -{% data reusables.classroom.assignments-guide-using-autograding %} - -### Designating protected file paths - -{% data reusables.classroom.assignments-guide-protected-paths %} - -### Creating a pull request for feedback - -{% data reusables.classroom.you-can-create-a-pull-request-for-feedback %} For more information on leaving feedback in a pull request, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests). - -{% data reusables.classroom.assignments-guide-create-review-pull-request %} - -{% data reusables.classroom.assignments-guide-click-create-assignment-button %} - -## Inviting students to an assignment - -{% data reusables.classroom.assignments-guide-invite-students-to-assignment %} - -You can see the teams that are working on or have submitted an assignment in the **Teams** tab for the assignment. {% data reusables.classroom.assignments-to-prevent-submission %} - -## Monitoring students' progress - -{% data reusables.classroom.link-to-assignment-overview-article %} - -## Next steps - -* After you create the assignment and your students form teams, team members can start work on the assignment using Git and {% data variables.product.github %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and the team can review the commit history for the repository. For more information, see [AUTOTITLE](/get-started), [AUTOTITLE](/repositories), [AUTOTITLE](/get-started/using-git), and [AUTOTITLE](/pull-requests), and the free course on [resolving merge conflicts](https://github.com/skills/resolve-merge-conflicts) from {% data variables.product.prodname_learning %}. - -* When a team finishes an assignment, you can review the files in the repository, or you can review the history and visualizations for the repository to better understand how the team collaborated. For more information, see [AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository). - -* You can provide feedback for an assignment by commenting on individual commits or lines in a pull request. For more information, see [AUTOTITLE](/pull-requests/how-tos/review-pull-requests/commenting-on-a-pull-request) and [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/creating-an-issue). For more information about creating saved replies to provide feedback for common errors, see [AUTOTITLE](/get-started/writing-on-github/working-with-saved-replies/about-saved-replies). - -## Further reading - -* [{% data variables.product.prodname_global_campus %} for teachers](/education/about-github-education/github-education-for-teachers) -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom) -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli) diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md deleted file mode 100644 index 89bed4e8e60a..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Create an assignment from a template repository -intro: 'You can create an assignment from a template repository to provide starter code, documentation, and other resources to your students.' -permissions: 'Organization owners who are admins for a classroom can create an assignment from a template repository that is public or owned by the organization. {% data reusables.classroom.classroom-admins-link %}' -versions: - fpt: '*' -redirect_from: - - /education/manage-coursework-with-github-classroom/using-template-repos-for-assignments - - /education/manage-coursework-with-github-classroom/create-an-assignment-from-a-template-repository -shortTitle: Template repository -category: - - Create and manage assignments ---- -{% data reusables.classroom.closing-down-notice %} - -You can use a template repository on {% data variables.product.github %} as starter code for an assignment on {% data variables.product.prodname_classroom %}. Your template repository can contain boilerplate code, documentation, and other resources for your students. For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-template-repository). - -To use the template repository for your assignment, the template repository must be owned by your organization, or the visibility of the template repository must be public. - -When you create your assignment, {% data variables.product.prodname_classroom %} creates a new repository from the template in your organization with the visibility you select (for more information on creating repositories from templates, see [AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)). - -Student assignment repositories will be forks of this created repository. You can choose whether all branches are included in student assignment repositories, or just the default branch. - -You can reuse an existing assignment, even if it uses a template repository, in any other classroom that you have admin access to, including classrooms in a different organization. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment). - -## Further reading - -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment) -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment) -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli) 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 deleted file mode 100644 index 248c3443fc11..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: Create an individual assignment -intro: You can create an assignment for students in your course to complete individually. -versions: - fpt: '*' -permissions: 'Organization owners who are admins for a classroom can create and manage individual assignments for a classroom. {% data reusables.classroom.classroom-admins-link %}' -redirect_from: - - /education/manage-coursework-with-github-classroom/creating-an-individual-assignment - - /education/manage-coursework-with-github-classroom/create-an-individual-assignment -shortTitle: Individual assignment -category: - - Create and manage assignments ---- -{% data reusables.classroom.closing-down-notice %} - -## About individual assignments - -{% data reusables.classroom.assignments-individual-definition %} - -{% data reusables.classroom.classroom-creates-individual-repositories %} - -{% data reusables.classroom.about-assignments %} - -{% data reusables.classroom.reuse-assignment-link %} - -## Prerequisites - -{% data reusables.classroom.assignments-classroom-prerequisite %} - -## Creating an assignment - -{% data reusables.classroom.assignments-guide-create-the-assignment %} - -## Setting up the basics for an assignment - -Name your assignment, decide whether to assign a deadline, and choose the visibility of assignment repositories. - -* [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) - -### Naming an assignment - -For an individual assignment, {% data variables.product.prodname_classroom %} names repositories by the repository prefix and the student's {% data variables.product.github %} 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.github %} 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 %} - -{% data reusables.classroom.assignments-guide-make-cutoff-date %} - -### Choosing an assignment type - -Under "Individual or group assignment", select the drop-down menu, and click **Individual assignment**. You can't change the assignment type after you create the assignment. If you'd rather create a group assignment, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment). - -### Choosing a visibility for assignment repositories - -{% data reusables.classroom.assignments-repository-visibility-and-permissions %} - -{% data reusables.classroom.assignments-guide-choose-visibility %} - -{% data reusables.classroom.assignments-guide-click-continue-after-basics %} - -## Adding starter code and configuring a development environment - -{% data reusables.classroom.assignments-guide-intro-for-environment %} - -* [Choosing a template repository](#choosing-a-template-repository) -* [Choosing an integrated development environment (IDE)](#choosing-an-integrated-development-environment-ide) - -### Choosing a template repository - -By default, a new assignment will create an empty repository for each student on the roster for the classroom. {% data reusables.classroom.you-can-choose-a-template-repository %} - -{% data reusables.classroom.assignments-guide-choose-template-repository %} - -{% data reusables.classroom.assignments-guide-click-continue-after-starter-code-and-feedback %} - -### Choosing an integrated development environment (IDE) - -{% data reusables.classroom.about-online-ides %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide). - -{% data reusables.classroom.classroom-codespaces-link %} - -{% data reusables.classroom.assignments-guide-choose-an-online-ide %} - -## Providing feedback for an assignment - -Optionally, you can automatically grade assignments and create a space for discussing each submission with the student. - -* [Testing assignments automatically](#testing-assignments-automatically) -* [Creating a pull request for feedback](#creating-a-pull-request-for-feedback) - -### Testing assignments automatically - -{% data reusables.classroom.assignments-guide-using-autograding %} - -### Designating protected file paths - -{% data reusables.classroom.assignments-guide-protected-paths %} - -### Creating a pull request for feedback - -{% data reusables.classroom.you-can-create-a-pull-request-for-feedback %} For more information on leaving feedback in a pull request, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests). - -{% data reusables.classroom.assignments-guide-create-review-pull-request %} - -{% data reusables.classroom.assignments-guide-click-create-assignment-button %} - -## 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 **Classroom roster** tab for the assignment. You can also link students' {% data variables.product.prodname_dotcom %} aliases to their associated roster identifier and vice versa in this tab. {% data reusables.classroom.assignments-to-prevent-submission %} - -## Monitoring students' progress - -{% data reusables.classroom.link-to-assignment-overview-article %} - -## Next steps - -* Once you create the assignment, students can start work on the assignment using Git and {% data variables.product.github %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and student can review the commit history for the repository. For more information, see [AUTOTITLE](/get-started), [AUTOTITLE](/repositories), and [AUTOTITLE](/pull-requests). - -* When a student finishes an assignment, you can review the files in the repository, or you can review the history and visualizations for the repository to better understand the student's work. For more information, see [AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository). - -* You can provide feedback for an assignment by commenting on individual commits or lines in a pull request. For more information, see [AUTOTITLE](/pull-requests/how-tos/review-pull-requests/commenting-on-a-pull-request) and [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/creating-an-issue). For more information about creating saved replies to provide feedback for common errors, see [AUTOTITLE](/get-started/writing-on-github/working-with-saved-replies/about-saved-replies). - -## Further reading - -* [AUTOTITLE](/education/about-github-education/github-education-for-teachers) -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom) -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli) diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/editing-an-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/editing-an-assignment.md deleted file mode 100644 index 9169c2ffcf4b..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/editing-an-assignment.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: Editing an assignment -intro: You can edit existing assignments in your course. -versions: - fpt: '*' -permissions: 'Organization owners who are admins for a classroom can edit assignments for that classroom. {% data reusables.classroom.classroom-admins-link %}' -shortTitle: Edit an assignment -category: - - Create and manage assignments ---- -{% data reusables.classroom.closing-down-notice %} - -## About editing assignments - -After creating an assignment, you can edit many aspects of the assignment to better fit the needs of yourself and your students. Be aware that you cannot change the assignment type (either individual or group) or the online integrated development environment (IDE) after assignment creation. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment) and [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment). - -## Editing an existing assignment - -{% data reusables.classroom.sign-into-github-classroom %} -{% data reusables.classroom.click-classroom-in-list %} -1. In the **{% octicon "repo" aria-hidden="true" aria-label="repo" %} Assignments** tab, next to the assignment you would like to edit, click {% octicon "pencil" aria-label="The pencil icon" %}. - - > [!NOTE] - > You can also edit an assignment from the assignment's page. To access the assignment's page, in the **Assignments** tab, click the assignment name. - -1. Under "Assignment title," click in the text field, then delete the existing text and type the new assignment title. -1. Optionally, to edit the default prefix for each student's assignment repository, next to the name of the prefix, click {% octicon "pencil" aria-label="The pencil icon" %}. - - > [!NOTE] - > Editing an assignment's title or default repository prefix will not change the name of existing assignment repositories. - - Then, type the new prefix under "Custom repository prefix." - -1. Under "Deadline (optional)," click in the text field, then use the date picker to reassign a deadline. The new deadline cannot be in the past, and reassigning a deadline will update the deadline for all students. - - {% data reusables.classroom.assignments-guide-make-cutoff-date %} - -1. To change the status of an assignment, select the **Assignment status** dropdown menu, then click **Active** or **Inactive**. - - > [!NOTE] - > Inactive assignments cannot be accepted by students. You should change an assignment status to inactive once no more students should accept an assignment or the assignment deadline has passed. - -1. Under "Repository visibility," select a visibility. If you use private repositories, only the student or team can see the feedback you provide. - - > [!NOTE] - > Changing the visibility for assignment repositories will not retroactively change the visibility of existing assignment repositories. - -1. Optionally, select or deselect **Grant students admin access to their repository**. For more information on admin permissions for repositories, see [AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility) and [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization). - - > [!NOTE] - > Granting or revoking student admin access after an assignment has been created will not retroactively change the permissions for existing assignment repositories. - -1. To set up or change the template repository for your assignment, in the "Add a template repository to give students starter code" section, select the **Select a repository** dropdown menu. - * To choose a template repository, begin typing the repository name in the text field, then click the repository in the search results. - * To remove a template repository, delete any text in the text field. - - You cannot change the template repository after a student has accepted the assignment. If you wish to provide updates to the starter code after students have accepted the assignment, see [Making changes to assignment starter code](#making-changes-to-assignment-starter-code). - - > [!NOTE] - > By default, an assignment will create an empty repository for each student on the roster for the classroom. - -1. To add a new autograding test, in the "Add autograding tests" section, select the **Add test** dropdown menu, then click a grading method from the options that appear. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding). - - Additionally, you can edit or delete existing autograding tests with {% octicon "pencil" aria-label="The pencil icon" %} or {% octicon "trash" aria-label="The trash icon" %}. - -1. To add new protected path, in the "Protected file paths" section, type out the file or path and click **Add path**. - - Additionally, delete existing protected paths by clicking {% octicon "trash" aria-label="The trash icon" %}. - - > [!NOTE] - > If you remove a protected file path, the "Protected file(s) modified" label will be removed from any submissions that edited files in that path - -1. To turn feedback pull requests on or off, select or deselect **Enable feedback pull requests**. - - > [!NOTE] - > Enabling or disabling feedback pull requests for an assignment will not create or delete feedback pull requests for existing assignment repositories. - -{% data reusables.classroom.update-assignment %} - -## Making changes to assignment starter code - -If you need to update the starter code for your assignment after students have already accepted it, you can do so by modifying the original repository. Since student assignments are based on forks of this repository, you can make changes to the starter code and then create pull requests for students to merge these updates into their assignments. See, [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository). - -{% data reusables.classroom.sign-into-github-classroom %} -{% data reusables.classroom.click-classroom-in-list %} - -1. Select the assignment that has a starter code repository. -1. Below the title of the assignment, click the link to your starter code repository. -1. Make the necessary changes to your starter code's content. -1. Return to the assignment overview page. -1. Click **Sync assignments**. If changes are detected, an **Assignments are out of date** button will be shown. -1. To open pull requests in all of your students' assignment repositories, click **Assignments are out of date**. - -The pull requests will be titled "{% data variables.product.prodname_classroom %}: Sync Assignment". Ask your students to merge these pull requests. - -## Further reading - -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment) -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment) diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/extending-an-assignments-deadline-for-an-individual-or-group.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/extending-an-assignments-deadline-for-an-individual-or-group.md deleted file mode 100644 index 099afc99c92c..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/extending-an-assignments-deadline-for-an-individual-or-group.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Extending an assignment's deadline for an individual or group -intro: You can grant individual students and groups extensions to allow them more time to submit an assignment. -versions: - fpt: '*' -shortTitle: Extend deadline -category: - - Create and manage assignments ---- -{% data reusables.classroom.closing-down-notice %} - -## About extending assignment deadlines - -If you set a cutoff date for an assignment in {% data variables.product.prodname_classroom %}, individual students and groups will lose write access to their assignment repositories once that date has passed. To extend access to assignment repositories for specific students or groups, you can grant those students or groups an extension for that assignment. Extensions extend the cutoff date indefinitely, allowing students to submit an assignment at any time. For more information on setting a cutoff date, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment#assigning-a-deadline-for-an-assignment) and [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment#assigning-a-deadline-for-an-assignment). - -> [!NOTE] -> * If your assignment has a deadline, but it does not have a cutoff date, you will not be able to grant students extensions. Instead, you can inform the student or group of their extension directly and ignore the "Late" label applied to the student or group's entry on the assignment overview. -> * If you grant a student or group an extension, and they submit their work after the initial cutoff date, the assignment will still be marked "Late". You can ignore the "Late" label, as it will not affect the student or group's grade, or write access to their assignment repository. - -## Extending an assignment's deadline - -{% data reusables.classroom.sign-into-github-classroom %} -1. Navigate to your classroom. -1. Open the assignment for which you would like to grant an extension. -1. In your classroom's roster, find the student or group you would like to grant an extension. In that student or group's row, select {% octicon "kebab-horizontal" aria-label="the dropdown menu" %}, then click **{% octicon "calendar" aria-hidden="true" aria-label="calendar" %} Extend deadline**. - - ![Screenshot of the assignment overview page. An expanded dropdown menu containing the "Extend deadline" option is outlined in dark orange.](/assets/images/help/classroom/classroom-extend-deadline.png) - -1. In the modal that appears, select **Extend STUDENT OR GROUP'S assignment deadline**, then click **I understand, extend the deadline**. A "Deadline extended" label will appear next to that student or group's name in the classroom roster. -1. Optionally, to revoke an extension, select {% octicon "kebab-horizontal" aria-label="the dropdown menu" %}, then click **{% octicon "calendar" aria-hidden="true" aria-label="calendar" %} Revoke extension**. - - In the modal that appears, select **Revoke STUDENT OR GROUP'S assignment extension**, then click **I understand, revoke the extension**. The "Deadline extended" label will be removed from the student or group's entry in the classroom roster. 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 deleted file mode 100644 index 71f0b8c26eed..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Teach with GitHub Classroom -intro: Learn how to set up your classroom and assignments. -versions: - fpt: '*' -redirect_from: - - /education/manage-coursework-with-github-classroom/configure-default-settings-for-assignment-repositories - - /education/manage-coursework-with-github-classroom/probot-settings -children: - - /manage-classrooms - - /about-assignments - - /use-the-git-and-github-starter-assignment - - /create-an-individual-assignment - - /create-a-group-assignment - - /editing-an-assignment - - /extending-an-assignments-deadline-for-an-individual-or-group - - /monitor-students-progress-with-the-assignment-overview-page - - /reuse-an-assignment - - /create-an-assignment-from-a-template-repository - - /leave-feedback-with-pull-requests - - /use-autograding - - /using-github-classroom-with-github-cli - - /register-a-learning-management-system-with-github-classroom - - /connect-a-learning-management-system-course-to-a-classroom -shortTitle: Teach ---- -{% data reusables.classroom.closing-down-notice %} \ No newline at end of file diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests.md deleted file mode 100644 index 4603bc5be848..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Leave feedback with pull requests -intro: You can leave feedback for your students in a special pull request within the repository for each assignment. -permissions: People with read permissions to a repository can leave feedback in a pull request for the repository. -versions: - fpt: '*' -redirect_from: - - /education/manage-coursework-with-github-classroom/leaving-feedback-in-github - - /education/manage-coursework-with-github-classroom/leave-feedback-with-pull-requests -shortTitle: Pull requests -category: - - Track assignment progress ---- -{% data reusables.classroom.closing-down-notice %} - -## About feedback pull requests for assignments - -{% data reusables.classroom.you-can-create-a-pull-request-for-feedback %} - -When you enable the pull request for feedback for an assignment, {% data variables.product.prodname_classroom %} will create a special pull request titled **Feedback** in the assignment repository for each student or team. The pull request automatically shows every commit that a student pushed to the assignment repository's default branch. - -## Prerequisites - -To create and access the feedback pull request, you must enable the feedback pull request when you create the assignment. {% data reusables.classroom.for-more-information-about-assignment-creation %} - -## Leaving feedback in a pull request for an assignment - -{% data reusables.classroom.sign-into-github-classroom %} -1. In the list of classrooms, click the classroom with the assignment you want to review. -{% data reusables.classroom.click-assignment-in-list %} -1. Each student will have a submission row, press the Feedback link to navigate to the student's pull request. -1. On the Feedback PR select the Files changed tab. -1. Review the pull request. For more information, see [AUTOTITLE](/pull-requests/how-tos/review-pull-requests/commenting-on-a-pull-request). - -## Further reading - -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide) 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 deleted file mode 100644 index 091ff3c84e48..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: Manage classrooms -intro: 'You can create and manage a classroom for each course that you teach using {% data variables.product.prodname_classroom %}.' -permissions: 'Organization owners who are admins for a classroom can manage the classroom for an organization. {% data reusables.classroom.classroom-admins-link %}' -versions: - fpt: '*' -redirect_from: - - /education/manage-coursework-with-github-classroom/archive-a-classroom - - /education/manage-coursework-with-github-classroom/manage-classrooms -category: - - Set up GitHub Classroom ---- -{% data reusables.classroom.closing-down-notice %} - -## About classrooms - -{% data reusables.classroom.about-classrooms %} - -## About management of classrooms - -{% data variables.product.prodname_classroom %} uses organization accounts on {% data variables.product.github %} to manage permissions, administration, and security for each classroom that you create. Each organization can have multiple classrooms. - -After you create a classroom, {% data variables.product.prodname_classroom %} will prompt you to invite teaching assistants (TAs) and admins to the classroom. Each classroom can have one or more admins. Admins can be teachers, TAs, or any other course administrator who you'd like to have control over your classrooms on {% data variables.product.prodname_classroom %}. - -Invite TAs and admins to your classroom by inviting the personal accounts on {% data variables.product.github %} to your organization as organization owners and sharing the URL for your classroom. Organization owners can administer any classroom for the organization. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization) and [AUTOTITLE](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization). - -When you're done using a classroom, you can archive the classroom and refer to the classroom, roster, and assignments later, or you can delete the classroom if you no longer need the classroom. - -{% data reusables.classroom.reuse-assignment-link %} - -You can also view your classrooms and assignments directly from the {% data variables.product.github %} command line interface with the {% data variables.product.prodname_classroom %} extension. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli). - -## About classroom rosters - -Each classroom has a roster. A roster is a list of identifiers for the students who participate in your course. - -When you first share the URL for an assignment with a student, the student must sign into {% data variables.product.github %} with a personal account to link the personal account to an identifier for the classroom. After the student links a personal account, you can see the associated personal account in the roster. You can also see when the student accepts or submits an assignment. - -## Prerequisites - -You must have an organization account on {% data variables.product.github %} to manage classrooms on {% data variables.product.prodname_classroom %}. For more information, see [AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts#organization-accounts) and [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch). - -You must authorize the {% data variables.product.prodname_oauth_app %} for {% data variables.product.prodname_classroom %} for your organization to manage classrooms for your organization account. For more information, see [AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps). - -## Creating a classroom - -{% data reusables.classroom.sign-into-github-classroom %} -1. Click **New classroom** on the right side of the page. -{% data reusables.classroom.guide-create-new-classroom %} - -After you create a classroom, you can begin creating assignments for students. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment), [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment), [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment), or [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment). - -## Creating a roster for your classroom - -You can create a roster of the students who participate in your course. - -If your course already has a roster, you can update the students on the roster or delete the roster. For more information, see [Adding a student to the roster for your classroom](#adding-students-to-the-roster-for-your-classroom) or [Deleting a roster for a classroom](#deleting-a-roster-for-a-classroom). - -{% 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, 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 [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom). - - > [!NOTE] - > {% data reusables.classroom.google-classroom-note %} - -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 in the text field. - -1. Click **Create roster**. - -## Adding students to the roster for your classroom - -Your classroom must have an existing roster to add students to the roster. For more information about creating a roster, see [Creating a roster for your classroom](#creating-a-roster-for-your-classroom). - -{% 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**. If you have already linked your classroom to an LMS course, then you will see a **Sync from...** button instead. -1. Follow the instructions to add students to the roster. - * 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 [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom). - - > [!NOTE] - > {% data reusables.classroom.google-classroom-note %} - - * 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**. - -## Renaming a classroom - -{% data reusables.classroom.sign-into-github-classroom %} -{% data reusables.classroom.click-classroom-in-list %} -{% data reusables.classroom.click-settings %} -1. Under "Classroom name", type a new name for the classroom. -1. Click **Rename classroom**. - -## Archiving or unarchiving a classroom - -You can archive a classroom that you no longer use on {% data variables.product.prodname_classroom %}. When you archive a classroom, you can't create new assignments or edit existing assignments for the classroom. Students can't accept invitations to assignments in archived classrooms. - -{% data reusables.classroom.sign-into-github-classroom %} -1. To the right of a classroom's name, select the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} dropdown menu, then click **Archive**. - - ![Screenshot of a tile for a classroom. A dropdown menu labeled with a kebab icon is expanded and the "Archive" option is outlined in dark orange.](/assets/images/help/classroom/use-drop-down-then-click-archive.png) - -1. To view an archived classroom, use the dropdown menu next to the search bar to change the view to "Archived" or "All". -1. To unarchive a classroom, to the right of a classroom's name, select the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} drop-down menu, then click **Unarchive**. - - ![Screenshot of a tile for a classroom. A dropdown menu labeled with a kebab icon is expanded and the "Unarchive" option is outlined in dark orange.](/assets/images/help/classroom/use-drop-down-then-click-unarchive.png) - -## Deleting a roster for a classroom - -{% data reusables.classroom.sign-into-github-classroom %} -{% data reusables.classroom.click-classroom-in-list %} -{% data reusables.classroom.click-students %} -1. Below the list of students, under "Delete this roster", click **Delete roster**. -1. Read the warnings, then click **Delete roster**. - -## Deleting a classroom - -{% data reusables.classroom.sign-into-github-classroom %} -{% data reusables.classroom.click-classroom-in-list %} -{% data reusables.classroom.click-settings %} -1. To the right of "Delete this classroom", click **Delete classroom**. -1. **Read the warnings**. -1. To verify that you're deleting the correct classroom, type the name of the classroom you want to delete. -1. Click **Delete classroom**. - -## Further reading - -* [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli) diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page.md deleted file mode 100644 index 9c277bfab327..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Monitor students' progress with the assignment overview page -shortTitle: Use assignment overview -intro: You can use the assignment overview page to track the progress of each student or team on an assignment. -versions: - fpt: '*' -permissions: 'Organization owners who are admins for a classroom can create and manage group assignments for a classroom. {% data reusables.classroom.classroom-admins-link %}' -category: - - Track assignment progress ---- -{% data reusables.classroom.closing-down-notice %} - -## About the assignment overview page - -Each assignment you create on {% data variables.product.prodname_classroom %} has an assignment overview page. The assignment overview page provides an overview of your assignment acceptances and student progress. You may see different summary information on an assignment overview page based on the configurations of your assignments. - -For individual assignments, you can view the following information at the top of the assignment overview page: - -* **Rostered students:** The number of students on the classroom's roster. -* **Added students:** The number of {% data variables.product.prodname_dotcom %} accounts that have accepted the assignment and are not associated with a roster identifier. -* **Accepted students:** The number of accounts that have accepted this assignment. -* **Assignment submissions:** The number of students that have submitted the assignment. Submission is triggered at the assignment deadline. -* **Passing students:** The number of students currently passing the autograding tests for this assignment. - -For group assignments, you can view the following information at the top of the assignment overview page: - -* **Total teams:** The number of teams that have been created. -* **Rostered students:** The number of students on the classroom's roster. -* **Students not on a team:** The number of students on the classroom roster who have not yet joined a team. -* **Accepted teams:** The number of teams who have accepted this assignment. -* **Assignment submissions:** The number of teams that have submitted the assignment. Submission is triggered at the assignment deadline. -* **Passing teams:** The number of teams that are currently passing the autograding tests for this assignment. - -## Viewing the assignment overview page for an assignment - -The assignment overview page displays information for a specific assignment. You can view general information at a glance, or apply searches, sorts, and filters to find students or teams that meet specific criteria. - -{% data reusables.classroom.sign-into-github-classroom %} -1. Navigate to a classroom. -1. To open the assignment overview page for an assignment, in the "Assignments" section, click the name of that assignment. - -## Searching and sorting the assignment overview page - -You can search and sort the assignment overview page to find specific students or teams. - -1. To find a specific student or team on the assignment overview page, in the search bar, type the student's {% data variables.product.prodname_dotcom %} handle, the student's identifier, or the team's name, then press Enter or Return. - - If the search term you enter matches multiple students or teams, each student or team will be shown in the search results. For example, if you have two students with the {% data variables.product.prodname_dotcom %} handles "@octocat" and "@monacat", and you search for "cat", both "@octocat" and "@monacat" will appear in the search results. -1. To sort the students or teams displayed on an assignment overview page, select **Sort by:** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %}, then click **Alphabetical A-Z**, **Alphabetical Z-A**, **Newest**, or **Oldest**. - - The **Newest** sort orders the results from the most recently updated assignment to the least recently updated assignment, while the **Oldest** sort does the opposite. -{% data reusables.classroom.clear-all-assignment-overview %} - -## Filtering the assignment overview page - -Using a series of dropdown menus, you can apply multiple filters to the assignment overview page to search for students or teams based on specific criteria. You can even apply multiple filters from a single dropdown menu to include all students or teams that match the criteria. - -1. To filter for students with unlinked accounts, select the **Unlinked accounts** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click **Student identifiers** or **{% data variables.product.prodname_dotcom %} accounts**. -1. To filter by which students have or haven't accepted the assignment, select the **Accepted** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click **Accepted** or **Unaccepted**. -1. To filter by the submission status for each student's assignment repository, select the **Submitted** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click **Submitted**, **On-time**, **Late**, or **Not submitted**. -1. To filter for students by passing or failing grades, select the **Passing** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click **Passing** or **Failing**. -1. To unapply a filter, select the associated dropdown menu, then click the filter once more. A {% octicon "check" aria-hidden="true" aria-label="check" %} is displayed alongside the name of an applied filter, while unapplied filters only display their names. -{% data reusables.classroom.clear-all-assignment-overview %} - -## Downloading assignment details - -{% data reusables.classroom.download-results %} 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 deleted file mode 100644 index e2fe93adf3bd..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -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 -category: - - Set up GitHub Classroom ---- -{% data reusables.classroom.closing-down-notice %} - -## 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 [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom). - -> [!NOTE] -> {% data reusables.classroom.google-classroom-note %} - -## Supported LMSes - -{% data reusables.classroom.supported-lmses %} - -## Configuring Blackboard for {% data variables.product.prodname_classroom %} - -You can register your Blackboard installation with {% data variables.product.prodname_classroom %} to enable teachers to import roster data into their classrooms. For more information about Blackboard, see the [Blackboard website](https://www.anthology.com/products/teaching-and-learning/learning-effectiveness/blackboard). - -### Step 1. Register {% data variables.product.prodname_classroom %} Developer Keys in the Anthology Developer Portal - -1. Sign into the [Anthology Developer Portal](https://developer.anthology.com/). -1. Click on the **plus sign** in the [My Application](https://developer.anthology.com/portal/applications) page. -1. Click **Manual Registration** in the dropdown menu. -1. On the "Register a new application" configuration screen, set the fields to the following values. - - | Field in the new app configuration | Value or setting | - | :- | :- | - | **Application Name** | `GitHub Classroom`

You can use any name, it will be showed only to administrators. | - | **Description** | `Sync Blackboard course roster to GitHub Classroom` (or something similar) | - | **Domain(s)** | `classroom.github.com` | - | **Group** | Leave the default value or change it according to your institution needs. | - | **My Integration supports LTI 1.3** | Enable the flag.| - | **Login Initiation URL** | `https://classroom.github.com/lti1p3/openid-connect/auth` | - | **Tool Redirect URL(s)** | `https://classroom.github.com/lti1p3/openid-connect/redirect,https://classroom.github.com/context-link` | - | **Tool JWKS URL** | `https://classroom.github.com/.well-known/jwks.json` | - | **Signing Algorithm** dropdown | `RS256` | - | **Custom parameters** | Leave empty. | -1. Click **Register Application**. -1. The Developer Portal will show a screen that contains important information you'll need to input in the next steps of registering your instance in your Blackboard instance and in {% data variables.product.prodname_classroom %} below. Please note them in a safe place and click **Done**. -1. In the table on the "My Applications" page, in the row for the GitHub Classroom application, click on the three dots and then **Manage Placements** in the dropdown menu. -1. Click on the **plus sign**. -1. On the "Register a new placement" configuration screen, set the fields to the following values. - - | Field in the new placement configuration | Value or setting | - | :- | :- | - | **Placement Name** | `GitHub Classroom`

You can use any name, but if you set this to something else, be sure this is communicated to teachers. | - | **Description** | `Sync Blackboard course roster to GitHub Classroom` (or something similar) | - | **Type** dropdown | Course Tool | - | **Allow students access** | Don't enable the flag. | - | **Launch in new window** | Don't enable the flag, unless you want to offer that user experience. | - | **Target link URI** | `https://classroom.github.com/context-link` | - | **Icon URL** | Leave it empty or provide a static URL for the icon. If needed, later in Blackboard can be manually uploaded. | - | **Custom parameters** | Leave empty. | -1. Click **Register Placement**. - -### Step 2. Register {% data variables.product.prodname_classroom %} Developer Keys in Blackboard - -1. Sign into your **Blackboard** instance. -1. In the left sidebar on the home page, click **Admin**, then click **LTI Tool Providers**. -1. On the "LTI Tool Providers" page, click **Register LTI 1.3/Advantage Tool**. -1. Insert the **Client ID** / **Application ID** obtained from the Developer Portal and click **Submit**. -1. Blackboard will show all application data. In this page: - 1. Verify that **Tool Status** is `Approved`. - 1. Verify that **User Fields to be Sent** flags are enabled for "Role in Course", "Name", "Email Address". - 1. Verify that **Allow mark service access** radio button is set to "No". To enable this option, navigate to the LTI Tool Providers in the Admin Panel: - * Select Manage Global Properties - * Under Creation of Tool Provider Links, select radio button “Allow links to any tool provider, but require approval for each new provider” - 1. Verify that **Allow Membership Service Access** radio button is set to "Yes". -1. Click **Submit**. - -### Step 3. Register your developer keys with {% data variables.product.prodname_classroom %} - -1. Go to https://classroom.github.com/register-lms. -1. Fill in the following information: - - * Under "LMS Type", choose "Other" from the dropdown menu. - * "Issuer Identifier": `https://blackboard.com` - * "Domain": The base URL to your Blackboard instance - * "Client ID": The "Client ID" / "Application ID" obtained from the registration of the app in the Anthology Developer Portal. - * "OIDC Initiation URL": The "OIDC auth request endpoint" obtained from the registration of the app in the Anthology Developer Portal. - * "OAuth 2.0 Token Retrieval URL": The "Auth token endpoint" obtained from the registration of the app in the Anthology Developer Portal. - * "Key Set URL": The "Public keyset URL" obtained from the registration of the app in the Anthology Developer Portal. - -1. Click **Register**. -1. 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 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). -1. In the left sidebar on the home page, click **Admin**, then click **Site Admin**. -1. Click **Developer Keys**. -1. Under "Developer Keys", click the **+ Developer Key** button, then select **+ LTI Key** from the dropdown menu. -1. 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. | -1. Click **Save**. -1. 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. -1. 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. -1. 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 `/api/lti/authorize_redirect` appended at the end. - * "OAuth 2.0 Token Retrieval URL": The base URL to your Canvas instance with `/login/oauth2/token` appended at the end. - * "Key Set URL": The base URL to your Canvas instance with `/api/lti/security/jwks` appended at the end. - -1. Click **Register**. -1. 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/). -1. Click the "Site administration" tab in the top level menu. -1. On the "Site administration" page, click the "Plugins" tab, then scroll down to the "Authentication" section and click **Manage authentication**. -1. Next to the "LTI" field, click the toggle button to enable LTI. -1. Click the "Plugins" tab again, then scroll down to "Enrolments" and click **Manage enrol plugins**. -1. Next to the "Publish as LTI tool" field, click the toggle button to enable publishing as an LTI tool. -1. 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**. -1. 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. -1. Click the "Plugins" tab, then next to the "Activity modules" section, under "External tool", click **Manage tools**. -1. Click **Configure a tool manually**. -1. 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` | - -1. Select the **Supports Deep Linking (Content-Item Message)** checkbox. -1. 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. -1. Under the "Privacy" dropdown, set "Share launcher's name with tool" to "Always" and set "Share launcher's email with tool" to "Always." -1. Click **Save changes**. -1. 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. -1. 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 - -1. Click **Register**. -1. 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. -1. Go to "Administration Workspace" and select **External Tools** in the left hand sidebar. -1. Click **Install LTI 1.x Tool**. -1. 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` | -1. 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. -1. 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 - -1. Click **Register**. -1. 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. diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md deleted file mode 100644 index 3b5f7956ee5e..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Reuse an assignment -intro: 'You can reuse existing assignments in more than one classroom, including classrooms in a different organization.' -versions: - fpt: '*' -permissions: 'Organization owners who are admins for a classroom can reuse assignments from a classroom. {% data reusables.classroom.classroom-admins-link %}' -shortTitle: Reuse an assignment -category: - - Create and manage assignments ---- -{% data reusables.classroom.closing-down-notice %} - -## About reusing assignments - -You can reuse an existing individual or group assignment in any other classroom you have access to, including classrooms in a different organization. You can also reuse multiple assignments at once from a classroom. If you choose to reuse an assignment, {% data variables.product.prodname_classroom %} will copy the assignment to the classroom you choose. If the assignment uses a template repository and you choose to reuse it in a classroom from a different organization, {% data variables.product.prodname_classroom %} will create a copy of the repository and its contents in the target organization. - -The copied assignment includes assignment details such as the name, source repository, autograding test, and preferred editor. You can edit the assignment after it has been copied to make changes. You cannot make changes to the preferred editor. - -## Reusing an assignment - -1. Sign into {% data variables.product.prodname_classroom_with_url %}. -1. Navigate to the classroom that has the assignment that you want to reuse. -1. In the list of assignments, click the assignment you want to reuse. -1. Select the **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Edit** dropdown menu in the top right of the page, then click **{% octicon "sync" aria-hidden="true" aria-label="sync" %} Reuse assignment**. - - ![Screenshot of an assignment. The "Edit" dropdown is expanded and the "Reuse assignment" option is outlined in dark orange.](/assets/images/help/classroom/reuse-assignment-button.png) - -1. In the "Reuse assignment" modal, use the **Choose an organization** dropdown menu to select the organization you want the assignment to be in. Then use the **Choose a classroom** dropdown menu to select the classroom within that organization that you want to copy the assignment to. -1. Click **Create assignment**. -1. The assignment is copied to the selected classroom, and a confirmation message is shown. If you chose to reuse an assignment with a template repository, the copying process may take a few minutes to complete, and you may need to refresh the page to see the completed message. - -## Reusing multiple assignments from a classroom - -1. Sign into {% data variables.product.prodname_classroom_with_url %}. -1. To the right of a classroom's name, select the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} dropdown menu, then click **Reuse assignment**. - - ![Screenshot of the tile for a classroom. The "Reuse assignment" option in the dropdown menu is outlined in dark orange.](/assets/images/help/classroom/classroom-reuse-assignment-modal.png) - -1. In the "Reuse assignments" modal, use the **Choose an organization** dropdown menu to select the organization you want the assignments to be in. Then use the **Choose a classroom** dropdown menu to select the classroom within that organization that you want to copy the assignments to. -1. To the left of each assignment, select the assignment you want to reuse. -1. Click **Create assignments**. -1. The assignments are copied to the selected classroom. If you chose to reuse an assignment with a template repository, the copying process may take a few minutes to complete. diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding.md deleted file mode 100644 index 690375873510..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -title: Use autograding -intro: You can automatically provide feedback on code submissions from your students by configuring tests to run in the assignment repository. -versions: - fpt: '*' -permissions: 'Organization owners who are admins for a classroom can set up and use autograding on assignments in a classroom. {% data reusables.classroom.classroom-admins-link %}' -redirect_from: - - /education/manage-coursework-with-github-classroom/adding-tests-for-auto-grading - - /education/manage-coursework-with-github-classroom/reviewing-auto-graded-work-teachers - - /education/manage-coursework-with-github-classroom/use-autograding -category: - - Track assignment progress ---- -{% data reusables.classroom.closing-down-notice %} - -## About autograding - -{% data reusables.classroom.about-autograding %} - -After a student accepts an assignment, on every push to the assignment repository (or on a teacher-defined schedule), {% data variables.product.prodname_actions %} runs the commands for your autograding test in a Linux environment containing the student's newest code. {% data variables.product.prodname_classroom %} creates the necessary workflows for {% data variables.product.prodname_actions %}. You don't need experience with {% data variables.product.prodname_actions %} to use autograding, but you can optionally modify the workflow configurations to suit your needs. For more information on workflows and {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions/get-started/continuous-integration). - -You can use a testing framework, run a custom command, write input/output tests, or combine different testing methods. The Linux environment for autograding contains many popular software tools. For more information, see the details for the latest version of Ubuntu in [AUTOTITLE](/actions/concepts/runners/github-hosted-runners#preinstalled-software-for-github-owned-images). - -You can see an overview of which students are passing autograding tests by navigating to the assignment in {% data variables.product.prodname_classroom %}. A green checkmark means that all tests are passing for the student, and a red X means that some or all tests are failing for the student. If you award points for one or more tests, then a bubble shows the score for the tests out of the maximum possible score for the assignment. - -## Grading methods - -{% data variables.product.prodname_classroom %} provides different autograding test presets that can be used if you do not wish to configure {% data variables.product.prodname_actions %} workflows yourself. You can also choose to use custom {% data variables.product.prodname_actions %} YAML to define your own autograding workflow. - -### Using {% data variables.product.prodname_dotcom %} presets - -You can use presets without any knowledge of {% data variables.product.prodname_actions %}. You can enter information about your autograding tests and {% data variables.product.prodname_classroom %} will automatically add the required files to student assignment repositories. - -There are three types of presets: input/output tests, python tests, and run command tests. - -#### Input/output test - -An input/output test optionally runs a setup command, then provides standard input to a test command. {% data variables.product.prodname_classroom %} evaluates the test command's output against an expected result. - -| Setting | Description | -| :- | :- | -| **Test name** | The name of the test, to identify the test in logs | -| **Setup command** | _Optional_. A command to run before tests, such as compilation or installation | -| **Run command** | The command to run the test and generate standard output for evaluation | -| **Inputs** | Standard input for run command | -| **Expected output** | The output that you want to see as standard output from the run command | -| **Comparison** | The type of comparison between the run command's output and the expected output

| -| **Timeout** | In minutes, how long a test should run before resulting in failure | -| **Points** | _Optional_. The number of points the test is worth toward a total score | - -#### Python test - -A Python test runs a setup command, then runs `pytest`. The number of points awarded will depend on how many tests in the `pytest` test suite the student passes. Each test is worth the same number of points; you can change how many points the entire test suite is worth by changing the `Points` setting. - -| Setting | Description | -| :- | :- | -| **Test name** | The name of the test, to identify the test in logs | -| **Setup command** | _Optional_. A command to run before tests, such as compilation or installation. [Some dependencies are already installed](https://github.com/classroom-resources/autograding-python-grader/blob/main/requirements.txt), but you can install more if needed. You do not need to use `sudo`, and should use `pip` instead of `pip3`. | -| **Run command** | The command to run the test and generate an exit code for evaluation | -| **Timeout** | In minutes, how long a test should run before resulting in failure | -| **Points** | _Optional_. The total number of points the entire `pytest` suite is worth. Each test will be worth `Points / number_of_tests` | - -#### Run command test - -A run command test runs a setup command, then runs a test command. {% data variables.product.prodname_classroom %} checks the exit status of the test command. An exit code of `0` results in success, and any other exit code results in failure. - -{% data variables.product.prodname_classroom %} provides presets for language-specific run command tests for a variety of programming languages. For example, the **Run node** test prefills the setup command with `npm install` and the test command with `npm test`. - -| Setting | Description | -| :- | :- | -| **Test name** | The name of the test, to identify the test in logs | -| **Setup command** | _Optional_. A command to run before tests, such as compilation or installation | -| **Run command** | The command to run the test and generate an exit code for evaluation | -| **Timeout** | In minutes, how long a test should run before resulting in failure | -| **Points** | _Optional_. The number of points the test is worth toward a total score | - -### Using a custom {% data variables.product.prodname_actions %} workflow - -Instead of using presets, you can also add any {% data variables.product.prodname_actions %} workflow to the `.github/workflows/classroom.yml` file in your starter code repository. - -You can edit the `.github/workflows/classroom.yml` file directly from the assignment edit page by selecting **Custom YAML** instead of **{% data variables.product.prodname_dotcom %} presets**. Clicking **Convert to workflow file** will prompt you to commit your changes to your starter code repository. This synchronization will only work if your starter code repository is in the same organization as your classroom. If your starter code repository is in another organization, you must edit the `.github/workflows/classroom.yml` file manually. - -## Configuring autograding tests for an assignment - -You can add autograding tests during the creation of a new assignment. {% data reusables.classroom.for-more-information-about-assignment-creation %} - -You can add, edit, or delete autograding tests for an existing assignment. All changes made via the Classroom UI will be pushed to the existing student repositories, so use caution when editing your tests. - -{% data reusables.classroom.sign-into-github-classroom %} -{% data reusables.classroom.click-classroom-in-list %} -{% data reusables.classroom.assignments-click-pencil %} -1. In the left sidebar, click **Grading and feedback**. -1. Add, edit, or delete an autograding test. - * To add a test, under "Add autograding tests", select the **Add test** dropdown menu, then click the grading method you want to use. - Configure the test, then click **Save test case**. - - * To edit a test, to the right of the test name, click {% octicon "pencil" aria-label="The pencil icon" %}. - Configure the test, then click **Save test case**. - - * To delete a test, to the right of the test name, click {% octicon "trash" aria-label="The trash icon" %}. - -1. At the bottom of the page, click **Update assignment**. - -## Configuring when autograding tests are run - -By default, autograding tests will automatically run whenever a student pushes to an assignment repository on {% data variables.location.product_location %}. However, if you want to manage your {% data variables.product.prodname_actions %} minutes, you can change this behavior. - -{% data reusables.classroom.sign-into-github-classroom %} -{% data reusables.classroom.click-classroom-in-list %} -{% data reusables.classroom.assignments-click-pencil %} -1. In the left sidebar, click **Grading and feedback**. -1. Below your list of autograding tests, you can configure when autograding tests are run. - * **Every time a student submits an assignment:** This is the default behavior. - * **On a schedule:** You can set a time every day or every week for autograding tests to be run. - * **Manually:** Autograding test runs will be manually triggered by you from the assignment dashboard. - -## Viewing and downloading results from autograding tests - -### Download autograding results - -{% data reusables.classroom.download-results %} - -### View individual logs - -{% data reusables.classroom.sign-into-github-classroom %} -{% data reusables.classroom.click-classroom-in-list %} -{% data reusables.classroom.click-assignment-in-list %} -1. To the right of a submission, click {% octicon "checklist" aria-label="The checklist icon" %}. -1. Review the test output. For more information, see [AUTOTITLE](/actions/how-tos/monitor-workflows/use-workflow-run-logs). - -## Further reading - -* [{% data variables.product.prodname_actions %} documentation](/actions) 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 deleted file mode 100644 index 758439311f54..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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: - fpt: '*' -permissions: 'Organization owners who are admins for a classroom can use Git & {% data variables.product.company_short %} starter assignments. {% data reusables.classroom.classroom-admins-link %}' -redirect_from: - - /education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment -shortTitle: Starter assignment -category: - - Create and manage assignments ---- -{% data reusables.classroom.closing-down-notice %} - -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 %}. -1. Navigate to a classroom. -1. In the **{% octicon "repo" aria-hidden="true" aria-label="repo" %} Assignments** tab, click **Use starter assignment**. - -### If there already are existing assignments in the classroom - -1. Sign into {% data variables.product.prodname_classroom_with_url %}. -1. Navigate to a classroom. -1. In the **{% octicon "repo" aria-hidden="true" aria-label="repo" %} Assignments** tab, click the link in the blue banner. - -## 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. - -* [Prerequisites](#prerequisites) -* [Creating the starter assignment](#creating-the-starter-assignment) - * [If there are no existing assignments in the classroom](#if-there-are-no-existing-assignments-in-the-classroom) - * [If there already are existing assignments in the classroom](#if-there-already-are-existing-assignments-in-the-classroom) -* [Setting up the basics for an assignment](#setting-up-the-basics-for-an-assignment) - * [Importing the assignment](#importing-the-assignment) - * [Naming the assignment](#naming-the-assignment) - * [Assigning a deadline for an assignment](#assigning-a-deadline-for-an-assignment) - * [Choosing a visibility for assignment repositories](#choosing-a-visibility-for-assignment-repositories) -* [Inviting students to an assignment](#inviting-students-to-an-assignment) -* [Next steps](#next-steps) -* [Further reading](#further-reading) - -### Importing the assignment - -To import the Git & {% data variables.product.github %} starter assignment into your organization, click **Import the assignment**. - -### 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.github %} 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.github %} 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 %} - -{% data reusables.classroom.assignments-guide-make-cutoff-date %} - -### 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. - -## 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 %} - -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 [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment), [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment), and [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment). - -## Further reading - -* [AUTOTITLE](/education/about-github-education/github-education-for-teachers) -* [AUTOTITLE](/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/using-github-classroom-with-github-cli.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli.md deleted file mode 100644 index 186c220cad4e..000000000000 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: Using {% data variables.product.prodname_classroom %} with {% data variables.product.prodname_cli %} -shortTitle: '{% data variables.product.prodname_classroom %} CLI' -allowTitleToDifferFromFilename: true -intro: You can use `gh`, the {% data variables.product.github %} command line interface, to work with {% data variables.product.prodname_classroom %} directly from your command line. -versions: - fpt: '*' -contentType: how-tos -category: - - Set up GitHub Classroom ---- - -> [!WARNING] -> **Closing down:** This `gh` extension is closing down. The {% data variables.product.prodname_classroom %} application will be retired on August 28, 2026. -> For more information, see the [{% data variables.product.prodname_classroom %} closing down notice](https://gh.io/classroom-sunset). - -## About {% data variables.product.prodname_classroom %} CLI - -{% data reusables.cli.about-cli %} For more information, see [AUTOTITLE](/github-cli/github-cli/about-github-cli). - -You can work with {% data variables.product.prodname_classroom %} in the {% data variables.product.prodname_cli %} to: - -* [List classrooms](#list-classrooms) -* [View classroom information](#view-classroom-information) -* [List assignments](#list-assignments) -* [List accepted assignments](#list-accepted-assignments) -* [View assignment information](#view-assignment-information) -* [Clone an assignment's starter code repository](#clone-an-assignments-starter-code-repository) -* [Clone a student’s assignment repository](#clone-a-students-assignment-repository) - -## Setting up {% data variables.product.prodname_cli %} - -{% data reusables.cli.cli-installation %} - -## Using the {% data variables.product.prodname_classroom %} extension with {% data variables.product.prodname_cli %} - -If you have not already done so, run `gh auth login` to authenticate with your {% data variables.product.prodname_dotcom %} account. - -To install the {% data variables.product.prodname_classroom %} extension, run `gh extension install github/gh-classroom`. - -To use `gh` to work with {% data variables.product.prodname_classroom %}, type `gh classroom SUBCOMMAND`. - -As an example of a series of commands you might use to work with {% data variables.product.prodname_classroom %}, you could: -* List your classrooms:
- `gh classroom list` -* List the assignments for a specific classroom:
- `gh classroom assignments` -* View information for a specific assignment:
- `gh classroom assignment` - -## `gh` subcommands for {% data variables.product.prodname_classroom %} - -These sections give example subcommands for each of the available operations. {% data reusables.classroom.classroom-cli-prompt %} - -On the command line, use `gh classroom --help` for general help or `gh classroom SUBCOMMAND --help` for help with a specific subcommand. - -### List classrooms - -```shell -gh classroom list -``` - -List of classrooms you own. - -### View classroom information - -```shell -gh classroom view -``` - -Display the classroom ID, classroom slug, title, and other information about a classroom. - -### List assignments - -```shell -gh classroom assignments -``` - -Display a list of assignments for a classroom. - -### List accepted assignments - -```shell -gh classroom accepted-assignments -``` - -Display a list of accepted assignments and information about the student's assignments. - -### View assignment information - -```shell -gh classroom assignment -``` - -Displays assignment information. - -### Clone an assignment's starter code repository - -```shell -gh classroom clone starter-repo -``` - -Clones starter code repo used by an assignment. By default, the starter code is cloned into the current directory. To clone into a different directory, use the `--directory` flag. If the directory does not exist, it will be created. - -### Clone a student’s assignment repository - -```shell -gh classroom clone student-repos -``` - -Clones student repositories from a given assignment. By default, the student repositories are cloned into the current directory in a directory named after the assignment slug. To clone into a different directory, use the `--directory` flag. If the directory does not exist, it will be created. - -By default, all student repositories are cloned. To get a different number of repositories, use the `--page NUMBER` and `--per-page NUMBER` flags. diff --git a/content/education/quickstart.md b/content/education/quickstart.md index 7991696d5eed..900365785d78 100644 --- a/content/education/quickstart.md +++ b/content/education/quickstart.md @@ -45,31 +45,9 @@ Once you are a verified {% data variables.product.prodname_global_campus %} educ ## Set up {% data variables.product.prodname_classroom %} -With your personal account and organization account, you're ready to get started with {% data variables.product.prodname_classroom %}. {% data variables.product.prodname_classroom %} is free to use. You can track and manage assignments, grade work automatically, and provide feedback to your students. - -{% data reusables.classroom.sign-into-github-classroom %} -1. To authorize {% data variables.product.prodname_classroom %} to access your personal account on {% data variables.product.prodname_dotcom %}, review the information, then click **Authorize {% data variables.product.prodname_classroom %}**. -1. Review the information. To authorize {% data variables.product.prodname_classroom %} to access your organization account on {% data variables.product.prodname_dotcom %}, click **Grant**. - - > [!TIP] - > If you see a **Request** button instead of a **Grant** button, you are a member of the organization, not an owner. An owner must approve your request for {% data variables.product.prodname_classroom %}. You must be an organization owner to create and manage classrooms and assignments in {% data variables.product.prodname_classroom %}. For more information, see [AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps#oauth-apps-and-organizations). - -1. Click **Authorize github**. - -## Create your classroom - -{% data reusables.classroom.about-classrooms %} - -{% data reusables.classroom.sign-into-github-classroom %} -1. Click **Create your first classroom** or **New classroom**. -{% data reusables.classroom.guide-create-new-classroom %} +> [!NOTE] +> As of August 28, 2026, GitHub Classroom has been closed down in favor of partner solutions. For more information on this transition, please refer to the [GitHub Educator Community Discussion](https://gh.io/classroom-sunset). ## Next steps -You've created a classroom, and you're ready to enrich your course with {% data variables.product.github %} and {% data variables.product.prodname_classroom %}! 🎉 - -* Manage your classrooms and classroom admins, and create a roster of students for your classroom. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-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.github %} fundamentals. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-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 [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding). * Participate in {% data variables.product.prodname_education_community_with_url %}. diff --git a/content/migrations/elm/about-live-migrations.md b/content/migrations/elm/about-live-migrations.md index 6b825973cd2b..d55115aa02c4 100644 --- a/content/migrations/elm/about-live-migrations.md +++ b/content/migrations/elm/about-live-migrations.md @@ -1,6 +1,5 @@ --- -title: About live migrations from GitHub Enterprise Server to GHE.com -shortTitle: About live migrations +title: About live migrations intro: 'How do live migrations minimize downtime for developers?' versions: fpt: '*' @@ -11,15 +10,17 @@ contentType: concepts ## What is {% data variables.product.prodname_elm %}? -{% data variables.product.prodname_elm %} ({% data variables.product.prodname_elm_short %}) is a service for migrating repositories from {% data variables.product.prodname_ghe_server %} to {% data variables.enterprise.data_residency %} ({% data variables.enterprise.data_residency_site %}). It is operated using an extension of the {% data variables.product.prodname_cli %}. +{% data variables.product.prodname_elm %} ({% data variables.product.prodname_elm_short %}) is a service for migrating repositories to {% data variables.enterprise.data_residency %} ({% data variables.enterprise.data_residency_site %}) with minimal downtime for developers. You can migrate from {% data variables.product.prodname_ghe_server %} or from Azure DevOps Services. -Migrations are "live" because users can continue using the source repository during most of the migration process. After the repository data is initially collected, webhooks check for changes to the repository, such as new commits or updates to settings. These changes are reported to {% data variables.product.prodname_elm_short %} and included in the migration. +Migrations are "live" because users can continue working in the source repository during most of the migration process. After the repository data is initially copied, {% data variables.product.prodname_elm_short %} continues to synchronize any changes made in the source repository, such as new commits, so that these changes are included in the migration. -An {% data variables.product.prodname_elm_short %} migration includes a single repository. Organization-level data, such as organization settings, teams, and projects, are **not** included in the migration and must be reconfigured manually on the destination enterprise. +A migration includes repository data only. Data that is not part of a repository, such as settings for the organization or project that contains it, is **not** included and must be migrated or reconfigured separately on the destination enterprise. + +The tools you use to run a migration, and the data that {% data variables.product.prodname_elm_short %} can migrate, depend on your source platform. For details, see the documentation for your migration path in [Next steps](#next-steps). ## Differences from {% data variables.product.prodname_importer_proper_name %} -{% data variables.product.prodname_elm_short %} and {% data variables.product.prodname_importer_proper_name %} (GEI) are separate tools that both support migrating repositories from {% data variables.product.prodname_ghe_server %} to {% data variables.enterprise.data_residency_site %}. +{% data variables.product.prodname_elm_short %} and {% data variables.product.prodname_importer_proper_name %} (GEI) are separate tools that both support migrating repositories to {% data variables.enterprise.data_residency_site %}. The main benefits of {% data variables.product.prodname_elm_short %} are: @@ -27,23 +28,24 @@ The main benefits of {% data variables.product.prodname_elm_short %} are: * **Monorepo support**: {% data variables.product.prodname_elm_short %} is capable of migrating large, complex monorepos with deep histories. These often exceed the capacity of GEI. * **Better visibility**: {% data variables.product.prodname_elm_short %} provides detailed repository-level visibility into migration progress, surfacing granular failures so that you can be confident the migrated repository is an accurate replica. -However, because of the higher traffic load associated with live updates, {% data variables.product.prodname_elm_short %} supports fewer concurrent migrations than GEI: {% data reusables.elm.concurrent-migrations %} +However, because of the higher traffic load associated with live updates, {% data variables.product.prodname_elm_short %} supports fewer concurrent migrations than GEI. You may want to use both tools over the course of a platform migration, prioritizing the repositories that will benefit most from {% data variables.product.prodname_elm_short %}. ## Overview of a migration -A site administrator runs a migration using the {% data variables.product.prodname_cli %}. Before running the migration, the operator must configure the {% data variables.product.prodname_ghe_server %} instance and provide {% data variables.product.pat_generic_plural %} with access to both {% data variables.product.prodname_ghe_server %} and the destination enterprise. - The high-level phases of a migration are: -1. **Creation**: The site admin runs CLI commands to create and start the migration, specifying the source repository and destination. -1. **Preflight checks**: The migration service verifies parameters, tokens, network connectivity, and repository configuration. -1. **Backfill**: The {% data variables.product.prodname_elm_short %} tool does an initial crawl to capture all repository data and sends it to the migration service on the destination platform. During the backfill phase, webhooks check for live updates to the repository as the migration continues. -1. **Cutover**: The source repository is archived (made read-only) and any final live updates are sent to {% data variables.product.prodname_elm_short %}. This is the downtime period for developers. -1. **Completion**: The migration is finished. The site admin can check the data was migrated successfully. -1. **Follow-up**: An organization owner performs follow-up tasks on the destination enterprise, such as reconfiguring organization settings and reattributing activity to users. +1. **Preparation and validation**: You choose the repositories to migrate, grant the migration operator the required access, and prepare the source and destination platforms. {% data variables.product.prodname_elm_short %} then checks that each repository is ready to migrate. +1. **Initial copy**: {% data variables.product.prodname_elm_short %} copies the repository data to the destination enterprise. +1. **Continuous synchronization**: {% data variables.product.prodname_elm_short %} tracks changes made in the source repository and applies them to the destination repository, until you are ready to cut over. +1. **Cutover**: The source repository becomes read-only and any final changes are synchronized. This is the downtime period for developers. +1. **Verification**: The operator checks that the data was migrated successfully. +1. **Follow-up**: An organization owner performs follow-up tasks on the destination enterprise, such as configuring organization settings and reattributing activity to users. ## Next steps -To get ready to run a migration, see [AUTOTITLE](/migrations/elm/prepare-for-your-migration). +Your next steps depend on your migration path. + +* **{% data variables.product.prodname_ghe_server %} to {% data variables.enterprise.data_residency_site %}**: To get ready to run a migration, see [AUTOTITLE](/migrations/elm/ghes-to-ghecom/prepare-for-your-migration). +* **Azure DevOps to {% data variables.enterprise.data_residency_site %}**: For guidance on migrating from Azure DevOps Services, see [Enterprise live migrations overview](https://learn.microsoft.com/azure/devops/repos/enterprise-live-migrations/overview) in the Microsoft Learn documentation. If you currently use Azure DevOps Server, first migrate to Azure DevOps Services before you use {% data variables.product.prodname_elm_short %}. diff --git a/content/migrations/elm/complete-your-migration.md b/content/migrations/elm/ghes-to-ghecom/complete-your-migration.md similarity index 93% rename from content/migrations/elm/complete-your-migration.md rename to content/migrations/elm/ghes-to-ghecom/complete-your-migration.md index 4d26183c8849..51255efd0534 100644 --- a/content/migrations/elm/complete-your-migration.md +++ b/content/migrations/elm/ghes-to-ghecom/complete-your-migration.md @@ -1,13 +1,15 @@ --- title: Completing your live migration from GitHub Enterprise Server to GHE.com shortTitle: Complete your migration -intro: 'Complete follow-up tasks so users can start using the migrated repository.' +intro: Complete follow-up tasks so users can start using the migrated repository. versions: fpt: '*' ghes: '*' ghec: '*' contentType: how-tos -permissions: 'Organization owners on {% data variables.enterprise.data_residency_site %}' +permissions: Organization owners on {% data variables.enterprise.data_residency_site %} +redirect_from: + - /migrations/elm/complete-your-migration --- After you have run a migration with the {% data variables.product.prodname_elm_cli %} tool, there are some follow-up tasks to complete. @@ -56,7 +58,7 @@ You can use the {% data variables.product.prodname_elm_cli %} to reclaim mannequ gh target mannequin reclaim ORGANIZATION_NAME --csv MANNEQUINS.csv ``` -For a full reference of the reclaim command, including options to control invitations and prompting, see [AUTOTITLE](/migrations/elm/elm-cli-reference). +For a full reference of the reclaim command, including options to control invitations and prompting, see [AUTOTITLE](/migrations/elm/ghes-to-ghecom/elm-cli-reference). ### Reclaiming mannequins in the browser diff --git a/content/migrations/elm/elm-cli-reference.md b/content/migrations/elm/ghes-to-ghecom/elm-cli-reference.md similarity index 97% rename from content/migrations/elm/elm-cli-reference.md rename to content/migrations/elm/ghes-to-ghecom/elm-cli-reference.md index c33b1253d1d8..fc093963fd10 100644 --- a/content/migrations/elm/elm-cli-reference.md +++ b/content/migrations/elm/ghes-to-ghecom/elm-cli-reference.md @@ -1,12 +1,14 @@ --- title: Enterprise Live Migrations CLI reference shortTitle: ELM CLI reference -intro: 'Detailed usage information for the {% data variables.product.prodname_elm_cli %} tool.' +intro: Detailed usage information for the {% data variables.product.prodname_elm_cli %} tool. versions: fpt: '*' ghes: '*' ghec: '*' contentType: reference +redirect_from: + - /migrations/elm/elm-cli-reference --- ## Installation diff --git a/content/migrations/elm/ghes-to-ghecom/index.md b/content/migrations/elm/ghes-to-ghecom/index.md new file mode 100644 index 000000000000..5977d8442c29 --- /dev/null +++ b/content/migrations/elm/ghes-to-ghecom/index.md @@ -0,0 +1,18 @@ +--- +title: Live migrations from GitHub Enterprise Server to GHE.com +shortTitle: GHES to GHE.com +intro: Migrate repositories from {% data variables.product.prodname_ghe_server %} to {% data variables.enterprise.data_residency_site %} with minimal downtime for developers. +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghec: '*' + ghes: '*' +children: + - /prepare-for-your-migration + - /migrate-your-repository + - /complete-your-migration + - /troubleshooting + - /migrated-data-reference + - /elm-cli-reference +--- + diff --git a/content/migrations/elm/migrate-your-repository.md b/content/migrations/elm/ghes-to-ghecom/migrate-your-repository.md similarity index 92% rename from content/migrations/elm/migrate-your-repository.md rename to content/migrations/elm/ghes-to-ghecom/migrate-your-repository.md index 56c60bf1a676..b25f3b8454c8 100644 --- a/content/migrations/elm/migrate-your-repository.md +++ b/content/migrations/elm/ghes-to-ghecom/migrate-your-repository.md @@ -1,20 +1,22 @@ --- title: Migrating your repository with Enterprise Live Migrations shortTitle: Migrate your repository -intro: 'Migrate from {% data variables.product.prodname_ghe_server %} to {% data variables.enterprise.data_residency_site %} with minimal downtime.' +intro: Migrate from {% data variables.product.prodname_ghe_server %} to {% data variables.enterprise.data_residency_site %} with minimal downtime. versions: fpt: '*' ghes: '*' ghec: '*' contentType: how-tos -permissions: 'Site administrators on {% data variables.product.prodname_ghe_server %} who are also enterprise owners on {% data variables.enterprise.data_residency_site %}.' +permissions: Site administrators on {% data variables.product.prodname_ghe_server %} who are also enterprise owners on {% data variables.enterprise.data_residency_site %}. +redirect_from: + - /migrations/elm/migrate-your-repository --- ->[!TIP] As you follow this guide, you can refer to the [AUTOTITLE](/migrations/elm/elm-cli-reference) for more detailed usage information. If you encounter errors, see [AUTOTITLE](/migrations/elm/troubleshooting). +>[!TIP] As you follow this guide, you can refer to the [AUTOTITLE](/migrations/elm/ghes-to-ghecom/elm-cli-reference) for more detailed usage information. If you encounter errors, see [AUTOTITLE](/migrations/elm/ghes-to-ghecom/troubleshooting). ## Prerequisites -Make sure your environments and developers are ready for the migration. See [AUTOTITLE](/migrations/elm/prepare-for-your-migration). +Make sure your environments and developers are ready for the migration. See [AUTOTITLE](/migrations/elm/ghes-to-ghecom/prepare-for-your-migration). ## 1. Configure {% data variables.product.prodname_ghe_server %} @@ -236,7 +238,7 @@ For example: Tips: * If you're running multiple migrations, you can check the status of all of them with `gh elm migration list`. This command shows in-progress migrations by default, but you can also filter by `--status`. -* If you encounter failure statuses that require attention, see [AUTOTITLE](/migrations/elm/troubleshooting#statuses-and-recommended-actions). +* If you encounter failure statuses that require attention, see [AUTOTITLE](/migrations/elm/ghes-to-ghecom/troubleshooting#statuses-and-recommended-actions). ## 8. Complete the migration @@ -250,4 +252,4 @@ Continue to monitor the migration. When you see the `MIGRATION_STATUS_COMPLETED` ## Next steps -Give users access to the new repository and reconcile activity with user accounts. See [AUTOTITLE](/migrations/elm/complete-your-migration). +Give users access to the new repository and reconcile activity with user accounts. See [AUTOTITLE](/migrations/elm/ghes-to-ghecom/complete-your-migration). diff --git a/content/migrations/elm/migrated-data-reference.md b/content/migrations/elm/ghes-to-ghecom/migrated-data-reference.md similarity index 98% rename from content/migrations/elm/migrated-data-reference.md rename to content/migrations/elm/ghes-to-ghecom/migrated-data-reference.md index 126f713efbc3..97378c482ee3 100644 --- a/content/migrations/elm/migrated-data-reference.md +++ b/content/migrations/elm/ghes-to-ghecom/migrated-data-reference.md @@ -1,12 +1,14 @@ --- title: Migrated data for live migrations from GitHub Enterprise Server to GHE.com shortTitle: Migrated data reference -intro: 'Which data and live updates are included in a live migration?' +intro: Which data and live updates are included in a live migration? versions: fpt: '*' ghes: '*' ghec: '*' contentType: reference +redirect_from: + - /migrations/elm/migrated-data-reference --- ## Data that is migrated diff --git a/content/migrations/elm/prepare-for-your-migration.md b/content/migrations/elm/ghes-to-ghecom/prepare-for-your-migration.md similarity index 87% rename from content/migrations/elm/prepare-for-your-migration.md rename to content/migrations/elm/ghes-to-ghecom/prepare-for-your-migration.md index fc3d01045717..63aadf87bc6d 100644 --- a/content/migrations/elm/prepare-for-your-migration.md +++ b/content/migrations/elm/ghes-to-ghecom/prepare-for-your-migration.md @@ -1,12 +1,14 @@ --- title: Preparing for your live migration from GitHub Enterprise Server to GHE.com shortTitle: Prepare for your migration -intro: 'Key questions to consider before getting started with {% data variables.product.prodname_elm %}.' +intro: Key questions to consider before getting started with {% data variables.product.prodname_elm %}. versions: fpt: '*' ghes: '*' ghec: '*' contentType: concepts +redirect_from: + - /migrations/elm/prepare-for-your-migration --- ## Is our {% data variables.product.prodname_ghe_server %} instance ready? @@ -33,7 +35,7 @@ Your {% data variables.product.prodname_ghe_server %} instance must also: You can migrate repositories to a new or existing organization on {% data variables.enterprise.data_residency_site %}. ELM creates the target organization if it doesn't already exist. -A platform migration is a good opportunity to reconsider your organization and team structure. See [AUTOTITLE](/admin/concepts/enterprise-best-practices/organize-work). +A platform migration is a good opportunity to reconsider your organization and team structure. See [AUTOTITLE](/enterprise-cloud@latest/admin/concepts/enterprise-best-practices/organize-work). ## Which repositories will we migrate? @@ -48,6 +50,8 @@ Public repositories are not available on {% data variables.enterprise.data_resid You should check that the repositories you choose don't contain release assets that are over 2GB, as this is the limit for {% data variables.product.prodname_elm_short %}. +Organization-level data, such as organization settings, teams, and projects, is **not** included in the migration and must be reconfigured manually on {% data variables.enterprise.data_residency_site %}. + ## Who will run the migration? The person who runs an {% data variables.product.prodname_elm_short %} migration must: @@ -70,8 +74,8 @@ Before you start, communicate with developers that: * The repository is moving to a new location. Users can continue to use the source repository during the migration until the operator begins the final cutover to the new location. After cutover, the source repository will be archived, so it will be read-only unless it is unarchived by a repository administrator. * While the migration is in progress, developers should avoid force pushes to the repository, because these will disrupt the Git history in a way that {% data variables.product.prodname_elm_short %} cannot resolve. -* Certain actions that developers perform during the migration process may not be reflected in the migrated repository. For details, see the unsupported actions in [AUTOTITLE](/migrations/elm/migrated-data-reference#events-included-in-live-updates). +* Certain actions that developers perform during the migration process may not be reflected in the migrated repository. For details, see the unsupported actions in [AUTOTITLE](/migrations/elm/ghes-to-ghecom/migrated-data-reference#events-included-in-live-updates). ## Next steps -When you're ready to run a migration, see [AUTOTITLE](/migrations/elm/migrate-your-repository). +When you're ready to run a migration, see [AUTOTITLE](/migrations/elm/ghes-to-ghecom/migrate-your-repository). diff --git a/content/migrations/elm/troubleshooting.md b/content/migrations/elm/ghes-to-ghecom/troubleshooting.md similarity index 97% rename from content/migrations/elm/troubleshooting.md rename to content/migrations/elm/ghes-to-ghecom/troubleshooting.md index 64355cbf76c7..e8211823cdc8 100644 --- a/content/migrations/elm/troubleshooting.md +++ b/content/migrations/elm/ghes-to-ghecom/troubleshooting.md @@ -1,12 +1,14 @@ --- title: Troubleshooting live migrations from GitHub Enterprise Server to GHE.com shortTitle: Troubleshooting -intro: 'Advice for problems you may encounter with your migration.' +intro: Advice for problems you may encounter with your migration. versions: fpt: '*' ghes: '*' ghec: '*' contentType: other +redirect_from: + - /migrations/elm/troubleshooting --- If your migration encounters a problem, check the migration status with `gh elm migration status --migration-id MIGRATION-ID` and review the error information. @@ -109,7 +111,7 @@ If your migration fails with an authentication error, check that: * Both the source and destination tokens are {% data variables.product.pat_v1_plural %}. {% data variables.product.pat_v2_caps_plural %} are not supported. * If the destination organization enforces SAML single sign-on, the token must be authorized for SSO. -* Both tokens have the scopes specified in [AUTOTITLE](/migrations/elm/migrate-your-repository#4-configure-the-live-migration-secrets). +* Both tokens have the scopes specified in [AUTOTITLE](/migrations/elm/ghes-to-ghecom/migrate-your-repository#4-configure-the-live-migration-secrets). If you recently rotated a token, the migration picks up new credentials automatically. You do not need to run `ghe-config-apply` or restart the migration service. @@ -121,7 +123,7 @@ The operator must use a {% data variables.product.pat_v1 %} for each endpoint: * The **source operator token** must be created on {% data variables.product.prodname_ghe_server %}. * The **target operator token** must be created on {% data variables.enterprise.data_residency_site %}. -* Both tokens have the scopes specified in [AUTOTITLE](/migrations/elm/migrate-your-repository#2-create-operator-tokens-with-enterprise-access). +* Both tokens have the scopes specified in [AUTOTITLE](/migrations/elm/ghes-to-ghecom/migrate-your-repository#2-create-operator-tokens-with-enterprise-access). * The token owner must be an administrator of the corresponding enterprise. Selecting a scope does not grant the user administrative access. * {% data variables.product.pat_v2_caps_plural %} are not supported. diff --git a/content/migrations/elm/index.md b/content/migrations/elm/index.md index 263bcf5989cf..a75e0443d684 100644 --- a/content/migrations/elm/index.md +++ b/content/migrations/elm/index.md @@ -1,7 +1,6 @@ --- -title: Live migrations from GitHub Enterprise Server to GHE.com -shortTitle: Live migrations (GHES to GHE.com) -intro: 'Use the Enterprise Live Migrations tool to migrate repositories with minimal downtime for developers.' +title: Live migrations +intro: Use the {% data variables.product.prodname_elm %} tool to migrate repositories with minimal downtime for developers. allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -9,10 +8,6 @@ versions: ghes: '*' children: - /about-live-migrations - - /prepare-for-your-migration - - /migrate-your-repository - - /complete-your-migration - - /troubleshooting - - /migrated-data-reference - - /elm-cli-reference ---- \ No newline at end of file + - /ghes-to-ghecom +--- + diff --git a/content/migrations/index.md b/content/migrations/index.md index 19f2092924a6..6df9530359bd 100644 --- a/content/migrations/index.md +++ b/content/migrations/index.md @@ -12,7 +12,6 @@ versions: ghes: '*' children: - /overview - - /ado - /importing-source-code - /using-github-enterprise-importer - /elm @@ -29,7 +28,7 @@ carousels: - /migrations/overview/planning-your-migration-to-github - /migrations/overview/about-githubs-migration-tooling - /migrations/overview/migration-paths-to-github - - /migrations/ado + - /migrations/using-github-enterprise-importer/ado - /migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer - /migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github - /migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer diff --git a/content/migrations/overview/mannequins-and-user-activity.md b/content/migrations/overview/mannequins-and-user-activity.md index 27efa4aa452f..eefbf9cdc568 100644 --- a/content/migrations/overview/mannequins-and-user-activity.md +++ b/content/migrations/overview/mannequins-and-user-activity.md @@ -23,7 +23,7 @@ Reclaiming is optional and can happen any time after a migration is finished. Fo ## How can I reclaim mannequins? -{% data reusables.enterprise-migration-tool.how-to-reclaim %} For instructions, see [AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer) or [AUTOTITLE](/migrations/elm/complete-your-migration#reattribute-activity-to-users). +{% data reusables.enterprise-migration-tool.how-to-reclaim %} For instructions, see [AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer) or [AUTOTITLE](/migrations/elm/ghes-to-ghecom/complete-your-migration#reattribute-activity-to-users). By default, reclaiming a mannequin will send an attribution invitation to the target user. The target user can choose to accept or reject the invitation. diff --git a/content/migrations/overview/migration-paths-to-github.md b/content/migrations/overview/migration-paths-to-github.md index 6268835d7f92..7661c4f6dcda 100644 --- a/content/migrations/overview/migration-paths-to-github.md +++ b/content/migrations/overview/migration-paths-to-github.md @@ -206,16 +206,19 @@ Follow a link below to review the scope and tooling for your migration to {% dat ### Azure DevOps Services (Azure DevOps Cloud) to {% data variables.enterprise.data_residency_site %} * **Scope:** Source, history, and metadata -* **Tooling:** {% data variables.product.prodname_importer_proper_name %} -* **More information:** [AUTOTITLE](/migrations/using-github-enterprise-importer) +* **Tooling:** {% data variables.product.prodname_importer_proper_name %} or {% data variables.product.prodname_elm %} +* **More information:** + * [AUTOTITLE](/migrations/using-github-enterprise-importer) + * [Enterprise live migrations overview](https://learn.microsoft.com/azure/devops/repos/enterprise-live-migrations/overview) in the Microsoft Learn documentation ### Azure DevOps Server to {% data variables.enterprise.data_residency_site %} * **Scope:** Source, history, and metadata -* **Tooling:** Migration to Azure DevOps Services, then {% data variables.product.prodname_importer_proper_name %} +* **Tooling:** Migration to Azure DevOps Services, then {% data variables.product.prodname_importer_proper_name %} or {% data variables.product.prodname_elm_short %} * **More information:** * [Migrate data from Azure DevOps Server to Azure DevOps Services](https://learn.microsoft.com/en-us/azure/devops/migrate/migration-overview?view=azure-devops) in the Microsoft Docs * [AUTOTITLE](/migrations/using-github-enterprise-importer) + * [Enterprise live migrations overview](https://learn.microsoft.com/azure/devops/repos/enterprise-live-migrations/overview) in the Microsoft Learn documentation * **Caveats:** If you can't migrate to Azure DevOps Services first, you must perform a "source and history" migration instead. For more information, see [Migrations from any Git repository to {% data variables.enterprise.data_residency_site %}](#any-git-repository-to-githubcom). ### Bitbucket Cloud (Bitbucket.org) to {% data variables.enterprise.data_residency_site %} diff --git a/content/migrations/overview/planning-your-migration-to-github.md b/content/migrations/overview/planning-your-migration-to-github.md index 5ef5060e545f..a9a2ff574305 100644 --- a/content/migrations/overview/planning-your-migration-to-github.md +++ b/content/migrations/overview/planning-your-migration-to-github.md @@ -66,7 +66,7 @@ If you’re migrating from {% data variables.product.prodname_ghe_cloud %} or {% {% data reusables.enterprise-migration-tool.gh-repo-stats-not-supported %} {% ifversion fpt or ghec %} -If you’re migrating from Azure DevOps, we recommend the `inventory-report` command in the {% data variables.product.prodname_ado2gh_cli %}. The `inventory-report` command will connect with the Azure DevOps API, then build a simple CSV with some of the fields suggested above. For more information about how to install the {% data variables.product.prodname_ado2gh_cli %}, see [AUTOTITLE](/migrations/ado/migrate-your-repositories-from-azure-devops-to-github). +If you’re migrating from Azure DevOps, we recommend the `inventory-report` command in the {% data variables.product.prodname_ado2gh_cli %}. The `inventory-report` command will connect with the Azure DevOps API, then build a simple CSV with some of the fields suggested above. For more information about how to install the {% data variables.product.prodname_ado2gh_cli %}, see [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/migrate-your-repositories-from-azure-devops-to-github). {% endif %} If you’re migrating from Bitbucket Server or Bitbucket Data Center, we recommend the `inventory-report` command in the {% data variables.product.prodname_bbs2gh_cli %}. The `inventory-report` command will use your Bitbucket instance's API to build a simple CSV. For more information about how to install the {% data variables.product.prodname_bbs2gh_cli %}, see [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-bitbucket-server-to-github-enterprise-cloud/migrating-repositories-from-bitbucket-server-to-github-enterprise-cloud). diff --git a/content/migrations/troubleshooting/troubleshooting-your-migration-with-github-enterprise-importer.md b/content/migrations/troubleshooting/troubleshooting-your-migration-with-github-enterprise-importer.md index e74b669826ff..16e9881c1bcb 100644 --- a/content/migrations/troubleshooting/troubleshooting-your-migration-with-github-enterprise-importer.md +++ b/content/migrations/troubleshooting/troubleshooting-your-migration-with-github-enterprise-importer.md @@ -26,7 +26,7 @@ Before you investigate further, try these troubleshooting steps that commonly re 1. Verify that you meet all the access requirements. For more information, see the appropriate article for your migration path. {% ifversion fpt or ghec %} - * [AUTOTITLE](/migrations/ado/manage-access) + * [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/manage-access) {% endif %} * [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-bitbucket-server-to-github-enterprise-cloud/managing-access-for-a-migration-from-bitbucket-server) * [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products) @@ -69,7 +69,7 @@ This error indicates that a {% data variables.product.pat_generic %} you provide Failures that include a `401` status code usually indicate that the {% data variables.product.pat_generic %} you provided to the {% data variables.product.prodname_cli %} does not have the required scopes. Verify the scopes on the {% data variables.product.pat_generic %}s you provided. For more information about required scopes, see the appropriate article for your migration path. {% ifversion fpt or ghec %} - * [AUTOTITLE](/migrations/ado/manage-access) + * [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/manage-access) {% endif %} * [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-bitbucket-server-to-github-enterprise-cloud/managing-access-for-a-migration-from-bitbucket-server#required-scopes-for-personal-access-tokens) * [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#required-scopes-for-personal-access-tokens) diff --git a/content/migrations/ado/follow-up-tasks.md b/content/migrations/using-github-enterprise-importer/ado/follow-up-tasks.md similarity index 73% rename from content/migrations/ado/follow-up-tasks.md rename to content/migrations/using-github-enterprise-importer/ado/follow-up-tasks.md index 56c5c73bcaaf..d347cb83282e 100644 --- a/content/migrations/ado/follow-up-tasks.md +++ b/content/migrations/using-github-enterprise-importer/ado/follow-up-tasks.md @@ -1,7 +1,7 @@ --- -title: "Follow-up tasks" -shortTitle: "6. Follow-up tasks" -intro: "After each migration has finished, you'll need to complete some additional tasks before the repository is ready for work." +title: Follow-up tasks +shortTitle: 6. Follow-up tasks +intro: After each migration has finished, you'll need to complete some additional tasks before the repository is ready for work. versions: fpt: '*' ghec: '*' @@ -12,6 +12,7 @@ category: - Migrate from Azure DevOps redirect_from: - /migrations/ado/phase-6-follow-up-tasks + - /migrations/ado/follow-up-tasks --- {% data reusables.enterprise-migration-tool.follow-up-tasks-common %} @@ -25,4 +26,4 @@ If you used Azure Pipelines or Azure Boards previously and want to continue usin ## Supporting your developers in their new environment -There are some difference between Azure DevOps and {% data variables.product.github %} that would be helpful for you and your developers to know. Share [AUTOTITLE](/migrations/ado/key-differences-between-azure-devops-and-github) with them. +There are some difference between Azure DevOps and {% data variables.product.github %} that would be helpful for you and your developers to know. Share [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/key-differences-between-azure-devops-and-github) with them. diff --git a/content/migrations/ado/granting-the-migrator-role.md b/content/migrations/using-github-enterprise-importer/ado/granting-the-migrator-role.md similarity index 84% rename from content/migrations/ado/granting-the-migrator-role.md rename to content/migrations/using-github-enterprise-importer/ado/granting-the-migrator-role.md index 74a2cf3476ff..eab2a03f10d2 100644 --- a/content/migrations/ado/granting-the-migrator-role.md +++ b/content/migrations/using-github-enterprise-importer/ado/granting-the-migrator-role.md @@ -1,13 +1,15 @@ --- -title: "Granting the migrator role" +title: Granting the migrator role shortTitle: Migrator role -intro: "The migrator role gives a user or team the ability to run migrations on behalf of an organization." +intro: The migrator role gives a user or team the ability to run migrations on behalf of an organization. versions: fpt: '*' ghec: '*' contentType: other category: - Migrate from Azure DevOps +redirect_from: + - /migrations/ado/granting-the-migrator-role --- To allow someone other than an organization owner to run a migration or download migration logs, you can grant the migrator role to a user or team. diff --git a/content/migrations/ado/index.md b/content/migrations/using-github-enterprise-importer/ado/index.md similarity index 62% rename from content/migrations/ado/index.md rename to content/migrations/using-github-enterprise-importer/ado/index.md index d7889bf1c5cc..d68d4e61988a 100644 --- a/content/migrations/ado/index.md +++ b/content/migrations/using-github-enterprise-importer/ado/index.md @@ -18,15 +18,16 @@ children: - /granting-the-migrator-role redirect_from: - /migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud + - /migrations/ado introLinks: - ado_key_differences: /migrations/ado/key-differences-between-azure-devops-and-github + ado_key_differences: /migrations/using-github-enterprise-importer/ado/key-differences-between-azure-devops-and-github contentType: tutorials docsTeamMetrics: - ado-migration heroImage: /assets/images/banner-images/hero-2 sidebarLink: text: Get started - href: /migrations/ado + href: /migrations/using-github-enterprise-importer/ado layout: journey-landing journeyArticlesHeading: "Steps to completing your migration" journeyTracks: @@ -34,11 +35,11 @@ journeyTracks: title: Run your migration description: Migrate your repositories from Azure DevOps to GitHub. guides: - - href: /migrations/ado/understand-migrations-from-azure-devops-to-github - - href: /migrations/ado/manage-access - - href: /migrations/ado/install-and-configure-github-enterprise-importer - - href: /migrations/ado/prepare-for-your-migration-from-azure-devops-to-github - - href: /migrations/ado/migrate-your-repositories-from-azure-devops-to-github - - href: /migrations/ado/follow-up-tasks + - href: /migrations/using-github-enterprise-importer/ado/understand-migrations-from-azure-devops-to-github + - href: /migrations/using-github-enterprise-importer/ado/manage-access + - href: /migrations/using-github-enterprise-importer/ado/install-and-configure-github-enterprise-importer + - href: /migrations/using-github-enterprise-importer/ado/prepare-for-your-migration-from-azure-devops-to-github + - href: /migrations/using-github-enterprise-importer/ado/migrate-your-repositories-from-azure-devops-to-github + - href: /migrations/using-github-enterprise-importer/ado/follow-up-tasks --- diff --git a/content/migrations/ado/install-and-configure-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/ado/install-and-configure-github-enterprise-importer.md similarity index 79% rename from content/migrations/ado/install-and-configure-github-enterprise-importer.md rename to content/migrations/using-github-enterprise-importer/ado/install-and-configure-github-enterprise-importer.md index c61aec2d1517..e12f1f938236 100644 --- a/content/migrations/ado/install-and-configure-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/ado/install-and-configure-github-enterprise-importer.md @@ -1,7 +1,7 @@ --- -title: "Install and configure GitHub Enterprise Importer" -shortTitle: "3. Configure GitHub Enterprise Importer" -intro: "Install the {% data variables.product.prodname_ado2gh_cli %} and configure your environment for the migration." +title: Install and configure GitHub Enterprise Importer +shortTitle: 3. Configure GitHub Enterprise Importer +intro: Install the {% data variables.product.prodname_ado2gh_cli %} and configure your environment for the migration. versions: fpt: '*' ghec: '*' @@ -12,6 +12,7 @@ category: - Migrate from Azure DevOps redirect_from: - /migrations/ado/phase-3-install-and-configure-github-enterprise-importer + - /migrations/ado/install-and-configure-github-enterprise-importer --- ## Step 1: Install the {% data variables.product.prodname_ado2gh_cli %} @@ -26,7 +27,7 @@ GitHub Enterprise Importer is a collection of extensions for {% data variables.p Before you can use the {% data variables.product.prodname_ado2gh_cli_short %} to migrate to {% data variables.product.prodname_ghe_cloud %}, you must create {% data variables.product.pat_generic %}s that can access the source and destination organizations, then set the {% data variables.product.pat_generic %}s as environment variables. -1. Make sure you have your {% data variables.product.pat_generic %}s for both {% data variables.product.github %} and Azure DevOps ready. See [AUTOTITLE](/migrations/ado/manage-access?token-backtrack#create-a-personal-access-token-classic-on-github) if you haven't already created a token. +1. Make sure you have your {% data variables.product.pat_generic %}s for both {% data variables.product.github %} and Azure DevOps ready. See [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/manage-access?token-backtrack#create-a-personal-access-token-classic-on-github) if you haven't already created a token. 1. Set environment variables for the {% data variables.product.pat_generic %}s, replacing TOKEN in the commands below with the {% data variables.product.pat_generic %}s you previously created. Use `GH_PAT` for the destination organization and `ADO_PAT` for the source organization. * If you're using Terminal, use the `export` command. diff --git a/content/migrations/ado/key-differences-between-azure-devops-and-github.md b/content/migrations/using-github-enterprise-importer/ado/key-differences-between-azure-devops-and-github.md similarity index 96% rename from content/migrations/ado/key-differences-between-azure-devops-and-github.md rename to content/migrations/using-github-enterprise-importer/ado/key-differences-between-azure-devops-and-github.md index e613f131ea41..b8e83a919d3e 100644 --- a/content/migrations/ado/key-differences-between-azure-devops-and-github.md +++ b/content/migrations/using-github-enterprise-importer/ado/key-differences-between-azure-devops-and-github.md @@ -1,7 +1,7 @@ --- title: Key differences between Azure DevOps and GitHub shortTitle: Key differences -intro: "Core workflows like repository access, authentication, and pull requests differ after moving from Azure DevOps to {% data variables.product.prodname_dotcom %}." +intro: Core workflows like repository access, authentication, and pull requests differ after moving from Azure DevOps to {% data variables.product.prodname_dotcom %}. versions: fpt: '*' ghec: '*' @@ -9,6 +9,8 @@ defaultTool: cli contentType: other category: - Migrate from Azure DevOps +redirect_from: + - /migrations/ado/key-differences-between-azure-devops-and-github --- If you're a member of an organization that has migrated from Azure DevOps to {% data variables.product.github %}, this guide will explain the changes in your workflows to make the migration as smooth as possible. diff --git a/content/migrations/ado/manage-access.md b/content/migrations/using-github-enterprise-importer/ado/manage-access.md similarity index 92% rename from content/migrations/ado/manage-access.md rename to content/migrations/using-github-enterprise-importer/ado/manage-access.md index ebe8c1b6fcc0..903279739329 100644 --- a/content/migrations/ado/manage-access.md +++ b/content/migrations/using-github-enterprise-importer/ado/manage-access.md @@ -1,7 +1,7 @@ --- -title: "Manage access" -shortTitle: "2. Manage access" -intro: "Set up the required access for migrating from Azure DevOps to {% data variables.product.github %}." +title: Manage access +shortTitle: 2. Manage access +intro: Set up the required access for migrating from Azure DevOps to {% data variables.product.github %}. versions: fpt: '*' ghec: '*' @@ -12,6 +12,7 @@ redirect_from: - /migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/managing-access-for-a-migration-from-azure-devops - /migrations/ado/managing-access-for-a-migration-from-azure-devops - /migrations/ado/phase-2-manage-access + - /migrations/ado/manage-access category: - Migrate from Azure DevOps --- @@ -23,7 +24,7 @@ To migrate repositories from Azure DevOps to {% data variables.product.github %} If the person who will perform the migration is **not** a {% data variables.product.github %} organization owner, a {% data variables.product.github %} organization owner must first grant them the migrator role. * If you're a {% data variables.product.github %} organization owner, and intend to perform the migration yourself, you can continue reading this guide. -* If you wish to assign the migrator role to someone else, do that now. Then, the migrator should perform the rest of the steps in these guides. See [AUTOTITLE](/migrations/ado/granting-the-migrator-role). +* If you wish to assign the migrator role to someone else, do that now. Then, the migrator should perform the rest of the steps in these guides. See [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/granting-the-migrator-role). ## Create a {% data variables.product.pat_v1 %} on {% data variables.product.github %} diff --git a/content/migrations/ado/migrate-your-repositories-from-azure-devops-to-github.md b/content/migrations/using-github-enterprise-importer/ado/migrate-your-repositories-from-azure-devops-to-github.md similarity index 90% rename from content/migrations/ado/migrate-your-repositories-from-azure-devops-to-github.md rename to content/migrations/using-github-enterprise-importer/ado/migrate-your-repositories-from-azure-devops-to-github.md index 7f6dd4f13592..da8630d2dd5f 100644 --- a/content/migrations/ado/migrate-your-repositories-from-azure-devops-to-github.md +++ b/content/migrations/using-github-enterprise-importer/ado/migrate-your-repositories-from-azure-devops-to-github.md @@ -1,6 +1,6 @@ --- -title: "Migrate your repositories from Azure DevOps to GitHub" -shortTitle: "5. Migrate repositories" +title: Migrate your repositories from Azure DevOps to GitHub +shortTitle: 5. Migrate repositories intro: Perform a trial run and then migrate your repositories from Azure DevOps to {% data variables.product.github %}. versions: fpt: '*' @@ -15,6 +15,7 @@ redirect_from: - /migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/migrating-repositories-from-azure-devops-to-github-enterprise-cloud - /migrations/ado/migrating-repositories-from-azure-devops-to-github-enterprise-cloud - /migrations/ado/phase-5-migrate-your-repositories-from-azure-devops-to-github + - /migrations/ado/migrate-your-repositories-from-azure-devops-to-github category: - Migrate from Azure DevOps --- @@ -22,7 +23,7 @@ category: ## Prerequisites * You must have completed all previous phases of this guide. -* {% data reusables.enterprise-migration-tool.link-to-support-limitations %} For more information, see [AUTOTITLE](/migrations/ado/understand-migrations-from-azure-devops-to-github). +* {% data reusables.enterprise-migration-tool.link-to-support-limitations %} For more information, see [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/understand-migrations-from-azure-devops-to-github). * {% data reusables.enterprise-migration-tool.delta-migrations-not-supported %} ## Generate a migration script @@ -61,7 +62,7 @@ gh ado2gh generate-script --ado-org SOURCE --github-org DESTINATION --output FIL You can use a single organization for all trial runs, or you can create one test organization for each intended destination organization. Consider including `-sandbox` at the end of the organization names, to clarify that the organizations are intended only for migration validation and not for production. You can delete the test organizations after you're done. 1. Run the trial migrations. -1. Confirm that you are able to complete the follow-up tasks in [AUTOTITLE](/migrations/ado/follow-up-tasks). +1. Confirm that you are able to complete the follow-up tasks in [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/follow-up-tasks). 1. Ask users to validate the results of the migrations. 1. Resolve any issues uncovered by your trial migrations. {% data reusables.enterprise-migration-tool.delete-test-organization %} diff --git a/content/migrations/ado/prepare-for-your-migration-from-azure-devops-to-github.md b/content/migrations/using-github-enterprise-importer/ado/prepare-for-your-migration-from-azure-devops-to-github.md similarity index 96% rename from content/migrations/ado/prepare-for-your-migration-from-azure-devops-to-github.md rename to content/migrations/using-github-enterprise-importer/ado/prepare-for-your-migration-from-azure-devops-to-github.md index 18e706b5be2f..06173c133537 100644 --- a/content/migrations/ado/prepare-for-your-migration-from-azure-devops-to-github.md +++ b/content/migrations/using-github-enterprise-importer/ado/prepare-for-your-migration-from-azure-devops-to-github.md @@ -1,6 +1,6 @@ --- -title: "Prepare for your migration from Azure DevOps to GitHub" -shortTitle: "4. Prepare to migrate" +title: Prepare for your migration from Azure DevOps to GitHub +shortTitle: 4. Prepare to migrate intro: Plan your migration by understanding your timeline, what data will be migrated, and your organizational structure. versions: fpt: '*' @@ -12,6 +12,7 @@ category: - Migrate from Azure DevOps redirect_from: - /migrations/ado/phase-4-prepare-for-your-migration-from-azure-devops-to-github + - /migrations/ado/prepare-for-your-migration-from-azure-devops-to-github --- ## Determine how much you have to migrate diff --git a/content/migrations/ado/understand-migrations-from-azure-devops-to-github.md b/content/migrations/using-github-enterprise-importer/ado/understand-migrations-from-azure-devops-to-github.md similarity index 78% rename from content/migrations/ado/understand-migrations-from-azure-devops-to-github.md rename to content/migrations/using-github-enterprise-importer/ado/understand-migrations-from-azure-devops-to-github.md index c640d3c68811..4f6210eb56db 100644 --- a/content/migrations/ado/understand-migrations-from-azure-devops-to-github.md +++ b/content/migrations/using-github-enterprise-importer/ado/understand-migrations-from-azure-devops-to-github.md @@ -17,6 +17,7 @@ redirect_from: - /migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/overview-of-a-migration-from-azure-devops-to-github-enterprise-cloud - /migrations/ado/overview-of-a-migration-from-azure-devops-to-github-enterprise-cloud - /migrations/ado/phase-1-understand-migrations-from-azure-devops-to-github + - /migrations/ado/understand-migrations-from-azure-devops-to-github category: - Migrate from Azure DevOps --- @@ -29,7 +30,13 @@ You can only use {% data variables.product.prodname_importer_proper_name %} to m Before you create your enterprise account on {% data variables.product.prodname_dotcom %}, decide whether your enterprise will use {% data variables.product.prodname_emus %}. This affects how your members authenticate and how you manage identities and access. See [AUTOTITLE](/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/choose-an-enterprise-type). -To learn more about the differences between {% data variables.product.prodname_dotcom %} and Azure DevOps, see [AUTOTITLE](/migrations/ado/key-differences-between-azure-devops-and-github). +To learn more about the differences between {% data variables.product.prodname_dotcom %} and Azure DevOps, see [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/key-differences-between-azure-devops-and-github). + +### Alternative tooling for migrations to {% data variables.enterprise.data_residency_site %} + +This journey describes migrations with {% data variables.product.prodname_importer_proper_name %}. If downtime is a concern, {% data variables.product.prodname_elm %} is an alternative tool that keeps repositories available to developers for most of the migration. See [AUTOTITLE](/migrations/elm/about-live-migrations). + +{% data variables.product.prodname_elm_short %} for Azure DevOps is in {% data variables.release-phases.public_preview %} and only supports migrations to {% data variables.enterprise.data_residency_site %}, not {% data variables.product.prodname_dotcom_the_website %}. For more information, see [Enterprise live migrations overview](https://learn.microsoft.com/azure/devops/repos/enterprise-live-migrations/overview) in the Microsoft Learn documentation. ## Support for Azure Pipelines and Azure Boards diff --git a/content/migrations/ado/use-graphql-to-migrate-repositories-from-azure-devops-to-github-enterprise-cloud.md b/content/migrations/using-github-enterprise-importer/ado/use-graphql-to-migrate-repositories-from-azure-devops-to-github-enterprise-cloud.md similarity index 88% rename from content/migrations/ado/use-graphql-to-migrate-repositories-from-azure-devops-to-github-enterprise-cloud.md rename to content/migrations/using-github-enterprise-importer/ado/use-graphql-to-migrate-repositories-from-azure-devops-to-github-enterprise-cloud.md index 9438ebdaed29..10034b5415b6 100644 --- a/content/migrations/ado/use-graphql-to-migrate-repositories-from-azure-devops-to-github-enterprise-cloud.md +++ b/content/migrations/using-github-enterprise-importer/ado/use-graphql-to-migrate-repositories-from-azure-devops-to-github-enterprise-cloud.md @@ -9,9 +9,11 @@ defaultTool: cli contentType: other category: - Migrate from Azure DevOps +redirect_from: + - /migrations/ado/use-graphql-to-migrate-repositories-from-azure-devops-to-github-enterprise-cloud --- -> [!NOTE] You can also use {% data variables.product.prodname_ado2gh_cli %} to perform your migration. See [AUTOTITLE](/migrations/ado/understand-migrations-from-azure-devops-to-github). +> [!NOTE] You can also use {% data variables.product.prodname_ado2gh_cli %} to perform your migration. See [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/understand-migrations-from-azure-devops-to-github). ## Step 0: Get ready to use the {% data variables.product.prodname_dotcom %} GraphQL API @@ -110,7 +112,7 @@ mutation startRepositoryMigration ( {% data reusables.enterprise-migration-tool.startRepositoryMigration-table-ec %} | `sourceRepositoryUrl` | The URL of your source repository, using the format `https://dev.azure.com/{organization}/{project}/_git/{repository}`. -For {% data variables.product.pat_generic %} requirements, see [AUTOTITLE](/migrations/ado/manage-access). +For {% data variables.product.pat_generic %} requirements, see [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/manage-access). {% data reusables.enterprise-migration-tool.next-check-status %} @@ -124,5 +126,5 @@ For {% data variables.product.pat_generic %} requirements, see [AUTOTITLE](/migr ## Further reading -* [AUTOTITLE](/migrations/ado/follow-up-tasks) -* [AUTOTITLE](/migrations/ado/key-differences-between-azure-devops-and-github) +* [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/follow-up-tasks) +* [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/key-differences-between-azure-devops-and-github) diff --git a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer.md index fe8504f958b4..a50ef684f3e5 100644 --- a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer.md @@ -64,7 +64,7 @@ If your migration source is Azure DevOps, you can download the latest migration gh ado2gh download-logs --github-target-org DESTINATION --target-repo REPOSITORY --migration-log-file FILENAME ``` -* {% data reusables.enterprise-migration-tool.add-pat-to-download-logs %}{% ifversion fpt or ghec %} For {% data variables.product.pat_generic %} requirements, see [AUTOTITLE](/migrations/ado/manage-access).{% endif %} +* {% data reusables.enterprise-migration-tool.add-pat-to-download-logs %}{% ifversion fpt or ghec %} For {% data variables.product.pat_generic %} requirements, see [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/manage-access).{% endif %} * {% data reusables.enterprise-migration-tool.add-target-api-url %} ### Downloading a repository migration log with the {% data variables.product.prodname_bbs2gh_cli_short %} diff --git a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer.md index ce0dc182e711..6f646c67129c 100644 --- a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer.md @@ -80,7 +80,7 @@ If your migration source is a {% data variables.product.prodname_dotcom %} produ If your migration source is Azure DevOps, you can reclaim mannequins with the {% data variables.product.prodname_ado2gh_cli %}. -* {% data reusables.enterprise-migration-tool.add-pat-to-reclaim-mannequins %}{% ifversion fpt or ghec %} For {% data variables.product.pat_generic %} requirements, see [AUTOTITLE](/migrations/ado/manage-access).{% endif %} +* {% data reusables.enterprise-migration-tool.add-pat-to-reclaim-mannequins %}{% ifversion fpt or ghec %} For {% data variables.product.pat_generic %} requirements, see [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/manage-access).{% endif %} * {% data reusables.enterprise-migration-tool.add-target-api-url %} {% data reusables.enterprise-migration-tool.create-csv-mannequins %} diff --git a/content/migrations/using-github-enterprise-importer/index.md b/content/migrations/using-github-enterprise-importer/index.md index 3d2b8e37bf8f..dd8bc3c291d1 100644 --- a/content/migrations/using-github-enterprise-importer/index.md +++ b/content/migrations/using-github-enterprise-importer/index.md @@ -8,6 +8,7 @@ versions: ghec: '*' children: - /understanding-github-enterprise-importer + - /ado - /migrating-from-bitbucket-server-to-github-enterprise-cloud - /migrating-between-github-products - /migrate-from-gitlab diff --git a/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer.md index a95783d618e6..8d43ce680b17 100644 --- a/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer.md @@ -50,7 +50,7 @@ In supported patch releases in version 3.17 and later, {% data variables.product To learn more about the migration path you require, and the data that {% data variables.product.prodname_importer_proper_name %} migrates, see the following articles. {% ifversion fpt or ghec %} -* [AUTOTITLE](/migrations/ado/understand-migrations-from-azure-devops-to-github) +* [AUTOTITLE](/migrations/using-github-enterprise-importer/ado/understand-migrations-from-azure-devops-to-github) {% endif %} * [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-bitbucket-server-to-github-enterprise-cloud/about-migrations-from-bitbucket-server-to-github-enterprise-cloud) * [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/about-migrations-between-github-products) diff --git a/content/repositories/creating-and-managing-repositories/creating-a-template-repository.md b/content/repositories/creating-and-managing-repositories/creating-a-template-repository.md index 7ff0d9add747..1250fd32d5d4 100644 --- a/content/repositories/creating-and-managing-repositories/creating-a-template-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-template-repository.md @@ -30,8 +30,6 @@ After you make your repository a template, anyone with access to the repository {% ifversion fpt %} -> [!NOTE] -> You can use a template repository as starter code for an assignment on {% data variables.product.prodname_classroom %}. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository). {% endif %} diff --git a/data/reusables/classroom/about-feedback-pull-requests.md b/data/reusables/classroom/about-feedback-pull-requests.md index db228cb1f582..e62a34585d89 100644 --- a/data/reusables/classroom/about-feedback-pull-requests.md +++ b/data/reusables/classroom/about-feedback-pull-requests.md @@ -1 +1 @@ -Optionally, you can enable feedback pull requests on assignments. If you enable this feature for an assignment, {% data variables.product.prodname_classroom %} creates a special pull request titled **Feedback** in the assignment repository for each student or group. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests). +Optionally, you can enable feedback pull requests on assignments. If you enable this feature for an assignment, {% data variables.product.prodname_classroom %} creates a special pull request titled **Feedback** in the assignment repository for each student or group. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). diff --git a/data/reusables/classroom/about-ide-integration.md b/data/reusables/classroom/about-ide-integration.md index 1b921b481662..a7b8e478861c 100644 --- a/data/reusables/classroom/about-ide-integration.md +++ b/data/reusables/classroom/about-ide-integration.md @@ -1 +1 @@ -You can integrate a classroom with an IDE. Students can make changes to their assignment repositories through the IDE, or by checking out and running code locally with the appropriate software. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide). +You can integrate a classroom with an IDE. Students can make changes to their assignment repositories through the IDE, or by checking out and running code locally with the appropriate software. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). diff --git a/data/reusables/classroom/assignments-classroom-prerequisite.md b/data/reusables/classroom/assignments-classroom-prerequisite.md index a06a6bab014d..16672a6df81a 100644 --- a/data/reusables/classroom/assignments-classroom-prerequisite.md +++ b/data/reusables/classroom/assignments-classroom-prerequisite.md @@ -1 +1 @@ -You must create a classroom before you can create an assignment. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms). +You must create a classroom before you can create an assignment. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). diff --git a/data/reusables/classroom/assignments-guide-make-cutoff-date.md b/data/reusables/classroom/assignments-guide-make-cutoff-date.md index df236d865019..f91c71c1dd97 100644 --- a/data/reusables/classroom/assignments-guide-make-cutoff-date.md +++ b/data/reusables/classroom/assignments-guide-make-cutoff-date.md @@ -1 +1 @@ -Optionally, to make the deadline a cutoff date, select **This is a cutoff date**. If you use a cutoff date, students will lose write access to their assignment repositories after the cutoff date has passed unless they receive an extension. For more information on extending assignment deadlines, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/extending-an-assignments-deadline-for-an-individual-or-group). +Optionally, to make the deadline a cutoff date, select **This is a cutoff date**. If you use a cutoff date, students will lose write access to their assignment repositories after the cutoff date has passed unless they receive an extension. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). diff --git a/data/reusables/classroom/assignments-guide-protected-paths.md b/data/reusables/classroom/assignments-guide-protected-paths.md index 8073e7af01fd..2e0f7368f0d7 100644 --- a/data/reusables/classroom/assignments-guide-protected-paths.md +++ b/data/reusables/classroom/assignments-guide-protected-paths.md @@ -1,4 +1,4 @@ -If your assignment has files or directories that are used in the grading process or otherwise shouldn't be edited by students, you can designate them as protected file paths. If a student edits a protected file, a label will be applied to their submission on the assignment overview page for you to investigate. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page). +If your assignment has files or directories that are used in the grading process or otherwise shouldn't be edited by students, you can designate them as protected file paths. If a student edits a protected file, a label will be applied to their submission on the assignment overview page for you to investigate. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). The patterns for protected paths follow rules similar to shell filename globs. It may contain the following meta-characters: diff --git a/data/reusables/classroom/assignments-guide-using-autograding.md b/data/reusables/classroom/assignments-guide-using-autograding.md index 1d3b83854822..6dc1bd71ffc6 100644 --- a/data/reusables/classroom/assignments-guide-using-autograding.md +++ b/data/reusables/classroom/assignments-guide-using-autograding.md @@ -1,6 +1,6 @@ -{% data reusables.classroom.about-autograding %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding). +{% data reusables.classroom.about-autograding %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). -{% data reusables.classroom.use-add-test-drop-down-to-click-grading-method %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding#grading-methods). +{% data reusables.classroom.use-add-test-drop-down-to-click-grading-method %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). Define the parameters of your test case, like the name, commands, inputs, outputs, timeout, and points. When you're done, click **Save test case**. diff --git a/data/reusables/classroom/classroom-admins-link.md b/data/reusables/classroom/classroom-admins-link.md index 687460525ab0..21fd77b10fb3 100644 --- a/data/reusables/classroom/classroom-admins-link.md +++ b/data/reusables/classroom/classroom-admins-link.md @@ -1 +1 @@ -For more information on classroom admins, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#about-management-of-classrooms). +For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). diff --git a/data/reusables/classroom/classroom-codespaces-link.md b/data/reusables/classroom/classroom-codespaces-link.md index 43c1f4288162..96ce4e2f6d7f 100644 --- a/data/reusables/classroom/classroom-codespaces-link.md +++ b/data/reusables/classroom/classroom-codespaces-link.md @@ -1 +1 @@ -You can choose to configure an assignment with {% data variables.product.prodname_github_codespaces %} to give students access to a browser-based {% data variables.product.prodname_vscode %} environment with one-click setup. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom). +You can choose to configure an assignment with {% data variables.product.prodname_github_codespaces %} to give students access to a browser-based {% data variables.product.prodname_vscode %} environment with one-click setup. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). diff --git a/data/reusables/classroom/for-more-information-about-assignment-creation.md b/data/reusables/classroom/for-more-information-about-assignment-creation.md index 0f8131ccf27e..21fd77b10fb3 100644 --- a/data/reusables/classroom/for-more-information-about-assignment-creation.md +++ b/data/reusables/classroom/for-more-information-about-assignment-creation.md @@ -1 +1 @@ -For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment) or [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment). +For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). diff --git a/data/reusables/classroom/google-classroom-note.md b/data/reusables/classroom/google-classroom-note.md index e60c139203ce..414720a2ef4a 100644 --- a/data/reusables/classroom/google-classroom-note.md +++ b/data/reusables/classroom/google-classroom-note.md @@ -1 +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 [AUTOTITLE](/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). +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 [AUTOTITLE](/education/manage-coursework-with-github-classroom). diff --git a/data/reusables/classroom/link-to-assignment-overview-article.md b/data/reusables/classroom/link-to-assignment-overview-article.md index 42ee9e1e505f..09570531d27c 100644 --- a/data/reusables/classroom/link-to-assignment-overview-article.md +++ b/data/reusables/classroom/link-to-assignment-overview-article.md @@ -1 +1 @@ -The assignment overview page provides an overview of your assignment acceptances and student progress. For more information on viewing and using the assignment overview page, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page). +The assignment overview page provides an overview of your assignment acceptances and student progress. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). diff --git a/data/reusables/classroom/reuse-assignment-link.md b/data/reusables/classroom/reuse-assignment-link.md index e04763ca669e..5f31c58364d1 100644 --- a/data/reusables/classroom/reuse-assignment-link.md +++ b/data/reusables/classroom/reuse-assignment-link.md @@ -1 +1 @@ -You can reuse existing assignments in any other classroom you have admin access to, including classrooms in a different organization. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment). +You can reuse existing assignments in any other classroom you have admin access to, including classrooms in a different organization. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). diff --git a/data/reusables/classroom/you-can-choose-a-template-repository.md b/data/reusables/classroom/you-can-choose-a-template-repository.md index f26de704976a..05d96c055945 100644 --- a/data/reusables/classroom/you-can-choose-a-template-repository.md +++ b/data/reusables/classroom/you-can-choose-a-template-repository.md @@ -1,4 +1,4 @@ -You can optionally choose a template repository as starter code for the assignment. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository). +You can optionally choose a template repository as starter code for the assignment. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom). > [!NOTE] > The template repository must belong to your organization or be a public repository on {% data variables.product.github %}. diff --git a/src/graphql/data/fpt/changelog.json b/src/graphql/data/fpt/changelog.json index 0061a8d0dd82..e92f1308629b 100644 --- a/src/graphql/data/fpt/changelog.json +++ b/src/graphql/data/fpt/changelog.json @@ -1,4 +1,17 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

Field resolutionReason was added to object type PullRequestReviewThread

" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2026-11-19" + }, { "schemaChanges": [ { diff --git a/src/graphql/data/fpt/schema-pulls.json b/src/graphql/data/fpt/schema-pulls.json index ea2fa32adddc..30b5c0bf4cb4 100644 --- a/src/graphql/data/fpt/schema-pulls.json +++ b/src/graphql/data/fpt/schema-pulls.json @@ -6727,6 +6727,13 @@ "id": "repository", "href": "/graphql/reference/repos#object-repository" }, + { + "name": "resolutionReason", + "description": "

The reason this thread was resolved, if one was recorded. Currently only Copilot code review threads record a reason.

", + "type": "PullRequestReviewThreadResolutionReason", + "id": "pullrequestreviewthreadresolutionreason", + "href": "/graphql/reference/pulls#enum-pullrequestreviewthreadresolutionreason" + }, { "name": "resolvedBy", "description": "

The user who resolved this thread.

", diff --git a/src/graphql/data/fpt/schema.docs.graphql b/src/graphql/data/fpt/schema.docs.graphql index afe6950c419a..021045e63d1f 100644 --- a/src/graphql/data/fpt/schema.docs.graphql +++ b/src/graphql/data/fpt/schema.docs.graphql @@ -47763,6 +47763,11 @@ type PullRequestReviewThread implements Node @docsCategory(name: "pulls") { """ repository: Repository! + """ + The reason this thread was resolved, if one was recorded. Currently only Copilot code review threads record a reason. + """ + resolutionReason: PullRequestReviewThreadResolutionReason + """ The user who resolved this thread """ diff --git a/src/graphql/data/ghec/schema-pulls.json b/src/graphql/data/ghec/schema-pulls.json index 5575f162b04a..3e0186597425 100644 --- a/src/graphql/data/ghec/schema-pulls.json +++ b/src/graphql/data/ghec/schema-pulls.json @@ -6727,6 +6727,13 @@ "id": "repository", "href": "/graphql/reference/repos#object-repository" }, + { + "name": "resolutionReason", + "description": "

The reason this thread was resolved, if one was recorded. Currently only Copilot code review threads record a reason.

", + "type": "PullRequestReviewThreadResolutionReason", + "id": "pullrequestreviewthreadresolutionreason", + "href": "/graphql/reference/pulls#enum-pullrequestreviewthreadresolutionreason" + }, { "name": "resolvedBy", "description": "

The user who resolved this thread.

", diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index afe6950c419a..021045e63d1f 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -47763,6 +47763,11 @@ type PullRequestReviewThread implements Node @docsCategory(name: "pulls") { """ repository: Repository! + """ + The reason this thread was resolved, if one was recorded. Currently only Copilot code review threads record a reason. + """ + resolutionReason: PullRequestReviewThreadResolutionReason + """ The user who resolved this thread """