Add new conceptual article 'About GitHub Classroom'

[saritai]

[maintainer edit]
This issue is reserved for the MLH Fellowship program.

What article on docs.github.com is affected?

This will be a new article in the "Get started with GitHub Classroom" part of the docs site, called "About GitHub Classroom".

The "About GitHub Classroom" article can be placed as the first article in the "Get started with GitHub Classroom" map topic.

What part(s) of the article would you like to see updated?

Why

Currently, the GitHub Classroom docs do not have a conceptual overview or introduction article telling users about GitHub Classroom. There is a "GitHub Classroom basics" page, but this mainly contains links to YouTube videos.

We want to add an article that can be linked in the "Get started with GitHub Classroom" table of contents section, called 'About GitHub Classroom".

Use cases and audience

This page is useful for users who are new to GitHub Classroom and want to know what it is and all the features it offers, at a high-level and in one place. In an article like this, they also want links to other useful articles about each of these features.

The audience could be prospective teachers and students, as well as school or organization administrators that are interested in implementing this at a larger level for their organization. It could also just be general GitHub users who have come across this while perusing the docs for other reasons.

Getting started

You can get started by learning more about conceptual content in our content model.

You can then view our Conceptual content template and follow it to create the article.

The article should be created in the education/managing-your-coursework directory.

The “About GitHub Classroom” article should have the following sections, at least:

• About GitHub Classroom - this section should, in a couple paragraphs, introduce GitHub Classroom, defining what it is, its purpose and why it is useful. This could include use cases or examples.
• GitHub Classroom features - this section could be a high level overview of the features of GitHub classroom - details such as those highlighted in the GitHub Classroom website. For example, that you can create individual or group assignments, give feedback via pull requests, set up autograding, integrate with an IDE.
• Further reading - this section should direct users where to go to get started and learn more detailed information - we should include links to the major sections/TOCs. So we could include a link to "GitHub Classroom basics" page for if they want to view videos on how to get started. https://docs.github.com/en/education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom. We should also include a link to “Teach with GitHub Classroom” for teachers to get started setting up classrooms and assignment, and also a link to “Integrate GitHub Classroom with an IDE” if they want to learn more about that. And for students who want to learn more about the GitHub Classroom learning experience, we can link to “Learn with GitHub Classroom”.

You will also need to update the "Manage coursework with GitHub Classroom" index file with a link to the article. The article should be placed as the first link in the “Get started with GitHub Classroom” map topic.

Additional information

This issue is for a special project and is not currently available for contributors to work on.

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.