search

official-inquiries / official-inquiries.com

Official Inquiries main website
http://reports.datopian.com
5 stars 2 forks source link

Website architecture #3

Open GregoryRhysEvans opened 8 years ago

GregoryRhysEvans commented 8 years ago

How should the website be structured?

From discussion with @rgrp yesterday:

offinq.com/{report-name}/…. {report-name}.offiinq.com/…

inq/ # the report inq/about/ # README + links to sources and cached versions

Do we split up reports into chapters or section in any way? NO: KISS rule (at least for starters)

inq/ # teaser opener -> read more [all in one] or first chapter … inq/chapter-1/ inq/chapter-2/ inq/all-in-one/

Desire would be infinite scroll – just have one page experience (but what about Ctrl+F etc …)

–- title: source: date: author: –-

texts/{my-text}.md => index.md with some tweaks e.g. metadata added.

HACKY simple option: Just store the stuff in gh-pages the way we want … Keep README.md but add jekyll metadata (or move to about/index.md) Move texts/…. => index.md Add in your template stuff … ADVANTAGES: simple to implement, direct workflow for editing if people want to edit DISADV: pretty inflexible, ugly source repo, metadata spread around in different files (and possibly in jekyll _config.yml) Proper version … Build a little webapp or at least deployment app … ADV: very flexible, DISADV: need to run a build somewhere to do site … Needs to be run offline or automated somewhere (maybe travis??)