NUKnightLab / NUKnightLab/TimelineJS3

Feature request: enable YAML input files

Open
#641 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
3.2k
Forks
645
PR merge metrics
No merged PRs in 30d

Description

For those of us who are not too keen on putting our data on a Google spreadsheet, but don't want the hassle of writing JSON, the ability to write timeline content in YAML would be very convenient. JSON serialization could be achieved quite easily through the YAML library.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how TimelineJS currently reads JSON or Google Spreadsheet data, then review the YAML library linked in the issue. Done means timeline content can be supplied in YAML and produces the same result as existing input paths, with coverage for the new input format.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, yaml
Domain
data
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.