2015 Theme - v0.1

[rufuspollock]

v0.1

• Basic theme with front page and handbook page
• Migrate sample content from RST to markdown and jekyll

First pass at: http://okfnlabs.org/opendatahandbook-v2/en/what-is-open-data/

[rufuspollock]

Masthead

• I think we may want to make this a bit more prominent in some way - not huge but like NYTimes (maybe even a bit bigger) - http://www.nytimes.com/2015/02/10/world/europe/european-foreign-ministers-postpone-russia-sanctions-to-allow-talks.html
• What else goes in here? Should we have search or quick links to major sections (or just super simple)

Sidebar

• Really nice - only concern is that it requires some complexity (e.g. JS?)
• What about next level down in tree (e.g. parts of a chapter of the handbook)? i.e. if we have 3 levels (Module, Chapter, Section)
• Should we highlight the section we are in in some way
• how will this work out on mobile?

Minor styling:

• block quotes not styled yet
• nice to see what tables look like

[smth]

Masthead
Yeah, I have done zero styling here as yet. I was thinking search could go top-right, once we have that functionality.

Sidebar

• Yes, requires JS. I'm sure we could build in a reasonable fallback though.
• Parts of a chapter is something I had already started working on. You can see those links in the intro section now.
• The section is already highlighted (though not all that obviously at present).
• On smaller screens, menu will be hidden by default, and revealed by clicking an icon (currently a text link). You can get a good idea of this by resizing your browser window.

[smth]

For tables (and other markdown styling), see http://new.opendatahandbook.org/contribute/markdown-examples/

[rufuspollock]

@mintcanary is this bootstrap-based? I'd assumed so but I now realize it may not be.

Like other cases we'd like this theme to be reusable and, if possible, bootstrap based so it fits with our standard setup and can be adapted easily.

[rufuspollock]

More generally, I was intending this could join our "stable" of themes at jekyll-theme. To the extent we can also share standard config options etc that is good too e.g. i assume we have configurable google analytics support built in (its just one config option) and, if so, that we run off same variable as in jekyll-theme repo.

[smth]

Not Bootstrap, no. (I'm not a fan of using Bootstrap in production, so unless there is a specific requirement for it, it isn't my default.) There are frameworks in use however:

• SASS mixins: Bourbon
• Grid: Neat

I'm not familiar with our "standard setup", so cannot comment on that. Could you give examples of what you mean by "adapted easily"?

Standard config options sounds like a good idea. Analytics is not yet in the config for this theme, but obviously easy to add it. Where/what is the "jekyll-theme" repo you mention?

[rufuspollock]

jekyll theme repo: http://github.com/okfn/jekyll-template

Bootstrap: 90%+ of OK sites use bootstrap => our standard setup.

This commonality also creates familiarity plus the ability to reuse css and html structure. Familiarity => ease of adaptability because people are familiar, plus ability to reuse tweaks elsewhere. This also increases maintainability in the medium-term.

Apologies for not making this requirement clearer as product owner earlier on. How much effort would you estimate it would be to bootstrap-ize the theme? (This is not a request to do that - just a question re effort).

[smth]

I think it would be a fairly sizeable task, but we should clarify what this means.

• HTML: Should remain as is - semantic (should be no reference to Bootstrap, or any other framework)
• CSS: Generated by Jekyll, from SASS. Ultimately resulting compiled CSS must remain the same (BS might add some additional, unused stuff).
• SASS: Mixins replaced with BS specific ones. This would be where the work is, and where the impact would be on future developers.
• JS: Largely irrelevant, as we are using (and would continue to use) third party extensions to achieve what we want.

So I think what we are talking about is replacing the SASS library, redefining variables, and rewriting the custom SASS. I'd estimate about a day.

[rufuspollock]

FIXED. Very much done.