Skip to content

Commit

Permalink
feat(#8): Upgrade to AOE Technology Radar v4 (#11)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrablaj committed Apr 9, 2024
1 parent 2fc1d02 commit 11986dd
Show file tree
Hide file tree
Showing 21 changed files with 128 additions and 69 deletions.
14 changes: 14 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
# Enable version updates for npm
- package-ecosystem: "npm"
# Look for `package.json` and `lock` files in the `root` directory
directory: "/"
# Check the npm registry for updates every day (weekdays)
schedule:
interval: "monthly"
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test AOE Technology Radar
name: Test CHT Technology Radar

on:
pull_request:
Expand All @@ -9,7 +9,7 @@ jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: actions/checkout@main
- uses: actions/setup-node@v4
with:
node-version: "lts/*"
Expand Down
22 changes: 0 additions & 22 deletions .github/workflows/semanticore.yml

This file was deleted.

1 change: 0 additions & 1 deletion .husky/commit-msg

This file was deleted.

1 change: 0 additions & 1 deletion .husky/pre-commit

This file was deleted.

3 changes: 3 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions .idea/cht-tech-radar-core.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

46 changes: 13 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,14 @@
# AOE Technology Radar
# CHT Technology Radar Core

A static site generator for AOE Technology Radar
A static site generator for the CHT Technology Radars.

![Screenshot of the AOE Technology Radar](./docs/assets/screenshot-techradar.png)
## Looking for the CHT Technology Radars content?

## Looking for the AOE Tech Radar content?
The repository for the [CHT Technology Radar for Implementers](https://docs.communityhealthtoolkit.org/cht-tech-radar-implementers/index.html) can be found in [medic/cht-tech-radar-implementers](https://github.com/medic/cht-tech-radar-implementers).

- The repository is now found here: https://github.com/AOEpeople/techradar
- The AOE Tech radar is deployed here: https://www.aoe.com/techradar/index.html
The repository for the [CHT Technology Radar for Contributors](https://docs.communityhealthtoolkit.org/cht-tech-radar-contributors/index.html) can be found in [medic/cht-tech-radar-contributors](https://github.com/medic/cht-tech-radar-contributors).

## ✨ Version 4.0.0

Version 4.0.0 is a complete rewrite of the AOE Technology Radar. It is now based
on [Next.js](https://nextjs.org/) to provide enhanced static site generation. The visualization has
been rewritten without the need for the D3 dependency. New features include a fuzzy search based on
Fuse.js, non-overlapping blips on the radar, and a reworked tag filter on the homepage.

To migrate from the old version please migrate your `package.json`'s scripts and create a
new `config.json` based on the documentation below. You can find a reference implementation in
our [repo](https://github.com/AOEpeople/techradar). The old version is still available in the `v3`
branch.

Version 4.0.0 also removes the .html extension from the URLs. If you want to support the old URLs,
we recommend to add a redirect rule. For nginx, you can use the following rule:

```nginx
rewrite ^/techradar/(.+)\.html$ /techradar/$1/ permanent;
```

## Create your own radar

The generator is free to use under Open Source License - in fact there are already some other Radars
published based on our Radar and there are also Contributions back. However, it would be nice to
mention in radar that the generator is based on this repository.
## TODO Create your own radar

### Step 1: Create a new project

Expand All @@ -41,15 +17,15 @@ file like the following and adapt to your needs:

```json
{
"name": "aoe-techradar",
"name": "cht-techradar",
"version": "1.0.0",
"license": "MIT",
"scripts": {
"build": "techradar build",
"serve": "techradar serve"
},
"dependencies": {
"aoe_technology_radar": "^4"
"cht_technology_radar": "^2"
}
}
```
Expand All @@ -73,7 +49,7 @@ Open the `config.json` file and configure the radar to your needs.
| Attribute | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------ |
| basePath | Set if hosting under a sub-path, otherwise set it to `/`. Default is `/techradar` |
| baseUrl | Set to the full URL, where the radar will be hosted. Will be used for sitemap.xml. `https://www.aoe.com/techradar` |
| baseUrl | Set to the full URL, where the radar will be hosted. Will be used for sitemap.xml. `https://docs.communityhealthtoolkit.org/cht-tech-radar-contributors` |
| logoFile | (optional) Filepath in public folder. Default is `logo.svg` |
| toggles | (optional) Modify the behaviour and contents of the radar. See config below. |
| sections | (optional) Modify the order of sections (`radar`, `tags`, `list`) |
Expand Down Expand Up @@ -261,3 +237,7 @@ radar's markdown-files, config.json and about.md in the `data` folder. Run `npm
parse the markdown files and create a `data.json` and then run `npm run dev` to start the
development server, which will be available at `https://localhost:3000/techradar` or the path
you specified via `basePath`.

## Note
The CHT Technology Radars are built starting from the [AOE Tech Radar content](https://www.aoe.com/techradar/index.html).
If you want to build your own Technical Radar you may want to have a look at [AOE Tech Radar GitHub repository](https://github.com/AOEpeople/aoe_technology_radar).
2 changes: 1 addition & 1 deletion bin/techradar.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const crypto = require("crypto");

const CWD = process.cwd();
const BUILDER_DIR = path.join(CWD, ".techradar");
const SOURCE_DIR = path.join(CWD, "node_modules", "aoe_technology_radar");
const SOURCE_DIR = path.join(CWD, "node_modules", "cht_technology_radar");
const HASH_FILE = path.join(BUILDER_DIR, "hash");

const PARAMETER = process.argv[2]; // "build" or "serve"
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "aoe_technology_radar",
"version": "4.3.1",
"name": "cht_technology_radar",
"version": "2.0.0",
"description": "CHT Technology Radar Core",
"bin": {
"techradar": "./bin/techradar.js"
},
Expand Down
Binary file modified public/favicon.ico
Binary file not shown.
11 changes: 11 additions & 0 deletions public/fonts.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
@font-face {
font-family: "DIN";
src: url("fonts/NotoSans-Regular.ttf");
font-weight: normal;
}

@font-face {
font-family: "DIN";
src: url("fonts/NotoSans-Thin.ttf");
font-weight: 300;
}
Binary file added public/fonts/NotoSans-Regular.ttf
Binary file not shown.
Binary file added public/fonts/NotoSans-Thin.ttf
Binary file not shown.
Loading

0 comments on commit 11986dd

Please sign in to comment.