CodeYourFuture / immersive-go-course

An immersive, introductory course to backend software engineering using go.
https://systems.codeyourfuture.io/
Creative Commons Zero v1.0 Universal
109 stars 94 forks source link

Mark up projects with metadata #199

Open SallyMcGrath opened 6 months ago

SallyMcGrath commented 6 months ago

The projects are already in readmes, which is helpful. In order to drive the new front end, we need them to be revised in the following ways;

  1. Mark up learning objectives with the custom code fence objectives eg
```objectives
1. Add three backticks
2. Write the string `objectives`
3. Write an ordered list of learning objectives
4. Close with three backticks
  1. Add all the additional metadata at the head of the document. Put this in comments to hide it from the GH front end.
<!--
+++
title="Project Name"
description="A one-liner please"
time=1080
themes=['state', 'sharding', 'scaling']
prerequisites=['memcached-clusters']
+++
--->

The primers will need an extra step,

SallyMcGrath commented 6 months ago

@illicitonion Here's some stuff you or anyone could usefully get on with and I will build everything just assuming this stuff exists