GitHub Pages course: point of confusion on themes

Hi. Greetings from Canada.

So far I think that the GitHub Learning Lab courses are a pretty good introduction to GitHub. Thanks for setting them up and for providing feedback and for fixing reported bugs so quickly!

I would like to report an item in the GitHub Pages course that tripped me up quite a bit.

Step 5 here says:

5.1. On the Code tab, click the _config.yml file
5.2. Click the pencil (✏) icon to enter edit mode and change the theme: to minima

Now the theme that I had initially chosen via the GitHub website GUI, in accordance with Step 4 of the lesson (again, see the PDF linked to above), was “Midnight” - which was translated into text, in _config.yml, as “jekyll-theme-midnight”.

It was not entirely clear whether I was supposed to edit that “theme:” text-entry to just “minima”, or whether it needed to keep the prefix and so become “jekyll-theme-minima”.

I guessed the latter.

Which, as it turns out, is incorrect; it really should have been just “theme: minima”.

The github-learning-lab[bot] did not catch the mistake, and the only indication I received - later, when I happened to check my email - was an email (one of many that I received about the activities in that repository), stating:

You are attempting to use a Jekyll theme, "jekyll-theme-minima", which is not supported by GitHub Pages.
Please visit[]( a list of supported themes.

Incidentally, that /themes/ page lists a theme called “minima” AND another theme called “minimal”, which is confusing enough if one is not reading carefully.

Even worse: The GUI theme selector (per Step 4) lists all of the same themes as that /themes/ page *except* for “minima”.

Please, please specify a different theme in Step 5. ALL of the other twelve themes listed on the above /themes/ page - and so ALL of the ones shown in the GUI - include the “jekyll-theme-” prefix. (I recognize that the prefix is not a technical/logical requirement, but it is semantically clearer. And it seems really odd, to me, for Step 5 to specify the sole exception to that convention.) I guess that the idea behind choosing “minima” was to be certain that everyone would be forced to actually do Step 5, since no one could have chosen that theme in Step 4. That’s good thinking, and I applaud that sort of foresight. But, again, please, please choose a theme the *does* require the “jekyll-theme-” prefix, just for the sake of consistency (and to avoid confusion among those, like me, who overthink everything). And while you’re at it, please use a theme name that is more distinct!

Many thanks, much appreciation,

Hello Edward from Canada! Greetings from Briana in Germany.

Thank you for taking the time to post this. I think you’re right, the current explanation isn’t clear, and it’s difficult to tell exactly what you’re supposed to edit. I’m going to start working on a fix now. Unfortunately we don’t have control over how the themes are named, but we can definitely try to make it more clear in the instructions. :smiley:

Eduardo from Brazil/Germany here :slight_smile:

Just wanted to let you know the instructions are still confusing. As you can see below, the instructions mention THREE different themes in the same activity.

"It looks like you changed your theme, but for this activity we want to use jekyll-theme-minimal.

Activity: Change the theme to jekyll-theme-cayman

Let’s change the theme to minima:

  1. At the top of this Pull Request, click the  Files changed  tab
  2. Click the icon to enter edit mode and change the theme: to jekyll-theme-minimal
  3. Scroll to the bottom of the window to create a commit
  4. _Enter a commit message then click  Commit changes" _

@edusemensati Thank you for bringing this to our attention! This appears to be a bug in a new feature we’re working on. I’m letting the engineering team know what you’ve found, so that we can resolve it. Thank you for helping us make Learning Lab better. :) 

1 Like