From a52fd3452b70a262767c2b054f509f4a82823cea Mon Sep 17 00:00:00 2001
From: Marcus Eide <eide@spotify.com>
Date: Fri, 5 May 2023 14:12:43 +0200
Subject: [PATCH] Add doc reference to catalog format adr

Signed-off-by: Marcus Eide <eide@spotify.com>
---
 .../onboard/discovery/analyzers/PackageJsonAnalyzer.ts        | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/packages/cli/src/commands/onboard/discovery/analyzers/PackageJsonAnalyzer.ts b/packages/cli/src/commands/onboard/discovery/analyzers/PackageJsonAnalyzer.ts
index 1f4cb116ad..16dd4b9301 100644
--- a/packages/cli/src/commands/onboard/discovery/analyzers/PackageJsonAnalyzer.ts
+++ b/packages/cli/src/commands/onboard/discovery/analyzers/PackageJsonAnalyzer.ts
@@ -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'