hotosm/learnosm — pull request #6 by lxbarth (2012-11-01 21:16:24+00:00)
Title: Jekyll port

@wonderchook

This is a Jekyll based version of LearnOSM.

For a preview look here: http://lxbarth.com/learnosm/en/ (code https://github.com/lxbarth/learnosm)

If we like this, we can merge and start committing content to it.

- Sets up a light Jekyll-based site for LearnOSM (not yet implementing #1)
- Sets up a translation architecture
- Sketches out translation reporting (click on Translation status)
- Ready to add content
- Ready to be used through prose.io - all you need is a GitHub account hooked up to the learnosm repo.

## Next actions

*Once merged*

- Convert remaining content (including pictures) from reStructured text to markdown
- Implement script for translation status reporting

## Background

- We want to move off of the current CMS
- We need a way to track whether translations are up to date

*Jekyll*

- HTML site generator
- Supported natively by GitHub pages
- Nicely supports clean markdown, moving our docs to a very sustainable format
- We can update documents dynamcally through prose.io

## Other notes notes:

- I just used pandoc to convert the intro as an example
- Example format for i18n https://raw.github.com/lxbarth/learnosm/gh-pages/_posts/en/beginner/0200-01-01-introduction.md for an example
- permalink sets the path
- lang sets the page's translation
- polylink is redundant, but necessary for language switching. poly as in polyglott :p
- Tracking changes between language versions will be done by a simple script that compares commit logs on a file by file basis and generates status reports.
- http://lxbarth.com/learnosm/en/status/
- https://github.com/lxbarth/learnosm/tree/gh-pages/_posts/es/status
- Status could be embedded on the actually translated page
- This would be a script that a site admin runs every once in a while on a local copy of learnosm then pushing it back to the repo