From 6a8c1d892fbd433ca1695eb865b1173e5754335b Mon Sep 17 00:00:00 2001 From: mrbobbytables Date: Mon, 28 Sep 2026 13:29:10 -0500 Subject: [PATCH] docs: document validate:projects-born CONTRIBUTING.md's data contribution model claimed twice that data/projects-born.json has no validation script. PR #753 added scripts/validate-projects-born.mjs and wired npm run validate:projects-born into CI, but no doc mentioned it. Updated the table row and the rules bullet to reference the validator. Fixes #776 Signed-off-by: mrbobbytables --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e17ccd6f..c34383e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,7 +65,7 @@ hand-building pages: | `/community/members` | `data/members.json` (generated from `data/awards.json` + `data/architectures/catalog.json`) | `npm run generate:members` | | Community people lightboxes | `data/community-roster.json` (curated) → refreshed into `data/community-people.json` | `npm run validate:community-people` | | `docs/community/` user groups | `data/community-groups.json` (generated) | `npm run validate:community-groups` | -| ProjectsBorn (`/practitioners`) | `data/projects-born.json` | manual edit, no validation script | +| ProjectsBorn (`/practitioners`) | `data/projects-born.json` | `npm run validate:projects-born` | | `/resources/case-studies` | `data/case-studies.json` (generated by `npm run collect:case-studies`) | `npm run validate:case-studies` | | `/resources/radar-reports` | `data/radar-reports.json` (generated by `npm run collect:radar-reports`) | `npm run validate:radar-reports` | @@ -99,8 +99,9 @@ Rules: location, image, and social links from [cncf/people](https://github.com/cncf/people)'s `people.json`, matched by GitHub handle; roster name, company, and role stay authoritative. -- `data/projects-born.json` has no generator; edit it directly and verify the - origin story against a reliable source before adding an entry. +- `data/projects-born.json` has no generator; edit it directly, verify the + origin story against a reliable source, and validate with + `npm run validate:projects-born` before adding an entry. - **Never edit `data/community-groups.json` by hand.** Add or rename a group in the `GROUPS` list in `scripts/check-community-group-links.mjs`, then refresh with `npm run check:community-group-links` (needs `GH_TOKEN`), which records