AJR/TechRadarAJR
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add option to customize the logo, favicon and add images.

Browse Source
This commit is contained in:
dennis.ludwig
2021-06-14 13:44:17 +02:00
parent 144d5f621c
commit 897bd5a084
11 changed files with 39 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
README.md
View File

@@ -1,15 +1,12 @@
# AOE Technology Radar
A static site generator for AOE Technology Radar
## Looking for the AOE Tech Radar content?
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
## Usage for 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.
(There is a list of planned features below in case someone wants to contribute :-)
@@ -18,7 +15,6 @@ However, please be aware:
* Also, when you want to reuse the CSS and Styling: Change the font (it is a licensed font) and the colors (It using AOE CI)
## Use and build
Add the tech radar as a dependency
```
yarn add https://github.com/aoepeople/aoe_technology_radar.git
@@ -43,10 +39,9 @@ python3 -m http.server 8080
Then open here: http://localhost:8080
## Run a prepared static version
In most cases you have the tech radar available at `/techradar`, and for reasons want all correct pages to be accessible.
In most cases you have the techradar available at `/techradar`, and for reasons want all correct pages to be accessible.
Until this setup improves, you can use the following way to generate the correct techradar:
Until this setup improves, you can use the following way to generate the correct tech radar:
```
yarn aoe_technology_radar-generateJson
@@ -57,14 +52,32 @@ cp -r build techradar
(This is rather workaroundish for now, but does the job.)
## Usage
## Customize the tech radar
You can customize the following parts of the tech radar.
### Change title, description and headline
Set the environment variable `RADAR_NAME`. The default is "AOE Technology Radar".
### Host the application under a sub path
To host the application under a sub path, set the environment variable `PUBLIC_URL`, e.g. "/techradar".
### Change the favicon
To change the favicon, create a public folder in your application and put your favicon.ico in it.
### Change the logo
To change the logo, create a public folder in your application and put your logo.svg in it.
For reference have a look at [public/logo.svg](./public/logo.svg).
### Change the index.html
To change the index.html, create a public folder in your application and put your index.html in it.
For reference have a look at [public/index.html](./public/index.html).
## 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](https://github.com/jxson/front-matter) header
@@ -97,24 +110,12 @@ 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.
## Open points
You can integrate images in your markdown. Put the image files in your public folder and reference them
```
![nice image](/images/nice-image.png)
```
* dotenv necessary? -> Could be necessary for other companies
* measure file sizes necessary? -> no
* check browsers necessary? -> no
* copy public folder necessary? -> no
* specific webpack configurations necessary? -> no
## TODOs
* add dist folder for precompiled builder
* add default envs to .env file
** add envs to readme
* Check package.json scripts
* Add documentation for build dist_scripts folder
* prettier on all files
* check lint staged and prettier
* Rename package to make more clear that this is a tech radar builder?
* provide only one bin script with subcommands like react-scripts?
* add tests for scripts
* add tests for components
## Development
### Change scripts
If you change one of the scripts in the scripts' folder, you have to compile them to JavaScript.
Therefore, run `yarn build:scripts` and commit the results in dist_scripts.