Add doc reference to catalog format adr

Signed-off-by: Marcus Eide <eide@spotify.com>
2023-05-05 14:12:43 +02:00
parent 6816352500
commit a52fd3452b
1 changed files with 4 additions and 0 deletions
@@ -101,6 +101,10 @@ const packageSchema = z.object({
 /**
 * Makes sure that a name retrieved from a package.json file
 * is reasonable and conforms to the catalog naming format.
+ *
+ * Read more about the naming format here:
+ *  ADR002: Default Software Catalog File Format
+ *  https://backstage.io/docs/architecture-decisions/adrs-adr002/
 */
 function sanitizeName(name?: string) {
  return name && name !== 'root'