✨ add narrative-chart and figma-url to DI frontmatter

owid · Jan 27, 2025 · 439c38d · 439c38d
1 parent 6063099
commit 439c38d
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 2 deletions.
diff --git a/adminSiteClient/GdocsSettingsForms.tsx b/adminSiteClient/GdocsSettingsForms.tsx
@@ -180,7 +180,12 @@ export const GdocInsightSettings = ({
         <form className="GdocsSettingsForm">
             <GdocCommonErrors
                 errors={errors}
-                errorsToFilter={["approved-by", "grapher-url"]}
+                errorsToFilter={[
+                    "approved-by",
+                    "grapher-url",
+                    "narrative-chart",
+                    "figma-url",
+                ]}
             />
             <GdocCommonSettings
                 gdoc={gdoc}
@@ -194,11 +199,21 @@ export const GdocInsightSettings = ({
                     gdoc={gdoc}
                     errors={errors}
                 />
+                <GdocsSettingsContentField
+                    property="narrative-chart"
+                    gdoc={gdoc}
+                    errors={errors}
+                />
                 <GdocsSettingsContentField
                     property="grapher-url"
                     gdoc={gdoc}
                     errors={errors}
                 />
+                <GdocsSettingsContentField
+                    property="figma-url"
+                    gdoc={gdoc}
+                    errors={errors}
+                />
             </div>
         </form>
     )

diff --git a/adminSiteClient/gdocsDeploy.ts b/adminSiteClient/gdocsDeploy.ts
@@ -102,6 +102,8 @@ export const checkIsLightningUpdate = (
     > = {
         ["grapher-url"]: true,
         ["approved-by"]: true,
+        ["narrative-chart"]: true,
+        ["figma-url"]: true,
         title: false, // requires rebaking the feed
         authors: false, // requires rebaking the feed
         body: false, // requires rebaking the feed

diff --git a/adminSiteClient/gdocsValidation.ts b/adminSiteClient/gdocsValidation.ts
@@ -190,7 +190,7 @@ function validateGrapherUrl(
     gdoc: OwidGdocDataInsightInterface,
     errors: OwidGdocErrorMessage[]
 ) {
-    if (!gdoc.content["grapher-url"]) {
+    if (!gdoc.content["narrative-chart"] && !gdoc.content["grapher-url"]) {
         errors.push({
             property: "grapher-url",
             type: OwidGdocErrorMessageType.Warning,
@@ -199,6 +199,32 @@ function validateGrapherUrl(
     }
 }
 
+function validateNarrativeChart(
+    gdoc: OwidGdocDataInsightInterface,
+    errors: OwidGdocErrorMessage[]
+) {
+    if (!gdoc.content["narrative-chart"] && !gdoc.content["grapher-url"]) {
+        errors.push({
+            property: "narrative-chart",
+            type: OwidGdocErrorMessageType.Warning,
+            message: `Missing "narrative-chart". This isn't required, but if you're referencing a narrative chart, it's a good idea to add it so that we can link it to this data insight.`,
+        })
+    }
+}
+
+function validateFigmaUrl(
+    gdoc: OwidGdocDataInsightInterface,
+    errors: OwidGdocErrorMessage[]
+) {
+    if (!gdoc.content["figma-url"]) {
+        errors.push({
+            property: "figma-url",
+            type: OwidGdocErrorMessageType.Warning,
+            message: `Missing "figma-url". This isn't required, but if you edited the chart in Figma, it's a good idea to share the URL so that we can link it to this data insight.`,
+        })
+    }
+}
+
 function validateDataInsightImage(
     gdoc: OwidGdocDataInsightInterface,
     errors: OwidGdocErrorMessage[]
@@ -296,7 +322,9 @@ export const getErrors = (gdoc: OwidGdoc): OwidGdocErrorMessage[] => {
         validateAtomFields(gdoc, errors)
     } else if (checkIsDataInsight(gdoc)) {
         validateApprovedBy(gdoc, errors)
+        validateNarrativeChart(gdoc, errors)
         validateGrapherUrl(gdoc, errors)
+        validateFigmaUrl(gdoc, errors)
         validateDataInsightImage(gdoc, errors)
     } else if (checkIsAuthor(gdoc)) {
         validateSocials(gdoc, errors)

diff --git a/packages/@ourworldindata/types/src/gdocTypes/Gdoc.ts b/packages/@ourworldindata/types/src/gdocTypes/Gdoc.ts
@@ -152,7 +152,9 @@ export function extractGdocIndexItem(
 export interface OwidGdocDataInsightContent {
     title: string
     authors: string[]
+    ["narrative-chart"]?: string
     ["grapher-url"]?: string
+    ["figma-url"]?: string
     ["approved-by"]: string // can't publish an insight unless this is set
     body: OwidEnrichedGdocBlock[]
     type: OwidGdocType.DataInsight