Skip to content

Commit

Permalink
docs: move editLink config into readme
Browse files Browse the repository at this point in the history
  • Loading branch information
d-koppenhagen authored and bastianccm committed Feb 2, 2022
1 parent 72883ca commit fcdbb40
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ To change the logo, create a public folder in your application and put your `log

For reference have a look at [public/logo.svg](./public/logo.svg).

### Change the logo
### Change the date format
By default the Date format used in the app is `"MMMM YYYY"`.
You can change this by editing the config file as shown below.
Please be sure you are entering a valid [moment.js format string](https://momentjs.com/docs/#/displaying/format).
Expand All @@ -124,6 +124,20 @@ Please be sure you are entering a valid [moment.js format string](https://moment

For reference have a look at [public/logo.svg](./public/logo.svg).

### Edit from published radar

You can activate the `editLink` feature which will display a small edit button next to a technology which let's you jump directly to a gitlab / github / etc. edit page:

```json
{
// ...
"editLink": {
"radarLink": "https://github.com/AOEpeople/techradar/edit/main/radar",
"title": "Edit"
}
}
```

### Change the rings and quadrants config
To change the default rings and quadrants of the radar, you can place a custom `config.json` file within the `public` folder.
The `showEmptyRings` option can be enabled to display the header for a ring even when it contains no items (helpful to
Expand Down
6 changes: 1 addition & 5 deletions public/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,5 @@
}
]
},
"dateFormat": "MMMM YYYY",
"editLink": {
"radarLink": "https://github.com/AOEpeople/techradar/edit/main/radar",
"title": "Edit"
}
"dateFormat": "MMMM YYYY"
}

0 comments on commit fcdbb40

Please sign in to comment.