AOEpeople/aoe_technology_radar

Name: aoe_technology_radar

Owner: AOE

Description: A static site generator for AOE Technology Radar

Created: 2017-02-13 07:31:39.0

Updated: 2017-04-07 12:44:54.0

Pushed: 2018-01-08 09:10:09.0

Homepage: http://www.aoe.com/techradar

Size: 880

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

AOE Technology Radar

A static site generator for AOE Technology Radar

Installation

t clone git@github.com:AOEpeople/aoe_technology_radar.git
 aoe_technology_radar
m install
m run watch

A new browser tab should open up - wait until last command has finished and refresh.

Usage

For a new Technology Radar release, create a folder of the release date (YYYY-MM-DD) under /radar. In each release folder create a folder for every quadrant and place the items there.

Maintaining items

The items are written in Markdown format (.md)

Each file has a front-matter header where the attributes of the item are listed:

-
tle:      "React"
ng:       adopt
adrant:   languages-and-frameworks
-

xt goes here. You can use **markdown** here.

Following front-matter attributes are possible:

• title: Name of the Item
• quadrant: Quadrant. One of languages-and-frameworks, methods-and-patterns, platforms-and-aoe-services, tools
• ring: Ring section in radar. One of trial, assess, adopt, hold
• info: (optional) A short textual description of the item (visible in overview pages)

The name of the .md file acts as item identifier and may overwrite items with the same name from older releases.

If an item is overwritten in a new release, the attributes from the new item are merged with the old ones and a new history entry is created for that item.

Travis

Todos

• [x] Add Icons
• [x] Implement search
• [ ] Finalize CSS
• [x] Get contents for how-to-use page
• [ ] Show item history on details (relevant with 2nd release)
• [ ] Better semantic and SEO
• [ ] Make mobile friendly
• [ ] Add mobile navigation and search
• [ ] Create more react components for already existing CSS comps
• [ ] Refactor hardcoded subfolder in routing
• [ ] Unit test for radar generation :see_no_evil: