Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize dataset description parameters with YAML header #25

Open
angela-li opened this issue May 20, 2019 · 1 comment
Open

Standardize dataset description parameters with YAML header #25

angela-li opened this issue May 20, 2019 · 1 comment
Assignees

Comments

@angela-li
Copy link
Member

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...)
---

<h3>Source: </h3>
<p class="source"> {{page.source}}</p>
<h3> Author: </h3>
<p class="author"> {{page.author}} </p>
(more HTML/CSS...)

Note: This idea was inspired by Software Carpentry's workshop website template - see an example here of how this works, and the produced page.

@angela-li angela-li self-assigned this May 20, 2019
@angela-li
Copy link
Member Author

Set this infrastructure up in 65438b8, still need to fix formatting of the webpage, and move all datasets over to this format.

This will setup will make it possible to tackle #26 relatively easily.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant