Merge pull request #16190 from legendik/techradar/deprecate-url

[TechRadar] Deprecate RadarEntry.url

.changeset/hip-chairs-double.md

@@ -0,0 +1,19 @@
+---
+'@backstage/plugin-tech-radar': patch
+---
+
+Deprecate `RadarEntry.url` - use `RadarEntry.links` instead
+
+```diff
+- url: 'https://www.javascript.com/',
+  key: 'javascript',
+  id: 'javascript',
+  title: 'JavaScript',
+  quadrant: 'languages',
+  links: [
++    {
++      url: 'https://www.javascript.com/',
++      title: 'Learn more',
++    },
+  ],
+```

plugins/tech-radar/api-report.md

@@ -25,7 +25,8 @@ export interface RadarEntry {
   quadrant: string;
   timeline: Array<RadarEntrySnapshot>;
   title: string;
-  url: string;
+  // @deprecated
+  url?: string;
 }
 
 // @public

plugins/tech-radar/src/api.ts

@@ -133,8 +133,10 @@ export interface RadarEntry {
    * @remarks
    *
    * You can use `#` if you don't want to provide any other url
+   *
+   * @deprecated Use {@link RadarEntry.links} instead
    */
-  url: string;
+  url?: string;
   /**
    * History of the Entry moving through {@link RadarRing}
    */

plugins/tech-radar/src/sample.ts

@@ -45,12 +45,15 @@ entries.push({
         'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua',
     },
   ],
-  url: 'https://www.javascript.com/',
   key: 'javascript',
   id: 'javascript',
   title: 'JavaScript',
   quadrant: 'languages',
   links: [
+    {
+      url: 'https://www.javascript.com/',
+      title: 'Learn more',
+    },
     {
       url: 'https://www.typescriptlang.org/',
       title: 'TypeScript',
@@ -69,7 +72,6 @@ entries.push({
         'Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat',
     },
   ],
-  url: '#',
   key: 'typescript',
   id: 'typescript',
   title: 'TypeScript',
@@ -87,7 +89,12 @@ entries.push({
         'Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur',
     },
   ],
-  url: 'https://webpack.js.org/',
+  links: [
+    {
+      url: 'https://webpack.js.org/',
+      title: 'Learn more',
+    },
+  ],
   key: 'webpack',
   id: 'webpack',
   title: 'Webpack',
@@ -101,7 +108,12 @@ entries.push({
       date: new Date('2020-08-06'),
     },
   ],
-  url: 'https://reactjs.org/',
+  links: [
+    {
+      url: 'https://reactjs.org/',
+      title: 'Learn more',
+    },
+  ],
   key: 'react',
   id: 'react',
   title: 'React',
@@ -115,7 +127,6 @@ entries.push({
       date: new Date('2020-08-06'),
     },
   ],
-  url: '#',
   key: 'code-reviews',
   id: 'code-reviews',
   title: 'Code Reviews',
@@ -129,7 +140,6 @@ entries.push({
       date: new Date('2020-08-06'),
     },
   ],
-  url: '#',
   key: 'mob-programming',
   id: 'mob-programming',
   title: 'Mob Programming',
@@ -143,7 +153,6 @@ entries.push({
       date: new Date('2020-08-06'),
     },
   ],
-  url: '#',
   key: 'docs-like-code',
   id: 'docs-like-code',
   title: 'Docs-like-code',
@@ -156,7 +165,6 @@ entries.push({
       date: new Date('2020-08-06'),
     },
   ],
-  url: '#',
   key: 'force-push',
   id: 'force-push',
   title: 'Force push to master',
@@ -170,7 +178,12 @@ entries.push({
       description: 'long description',
     },
   ],
-  url: 'https://github.com',
+  links: [
+    {
+      url: 'https://github.com',
+      title: 'Learn more',
+    },
+  ],
   key: 'github-actions',
   id: 'github-actions',
   title: 'GitHub Actions',