pysal / geopyter

GeoPyTeR: Geographical Python Teaching Resource
68 stars 17 forks source link

Metadata Tracking #14

Open jreades opened 7 years ago

jreades commented 7 years ago

What metadata do we need to track about each notebook?

  1. How long each section should take
  2. Difficulty level
  3. Authorship
  4. Git status

Ideas from software carpentry web site?

jreades commented 7 years ago

Duration for each section is a little harder than for the notebook as a whole since it needs to be embedded in each block somehow -- at what level would you really want to track this? I figure nothing below h1 level anyway, but there's a question then as to whether the format of a table is really appropriate.

jreades commented 7 years ago

Provisionally settled on a list format:

This is easy to write and fairly flexible. It has to be in the first cell and the assumption is that the first cell only contains metadata and the name of the Atom.

jreades commented 7 years ago

Need to track license & append to footer.

A little RGS logo would be nice too during the start-up phase. Later can just go on the homepage.

jreades commented 7 years ago

Allow someone to specify duration (in hh:mm) for any section/subsection that starts a markdown cell. So you could have it for h1 through h5 levels but we'll only look for metadata in an unordered list immediately after a section heading that starts a new markdown cell.