From d6a54a51126392d0318b495e3a420d93d9b8e7a0 Mon Sep 17 00:00:00 2001
From: Giles Dring <giles@dringtech.com>
Date: Fri, 21 Jun 2024 14:09:03 +0100
Subject: [PATCH] Updates to descriptions for catalogue items

---
 src/_data.yml                      |  3 +++
 src/_includes/layout/catalogue.vto |  2 +-
 src/index.vto                      |  5 ++++-
 src/references.yml                 |  9 +++++++++
 src/techniques.page.ts             |  8 ++++++--
 src/techniques/duckdb/index.vto    | 12 +++++++++++-
 6 files changed, 34 insertions(+), 5 deletions(-)

diff --git a/src/_data.yml b/src/_data.yml
index 0a9425a..d5232cb 100644
--- a/src/_data.yml
+++ b/src/_data.yml
@@ -17,5 +17,8 @@ techniques:
     title: Core
   - key: data
     title: Data
+    description: |
+      Data is key to the creation of Lume sites.
+      Here are some of the techniques we use when dealing with data.
   - key: references
     title: Links
\ No newline at end of file
diff --git a/src/_includes/layout/catalogue.vto b/src/_includes/layout/catalogue.vto
index 4e0e2b4..82ff327 100644
--- a/src/_includes/layout/catalogue.vto
+++ b/src/_includes/layout/catalogue.vto
@@ -3,7 +3,7 @@ layout: ./page.vto
 ---
 
 {{ if description -}}
-  <p>{{ description }}</p>  
+  {{ description |> md }}
 {{- /if }}
 
 {{ comp.layout.Grid({
diff --git a/src/index.vto b/src/index.vto
index 2c46450..94ade37 100644
--- a/src/index.vto
+++ b/src/index.vto
@@ -2,11 +2,14 @@
 title: Home
 ---
 <p>
-  This site collects some common approaches to building Lume sites in use across Open Innovations.
+  This is a collection of some common techniques that we at
+  <a href="https://open-innovations.org/">Open Innovations</a> use
+  when building websites using the <a href="https://lume.land/">Lume</a>.
 </p>
 
 {{ for technique of search.pages('technique', 'order') }}
   <h2>{{ technique.title }}</h2>
+  {{ if technique.description }}{{ technique.description |> md }}{{ /if }}
   {{ comp.layout.Grid({
     items: technique.catalogue,
     renderer: comp.link.Block
diff --git a/src/references.yml b/src/references.yml
index fbad9a3..0df2131 100644
--- a/src/references.yml
+++ b/src/references.yml
@@ -3,12 +3,21 @@ tags: [ technique ]
 title: Links
 order: 100
 layout: layout/catalogue.vto
+description: |
+  The web is full of documentation!
+  Here are some of the browser tabs we have permanently open.
+  Most of the answers are within...
 catalogue:
   - title: Lume
     url: https://lume.land/
     description: |
       Lume is a static site generator which uses the Deno JavaScript runtime.
       We use this as the core platform for many of the sites we build.
+  - title: Lume Discord
+    url: https://discord.gg/YbTmpACHWB
+    description: |
+      For times that the brilliant Lume documentation doesn't have answers,
+      there's a really active and supportive Discord channel.
   - title: Vento
     url: https://ventojs.org/
     description: |
diff --git a/src/techniques.page.ts b/src/techniques.page.ts
index fbef880..2f82038 100644
--- a/src/techniques.page.ts
+++ b/src/techniques.page.ts
@@ -22,7 +22,7 @@ export default function* ({ search, techniques }: Lume.Data & {
     // Find all pages that have this technique key set
     // Sort by title
     const pages = search.pages(`technique=${key}`, "title").map(
-      ({ title, url }) => ({ title, url }),
+      ({ title, url, description }) => ({ title, url, description }),
     );
 
     // Yield the page data for this page.
@@ -40,7 +40,11 @@ export default function* ({ search, techniques }: Lume.Data & {
 /**
  * Definition of a technique entry
  */
-type Technique = { key: string; title: string };
+type Technique = {
+    key: string;
+    title: string;
+    description: string;
+};
 
 /**
  * All pages created by this generator will use the catalogue layout
diff --git a/src/techniques/duckdb/index.vto b/src/techniques/duckdb/index.vto
index 84e162d..2df0a63 100644
--- a/src/techniques/duckdb/index.vto
+++ b/src/techniques/duckdb/index.vto
@@ -1,9 +1,19 @@
 ---
 title: DuckDB
 technique: data
+description: |
+  We use DuckDB as a way of managing larger datasets when building sites.
+  It also helps us work with other data formats, including Parquet.
 ---
+
+<p>
+  <a href="https://duckdb.org">DuckDB</a> is a fast in-process analytical database.
+  This means it's highly optimised to deal with queries (rather than updates)
+  and can work incredibly fast on very large datasets.
+</p>
+
 <p>
-  As more data is rendered in a site, the build can slow down significantly.
+  As more data is rendered in a Lume site, the build can slow down significantly.
   It may be beneficial under these circumstances to use DuckDB to access data.
   This is particularly true if the data in question is very large or if it is
   used to generate very large numbers of pages.