GeoDaCenter / GeoDaCenter/data-and-lab

Standardize dataset description parameters with YAML header

Open
#25 1 comment 0 reactions 1 assignee Claimed by @angela-li View on GitHub
Dominant language
No language data
Stars
1
Forks
2
Avg merge
9m
Merged PRs (30d)
1

Description

Currently, there is no standard structure to our data descriptions, which makes it very difficult to use a machine to read the page. I'd like to develop an HTML/CSS template with a YAML header for our data descriptions in `posts` to standardize our data descriptions. (I can do this by editing the template in `initpost.sh` I believe - @lixun910 correct me if I'm wrong.)

The idea is to have a YAML header in each post that we fill out, which Jekyll then plugs into a HTML/CSS template with custom tags, that is set up to be easily webscraped and analyzed. This will also make it easier to add and document datasets in the future, without having to worry about formatting/layout.

Here's an example of what I think this would look like:
```
---
source: Chicago Open Data Portal
author: Luc Anselin
variables: 77
observations: X
(more YAML parameters...)
---

Source:


{{page.source}}


Author:


{{page.author}}


(more HTML/CSS...)
```

> Note: This idea was inspired by Software Carpentry's workshop website template - see an [example here](https://raw.githubusercontent.com/carpentries/workshop-template/gh-pages/index.md) of how this works, and the [produced page](http://carpentries.github.io/workshop-template/).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.