venue-taxonomy icon indicating copy to clipboard operation
venue-taxonomy copied to clipboard

Proposed JSON Spec and Tools

Open ericlucit opened this issue 3 years ago • 3 comments

Warning - This is a massive change.

The overall "why" is a machine readable source of this data. So 3rd parties can easily pull in changes when this spec updates.

Objective The objective of this change is to introduce

  • A json source of truth
  • A better method for organizing versioned spec files
  • A tool for generating the human readable markup .md files from the json source

Changes

  • Most files in the root directory of the repo have moved into sub-directories.
  • Versions of the spec live in versioned sub-directories specification/1.0/, specification/1.1/, etc.
  • The most current version of the spec lives in specification/specification.json

Tools

  • This change introduces a build tool (Requires docker and probably...wsl although it might work from a windows shell)

Process Changes Future spec pull requests should be made to the specification/x.y/specification.json file - Changes made to older files, or the primary spec, should be rejected

The README Note that the README has been updated with instructions on using the build tool.

ericlucit avatar May 21 '21 21:05 ericlucit