Building: Content for the catalog

The course repository contains content in config.yml that will be used to list your course in the Learning Lab catalog. This section explains that data and how it used throughout Learning Lab.

GitHub Learning Lab's mascot A course on GitHub Learning Lab can guide you through this step.

Introduction to the config.yml file

Fields used for the catalog

Add the following fields to the top of config.yml in the course repositories. These fields are used throughout the Learning Lab course catalog.

Field Required Description
title The title of your course
tagline A short description of your course
description A slightly longer description of your course
tags A list of tags used to filter through the catalog

Here's an example of what a course's config.yml should looks like with these fields.

Views of the catalog fields

Learning Lab displays the catalog fields in different ways, depending on the state of the course and the context of the information.

View Screenshot
Catalog in /courses
Course landing page, unregistered
Course landing page, registered