updated readme

kloia · Jan 22, 2024 · d5f849f · d5f849f
1 parent 18b741c
commit d5f849f
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ Feel free to use and adapt it for your own purposes.
 
 ```html
 <script src="https://d3js.org/d3.v4.min.js"></script>
-<script src="http://zalando.github.io/tech-radar/release/radar-0.5.js"></script>
+<script src="./radar.js"></script>
 ```
 
 2. insert an empty `svg` tag:
@@ -54,25 +54,12 @@ radar_visualization({
     { name: "OUTER",  color: "#f4c7c3" }
   ],
   print_layout: true,
-  entries: [
-   {
-      label: "Some Entry",
-      quadrant: 3,          // 0,1,2,3 (counting clockwise, starting from bottom right)
-      ring: 2,              // 0,1,2,3 (starting from inside)
-      moved: -1             // -1 = moved out (triangle pointing down)
-                            //  0 = not moved (circle)
-                            //  1 = moved in  (triangle pointing up)
-   },
+  entries: // entries coming from config.json
     // ...
   ]
 });
 ```
 
-Entries are positioned automatically so that they don't overlap.
-
-As a working example, you can check out `docs/index.html` &mdash; the source of our [public Tech
-Radar](http://zalando.github.io/tech-radar/).
-
 ## Local Development
 
 1. install dependencies with yarn (or npm):
@@ -93,6 +80,16 @@ yarn start
 http://localhost:3000/
 ```
 
+## How did we deploy it?
+
+We use Cloudflare Pages to deploy our Tech Radar. It's an basic static site hosting service that is free with unlimited bandwidth. It automatically builds and deploys the site from the "master" branch of this repository whenever we push a change. There's no need to configure anything.
+
+Entries are positioned automatically so that they don't overlap.
+
+As a working example, you can check out `docs/index.html` &mdash; the source of our [public Tech
+Radar](http://zalando.github.io/tech-radar/).
+
+
 ## License
 
 ```

diff --git a/docs/index.html b/docs/index.html
@@ -13,7 +13,6 @@
 </head>
 
 <body>
-
 <svg id="radar"></svg>
 
 <script>
@@ -84,7 +83,10 @@ <h3>How do we maintain it?</h3>
   The Tech Radar is maintained by the <em>Kloia Technologists Guild</em> &mdash; an open group of senior Kloia technologists committed to devote time to the Tech Radar purpose. The guild self organises to maintain the Tech Radar documents, including this public version. Assignment of technologies to rings is the outcome of ring change proposals, which are discussed and voted on in guild meetings. The Tech Radar depends on active participation and input from all engineering teams at Kloia.
   </p>
 
-  </td></tr>
+  Check out our <a href="https://kloia.com/blog"> Engineering Blog </a> for more information on how we approach technology selection.
+
+  Note: This page's also open-source and available on <a href="https://github.com/kloia/techradar">Github</a>.
+</td></tr>
   </table>
 </body>
 </html>
diff --git a/docs/radar.css b/docs/radar.css
@@ -6,11 +6,13 @@ body {
   color: #002A61 !important;
   text-align: center;
 }
+
 h3 {
   margin-top: 50px;
   font-family: 'Exo', sans-serif;
   font-size: clamp(12px, calc(1.5vw), 20px);;
 }
+
 li {
   margin: 25px 50px 0 0;
 }