influencemapping / influencemapping.github.io

Web site for the Influence Mapping Toolbox
https://influencemapping.github.io/
5 stars 13 forks source link

Markdown versions of CSV. #2

Open jmatsushita opened 8 years ago

jmatsushita commented 8 years ago

Hi @pudo

I've generated an intermediary markdown representation of the spreadsheet/csv in the data branch of the repo: https://github.com/iilab/influencemapping-toolbox/tree/data/build

You might prefer to output the projects and tools as YAML with a converter, but the practices are probably good to put as pages into Jekyll.

Cheers,

Jun

jmatsushita commented 8 years ago

Hi @pudo

With metalsmtih you can rename this tool.md template to tool.yml and transform the definition lists into a yaml frontmatter and metalsmith will generate yaml for you.

Cheers,

Jun

jmatsushita commented 8 years ago

Using Jekyll so that it auto-builds without us having to operate infra.

I'm proposing this as a one off generation of YAML. Unless that's already solved? Once you have yaml you can use Jekyll to generate the templates.

pudo commented 8 years ago

Yep, that's all it is. The question is just a) can we make the YAML somewhat nested so that it has some structure. As it is it's super-super-complex and would terrify anyone out of contributing. b) Is it better to generate one big YAML file or many small ones. Again, the complexity of the survey makes me think small files (where everybody creates a new one for their project) might be better.

jmatsushita commented 8 years ago

Yes you can for instance instead of:

# {{ name }}

Logo
:   ![]({{ image }})

Teaser
:   _{{ teaser }}_

Home Page
:   {{ home_page }}

Type
:   {{ type }}

Tags
:   {{ tags }}

Keywords
:   {{ keywords }}

:   {{ source_url }}

Practices
:   {{ practice }} / {{ sub_practice }}
:   {{ practice_2 }} / {{ sub_practice_2 }}
:   {{ practice_3 }} / {{ sub_practice_3 }}

Generate yaml with nested structures:

name: {{ name }}
logo: {{ image }}
teaser: "{{ teaser }}"
home_page: {{ home_page }}
...
practices:
  - {{ practice }} / {{ sub_practice }}
  - {{ practice_2 }} / {{ sub_practice_2 }}
  - {{ practice_3 }} / {{ sub_practice_3 }}

I think we've already agreed on the call last week that we would propose the broader data even if it's sparse and allow contributors to fill in the gaps. If you want to iterate on the structure let's do it here.

pudo commented 8 years ago

hi @jmatsushita I've taken a stab at generating yaml files in _projects and _tools. Does this look OK to you?