Skip to content

Migration plan 2015

Joe Corneli edited this page May 18, 2015 · 3 revisions

We have the current site content in this Github repository. Since Peeragogy.org has been inactive and has recently been compromised with malware, it makes sense to move ahead with a Github-focused solution.

In addition to picking something that's relatively easy from the system side, we should also try to do something that is easy from the contributor side. What will encourage contributions?


After a successful experiment using Authorea for editing over the web, one option would be to do the following:

  • Divide the content into chapters
  • Sync each chapter with Authorea
  • Pull from the various chapters into the outline using Git submodule
  • Have a Pandoc script that converts LaTeX to Markdown
  • Push updated markdown into Peeragogy.github.io (using Jekyll)

Future editing will happen in LaTeX, directly on Github or on the synced Authorea pages.


However, there are other alternatives that we should seriously consider. The first option is basically just a subset of the above.

In short, we could use Markdown the main format for editing, and not LaTeX. It's a simpler language, but we don't have a lot of fancy equations or anything like that to manage. We could use Github as the editing platform rather than Authorea, which may be easier. Exporting Markdown to LaTeX is of course possible when it comes time to move the book to print.


If there are other options (E.g. someone suggested ReStructuredText) they are probably similar to those above.

Action plan

  1. Set up Jekyll and push Markdown to the peeragogy.github.io site so that we have a webpage to display
  2. Fine tune the look and feel of that
  3. Decide whether we want to work with Authorea, and, if so, add that layer of workflow as described above.
  4. Fine tune whatever process we decide.
Clone this wiki locally