Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davideicardi/tech-radar-example
Tech Radar example
https://github.com/davideicardi/tech-radar-example
jekyll techradar
Last synced: 6 days ago
JSON representation
Tech Radar example
- Host: GitHub
- URL: https://github.com/davideicardi/tech-radar-example
- Owner: davideicardi
- License: mit
- Created: 2021-08-24T16:54:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-08T03:23:18.000Z (over 3 years ago)
- Last Synced: 2024-12-04T08:26:15.865Z (2 months ago)
- Topics: jekyll, techradar
- Language: HTML
- Homepage: https://davideicardi.github.io/tech-radar-example/
- Size: 162 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tech Radar Example
Tech Radar website using [Jekyll](https://jekyllrb.com/) and [blips-chart](https://github.com/davideicardi/blips-chart).
See [demo here](https://davideicardi.github.io/tech-radar-example/).
A Tech Radar is a list of technologies, complemented by an assessment result, called ring assignment.
The Tech Radar is a tool to inspire and support developers to pick the best technologies; it provides a platform to share knowledge and experience in technologies, to reflect on technology decisions and continuously evolve our technology landscape.
This projects is based on the pioneering work of [ThoughtWorks](https://www.thoughtworks.com/radar) and
the open source project of [Zalando](https://opensource.zalando.com/tech-radar/).
All data are handled using [Jekyll collections](https://jekyllrb.com/docs/collections/).
The following data are handled:
- `quadrants`: list of quadrants inside the radar (must be 4), see `_data/quadrants.yml`.
- `rings`: list of rings inside the radar (must be 4), see `_data/.rings.yml`
- `blips`: list of technologies, see `_blips/`
- `categories`: list of categories, generated automatically from blips
- `testimonials`: list of projects that make use of a technology
All data are stored as html or markdown files, no database is required.
## Adding and updating content
To add or update the list of technologies inside the radar just change the
files inside the `_blips` directory.
Each blip is composed by a markdown file with the following structure:
```
---
title: MongoDb # Name of the technology
longTitle: MongoDb # optional
quadrant: DATA # DATA, PLATFORMS, PATTERNS or LANGUAGES
ring: ADOPT # HOLD, ASSESS, TRIAL or ADOPT
website: https://www.mongodb.com/ # official website, optional
moved: 0 # 0=not moved (default), 1=moved up, -1=moved down, optional
categories: [database] # list of categories, optional
testimonials: [project1] # list of testimonials, optional
stack: [web] # list of stack in which this technology is used, optional
version: 1.0 # version, optional
---
some description
```
## Requirements
- Ruby version 2.5.0 or higher and ruby bundler (see [Installation instructions](https://jekyllrb.com/docs/installation/))
## Build
```
bundle install
bundle exec jekyll build
```
## Development
```
bundle install
bundle exec jekyll serve --livereload
```
Open `http://127.0.0.1:4000`.