🔨 incorporate feedback from Este - simplify metadata and readme

owid · Aug 12, 2024 · 4549ceb · 4549ceb
1 parent 5a4d18f
commit 4549ceb
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 26 deletions.
diff --git a/functions/_common/grapherRenderer.ts b/functions/_common/grapherRenderer.ts
@@ -360,14 +360,22 @@ export async function fetchMetadataForGrapher(
             undefined
         )
 
+        const titleShort = col.titlePublicOrDisplayName.title
+        const attributionShort = col.titlePublicOrDisplayName.attributionShort
+        const titleVariant = col.titlePublicOrDisplayName.titleVariant
+        const attributionString =
+            attributionShort && titleVariant
+                ? `${attributionShort} – ${titleVariant}`
+                : attributionShort || titleVariant
+        const titleModifier = attributionString ? ` - ${attributionString}` : ""
+        const titleLong = `${col.titlePublicOrDisplayName.title}${titleModifier}`
+
         return [
             useShortNames ? shortName : col.name,
             {
-                title: col.titlePublicOrDisplayName.title,
-                titleProducer: col.titlePublicOrDisplayName.attributionShort,
-                titleVariant: col.titlePublicOrDisplayName.titleVariant,
+                titleShort,
+                titleLong,
                 descriptionShort,
-                descriptionFromProducer,
                 descriptionKey,
                 descriptionProcessing,
                 shortUnit,
@@ -377,14 +385,13 @@ export async function fetchMetadataForGrapher(
                 type,
                 conversionFactor: col.display?.conversionFactor,
                 owidVariableId,
-                catalogPath,
-                sources: consensedOrigins,
                 shortName,
                 additionalInfo,
                 lastUpdated,
                 nextUpdate,
                 citationShort,
                 citationLong,
+                fullMetadata: `https://api.ourworldindata.org/v1/indicators/${owidVariableId}.metadata.json`,
             },
         ]
     })

diff --git a/functions/_common/readmeTools.ts b/functions/_common/readmeTools.ts
@@ -153,24 +153,6 @@ export function* getSources(
         if (source.retrievedFrom)
             yield `Retrieved from: ${source.retrievedFrom.trim()}` +
                 markdownNewlineEnding
-        if (source.description) {
-            yield ""
-            yield "##### Description of the dataset"
-            yield* yieldMultilineTextAsLines(source.description).map(
-                (l) => `> ${l}`
-            )
-            yield ""
-        }
-        if (source.citation) {
-            yield ""
-            yield "##### Citation"
-            yield "This is the citation of the original data obtained from the source, prior to any processing or adaptation by Our World in Data. We would usually prefer to use the Our World In Data citation format given at the bottom." +
-                markdownNewlineEnding
-            yield* yieldMultilineTextAsLines(source.citation).map(
-                (l) => `> ${l}`
-            )
-            yield ""
-        }
     }
 }
 
@@ -234,15 +216,16 @@ function* columnReadmeText(col: CoreColumn) {
     const attribution = getAttribution(def)
 
     const source = getSource(attribution, def)
+
+    yield* getCitationLines(def, col)
+
     yield `Source: ${source}`
 
     yield* getDescriptionLines(def, attribution)
 
     yield* getSources(def)
 
     yield* getDataProcessingLines(def)
-
-    yield* getCitationLines(def, col)
     yield ""
 }