techradar2json

Usage

$ tree .
.
├── config.yaml
└── technologies
    └── postgresql
        ├── 1970-01-01-adopt.md
        ├── description.md
        └── meta.yaml
$ techradar2json . > technology-radar.json

See the "basic" test fixture for a working example of the configuration files and directory structure.

meta.yaml

Schema

# REQUIRED
# The display name of the technology (the technology ID is derived from the
# name of the folder)
name: string

# REQUIRED
# The URL for the main landing page of the technology (or whatever is most
# informative for the uninitiated)
homepage: string

# OPTIONAL
# The license associated with the technology. If defined, must be one of the
# following:
# - "open-source"
# - "proprietary"
license: string

# REQUIRED
# The main category/quadrant in which the technology falls. The possible options
# for this are defined in the `config.yaml`
category: string

# REQUIRED
# A list of additional custom tags relevant to the technology. The possible
# options for this are defined in the `config.yaml`
tags: string[]

# REQUIRED
# A list of additional links relevant to the technology (such as further
# documentation or internal-specific resources)
links: string[]

Example

name: PostgreSQL
homepage: https://www.postgresql.org/
license: open-source
category: platforms
tags:
  - database
links:
  - https://example.com/first-link
  - https://example.com/second-link