Snagging after restructure in #101 (#103)

SallyMcGrath · illicitonion · web-flow · commit 360c7617fa3b · 2023-01-09T16:07:43.000Z
* remove author from page header single TODO : will replace this edit link with one direct to file when projects are in final position * space card view now there are no authors * remove frontmatter config * create lastmod from gh api We don't want to set dates in front matter * take authors off cards and also fm set images We don't want them anyway * rm all front matter except title we might want to hide the title fm as well with comments later * pull project order from remote leave primers to be ordered as they are for now * change authors line for edit line in page header and footer on single remove unused styles add missing class on footer update class names to edit from author * rename projects index to _index The top level file in this folder needs to be_index to signal this as a section https://gohugo.io/content-management/organization/#index-pages-_indexmd * cache static page regions * suppress page footer on about and versions * create a netlify redirects file for contributing contributing page is a one off that we move to the about section on the website. Internal readme links will break then so I've added a redirect file to netlify https://harrycresswell.com/writing/hugo-netlify-redirects/ * add 301 to redirect * Update website/build.sh Daniel's much better bashing Co-authored-by: Daniel Wagner-Hall <dawagner@gmail.com> * Update website/static/_redirects Co-authored-by: Daniel Wagner-Hall <dawagner@gmail.com> * remove api call to github for projects order - copy it to hugo - query hugo data - pop a readme to explain in data folder * rm readme and replace with example metadata Hugo dislikes my readme * create fallback lastmod 1970 it's set to 1970 so it's obvious it's a default value * rm readme again ... Co-authored-by: Daniel Wagner-Hall <dawagner@gmail.com>
diff --git a/prep/README.md b/prep/README.md
@@ -1,7 +1,5 @@
 +++
 title="Preparation"
-author="Daniel Wagner Hall"
-weight="1"
 +++
 
 ## Prerequisite learning
diff --git a/primers/distributed-software-systems-architecture/_index.md b/primers/distributed-software-systems-architecture/_index.md
@@ -1,7 +1,5 @@
 +++
 title="Distributed Software Systems Architecture"
-author="Laura Nolan"
-date="28 Dec 2022 12:22:11 BST"    
 +++
 
 ## About this primer {#about-this-document}
diff --git a/primers/distributed-software-systems-architecture/asynchronous-work-and-pipelines.md b/primers/distributed-software-systems-architecture/asynchronous-work-and-pipelines.md
@@ -1,7 +1,5 @@
 +++
-title="4. Asynchronous Work and Pipelines"
-author="Laura Nolan"
-date="28 Dec 2022 12:22:11 BST"    
+title="4. Asynchronous Work and Pipelines" 
 +++
 
 # 4
diff --git a/primers/distributed-software-systems-architecture/distributed-locking-and-distributed-consensus.md b/primers/distributed-software-systems-architecture/distributed-locking-and-distributed-consensus.md
@@ -1,7 +1,5 @@
 +++
 title="5. Distributed Locking and Distributed Consensus"
-author="Laura Nolan"
-date="28 Dec 2022 12:22:11 BST" 
 +++
 
 # 5
diff --git a/primers/distributed-software-systems-architecture/reliable-rpcs.md b/primers/distributed-software-systems-architecture/reliable-rpcs.md
@@ -1,7 +1,5 @@
 +++
-title="1. Reliable RPCs"
-author="Laura Nolan"
-date="28 Dec 2022 12:22:11 BST"    
+title="1. Reliable RPCs"   
 +++
 
 # 1
diff --git a/primers/distributed-software-systems-architecture/scaling-stateless-services.md b/primers/distributed-software-systems-architecture/scaling-stateless-services.md
@@ -1,7 +1,5 @@
 +++
 title="3. Scaling Stateless Services"
-author="Laura Nolan"
-date="28 Dec 2022 12:22:11 BST"    
 +++
 
 # 3
diff --git a/primers/distributed-software-systems-architecture/state.md b/primers/distributed-software-systems-architecture/state.md
@@ -1,7 +1,5 @@
 +++
-title="2. State"
-author="Laura Nolan"
-date="28 Dec 2022 12:22:11 BST"    
+title="2. State"   
 +++
 
 # 2
diff --git a/primers/troubleshooting/primer.md b/primers/troubleshooting/primer.md
@@ -1,7 +1,5 @@
 +++
-title="Troubleshooting Primer"
-author="Laura Nolan and Radha Kumari"
-date="28 Dec 2022 12:22:11 BST"    
+title="Troubleshooting Primer"   
 +++
 
 # Troubleshooting Primer
diff --git a/projects/batch-processing/README.md b/projects/batch-processing/README.md
@@ -1,6 +1,5 @@
 +++
 title="Batch Processing"
-author="Tom Ashworth"
 +++
 
 In this project, you'll build a simple image processing pipeline: reading a list of image URLs from a CSV file, downloading each image, processing it, and uploading it to cloud storage.
diff --git a/projects/buggy-app/README.md b/projects/buggy-app/README.md
@@ -1,6 +1,5 @@
 +++
 title="Buggy App"
-author="Tom Ashworth"
 +++
 
 In this project, you're going to run, debug, and fix a buggy application. This code here is a "notes" application with users and notes. It simulates a real-world application that has grown and developed over time: the code isn't perfect, there are tests missing and it contains bugs. The task is to find and fix these bugs. There are _at least_ 5 distinct and important bugs for you to find a fix.
diff --git a/projects/cli-files/README.md b/projects/cli-files/README.md
@@ -1,6 +1,5 @@
 +++
 title="CLI & Files"
-author="Tom Ashworth"
 +++
 
 In this project you're going to get familiar with the [Go programming language][go] by rebuilding two very common tools that programmers and computer administrators use all the time: [cat][cat] and [ls][ls].
diff --git a/projects/docker-cloud/README.md b/projects/docker-cloud/README.md
@@ -1,6 +1,5 @@
 +++
 title="Docker & Cloud Deployment"
-author="Tom Ashworth"
 +++
 
 In this project, you'll build a simple Go server application and Dockerise it to run within a container. You'll write tests that run against the container, and then build GitHub actions to automate continuous testing and release of the application. You'll then run it in the cloud by pushing the container image to Amazon AWS Elastic Container Repository, and then launch it in Amazon AWS Elastic Container Service using the user interface.
diff --git a/projects/grpc-client-server/README.md b/projects/grpc-client-server/README.md
@@ -1,6 +1,5 @@
 +++
 title="GRPC Client and Server Communication"
-author="Laura Nolan"
 +++
 
 Timebox: 3 days
diff --git a/projects/http-auth/README.md b/projects/http-auth/README.md
@@ -1,6 +1,5 @@
 +++
 title="Servers & HTTP requests"
-author="Tom Ashworth"
 +++
 
 In this project we are going to learn about long-lived processes, some networking and the fundamentals of HTTP.
diff --git a/projects/kafka-cron/README.md b/projects/kafka-cron/README.md
@@ -1,6 +1,5 @@
 +++
 title="Distributed Cron Based on Kafka"
-author="Laura Nolan"
 +++
 
 In this project we're going to build a simple distributed `cron` system, based on the Apache Kafka distributed queue system.
diff --git a/projects/memcached-clusters/README.md b/projects/memcached-clusters/README.md
@@ -1,6 +1,5 @@
 +++
 title="Memcached Clusters: Replicated and Sharded"
-author="Laura Nolan"
 +++
 
 This project should be done after reading Section 2 of the [Distributed Systems Primer](https://docs.google.com/document/d/1WoOTLTdtDqnL3fv3YVfI32kfySHqh7y1UfLizBJ3LXY/edit?usp=sharing).
diff --git a/projects/multiple-servers/README.md b/projects/multiple-servers/README.md
@@ -1,6 +1,5 @@
 +++
 title="Multiple servers"
-author="Tom Ashworth"
 +++
 
 Create file server to serve static HTML files. Create an API server that serves JSON from a database. Run the API and file server as two separate servers. Try to load the website & see CORS issue. Put nginx in front of the file server and the API so they are on a single port and hostname. Learn about how to run services in VMs in the cloud. Replicate this local setup in the cloud on a single VM, with all services running on the same host. Route requests to the service.
diff --git a/projects/raft-otel/README.md b/projects/raft-otel/README.md
diff --git a/projects/server-database/README.md b/projects/server-database/README.md
@@ -1,6 +1,5 @@
 +++
 title="Server and database"
-author="Tom Ashworth"
 +++
 
 In this project, we will build another server. This one will have a simple API that serves data in JSON form. We will them convert the backend to read from a Postgres database, serving data for the API. We will then turn off the database and learn how to handle errors correctly.
diff --git a/website/assets/styles/04-components/card.scss b/website/assets/styles/04-components/card.scss
@@ -6,7 +6,7 @@
     "image image image" 100px
     ".     .      ." var(--theme-spacing--1)
     ".     title  ." auto
-    ".     byline ." min-content / var(--theme-spacing--1) 1fr var(--theme-spacing--1);
+    ".     .      ." var(--theme-spacing--1) / var(--theme-spacing--1) 1fr var(--theme-spacing--1);
 
   background-color: var(--theme-color--paper);
   box-shadow: 2px 3px 0 var(--theme-color--pop),
diff --git a/website/assets/styles/04-components/page-footer.scss b/website/assets/styles/04-components/page-footer.scss
@@ -1,21 +1,15 @@
 .c-page-footer {
   border-top: var(--theme-border--thick);
   border-image: var(--theme-border-image);
-
-  &__author,
-  &__author-link {
-    font: 100 var(--theme-type-size--3) var(--theme-font--display);
-    margin-bottom: var(--theme-spacing--6);
-    text-decoration: none;
-    text-transform: none;
-    text-align: center;
-    color: var(--theme-color--ink);
+  @include grid-assign(backwards, edit, forwards);
+  &__section,
+  &__section-link {
+    margin: 0 auto var(--theme-spacing--6) auto;
   }
 
   &__section-nav {
     display: grid;
-    width: 100%;
-    grid-template-columns: repeat(3, 1fr);
+    grid-template: "backwards edit forwards" auto / 1fr 1fr 1fr;
   }
 
   &__forwards {
diff --git a/website/assets/styles/04-components/page-header.scss b/website/assets/styles/04-components/page-header.scss
@@ -18,7 +18,7 @@
     breadcrumbs,
     lastmod,
     toc,
-    author
+    edit
   );
   @include grid-breakout();
   grid-template:
@@ -34,7 +34,7 @@
     display: grid;
     grid-template:
       ".           .   .        " var(--gap)
-      "breadcrumbs .   author   " min-content
+      "breadcrumbs .   edit     " min-content
       "title       .   .        " min-content
       "toc         toc toc      " auto
       ".           .   lastmod  " min-content / 1fr var(--gap) minmax(0, 1fr);
@@ -45,14 +45,14 @@
     text-shadow: -2px 1px 0 var(--theme-color--pop);
   }
   &__lastmod,
-  &__author {
+  &__edit {
     background: var(--theme-color--accent);
     color: var(--theme-color--contrast-max);
     font-size: var(--theme-type-size--6);
     padding: calc(var(--theme-spacing--1) / 2);
     text-align: right;
   }
-  &__author {
+  &__edit {
     background: var(--theme-color--ink-fade);
     color: var(--theme-color--ink);
     clip-path: var(--arrow);
diff --git a/website/build.sh b/website/build.sh
@@ -18,9 +18,12 @@ fi
 
 cp -r prep primers projects website/content/
 
-mkdir -p website/content/about
 cp CONTRIBUTING.md website/content/about/contributing.md
 
+cp projects/metadata.json website/data/projects/metadata.json
+
+mv website/content/projects/README.md website/content/projects/_index.md
+
 for file in $(find website/content/projects -name README.md); do
   mv "${file}" "${file%README.md}index.md"
 done
diff --git a/website/config.toml b/website/config.toml
@@ -2,18 +2,12 @@ baseURL = "/"
 languageCode = "en-us"
 title = "CYF+"
 languageLang = "en"
-sectionPagesMenu = "main"
-enableGitInfo = true
 
 [params]
 description = "A free and open source immersive engineering programme. Practical, hands on projects in Go, distributed systems engineering, site reliability engineering, software engineering. Pace, scale, and complexity."
 repo = "https://github.com/CodeYourFuture/immersive-go-course/"
 tree = "https://github.com/CodeYourFuture/immersive-go-course/tree/main/"
 edit = "https://github.com/CodeYourFuture/immersive-go-course/edit/main/"
-hero = "/static/depths/dddepth-085.webp"
-
-[frontmatter]
-lastmod = [":git", "date", "publishDate"]
 
 [markup]
 [markup.tableOfContents]
diff --git a/website/content/versions/_index.md b/website/content/versions/_index.md
@@ -1,6 +1,5 @@
 +++
-title="Versions"
-date="28 Dec 2022 12:22:11 BST"    
+title="Versions"   
 +++
 
 ## CYF+ Iterations Log
diff --git a/website/data/projects/metadata.json b/website/data/projects/metadata.json
@@ -0,0 +1,15 @@
+{
+  "order": [
+    "cli-files",
+    "http-auth",
+    "server-database",
+    "multiple-servers",
+    "docker-cloud",
+    "grpc-client-server",
+    "batch-processing",
+    "buggy-app",
+    "memcached-clusters",
+    "kafka-cron",
+    "raft-otel"
+  ]
+}
diff --git a/website/layouts/_default/baseof.html b/website/layouts/_default/baseof.html
@@ -2,11 +2,11 @@
 <body class="is-light-mode">
   <a class="c-skip-link e-button" id="skip-link" href="#main">Skip to main</a>
   <div class="l-layout">
-    {{ partial "header.html" . }} {{ partial "menu.html" . }}
+    {{ partialCached "header.html" . }} {{ partialCached "menu.html" . }}
     <main id="main" class="l-layout__main l-main" tabindex="0">
       {{ block "main" . }} {{ end }}
     </main>
 
-    {{- partial "foot.html" . -}}
+    {{- partialCached "foot.html" . -}}
   </div>
 </body>
diff --git a/website/layouts/_default/list.html b/website/layouts/_default/list.html
@@ -28,14 +28,23 @@ <h1 class="c-page-header__title e-heading e-heading__1">{{.Title}}</h1>
   </ol>
 </article>
 {{ partial "breadcrumbs.html" . }} {{ end }}
-<!-- end version pages -->
-<!-- other list pages -->
-{{ if not (eq .Section "versions") }} {{ with .Content }}
+<!-- 
+  end version pages 
+-->
+<!-- 
+  other list pages 
+-->
+{{ if not (eq .Section "versions") }}
+<!-- 
+  main content 
+-->
+{{ with .Content }}
 <article class="c-copy">{{.}}</article>
-{{ end }}
-<ul class="c-cells">
-  {{ range .Pages.ByTitle }}
-  <li class="c-cells__cell">{{ partial "card.html" . }}</li>
-  {{ end }}
-</ul>
-{{ end}} {{ end }}
+{{ end}}
+<!-- 
+  page links
+-->
+{{ partial "cells.html" .}}
+
+<!-- end if not Versions -->
+{{ end}} {{end}}
diff --git a/website/layouts/_default/single.html b/website/layouts/_default/single.html
@@ -11,27 +11,17 @@
       >
         {{.Title}}
       </h1>
-      {{ with .Params.author}}
+      {{with .Params.showTitle }}{{ else }} {{ if or (eq .Section "projects")
+      (eq .Section "primers")}} {{$pathAsString := print $.Site.Params.tree
+      .Path }} {{$changeIndexToReadMe := replace $pathAsString "index.md"
+      "README.md"}}
       <a
-        class="c-page-header__author e-heading__5 e-link is-none--lt-container"
-        href="{{$.Site.BaseURL}}about/contributors"
-        >{{.}}</a
+        class="c-page-header__edit e-heading__5 e-link is-none--lt-container"
+        href="{{$changeIndexToReadMe}}"
+        >Edit on Github</a
       >
-      {{ end}} {{with .Params.showTitle }}{{ else }}
-      <h2 class="c-page-header__lastmod">
-        .Lastmod
-        <a href="{{.Site.Params.tree}}{{.File.BaseFileName}}">
-          {{if not .Lastmod.IsZero }} {{ $lm:= .Lastmod.Format "January 2, 2006"
-          }}
-          <time datetime="{{ .Lastmod }}"
-            >{{ .Lastmod.Format "January 2, 2006" }}</time
-          >
-          {{ else }} {{$lm:= now.Format "January 2, 2006" }}
-          <time datetime="{{ now}}">{{ $lm }}</time>
-          {{ end}}
-        </a>
-      </h2>
-      {{ end}} {{ if and (gt .WordCount 400 ) (.TableOfContents) }}
+      {{ end}} {{ partial "lastmod.html" . }} {{ end}} {{ if and (gt .WordCount
+      400 ) (.TableOfContents) }}
       <section class="c-page-header__toc c-toc" id="toc">
         {{ .TableOfContents }}
       </section>
diff --git a/website/layouts/partials/card.html b/website/layouts/partials/card.html
@@ -3,29 +3,10 @@
 
 <a class="c-card" href="{{.Permalink}}">
   <h3 class="c-card__title">{{.Title}}</h3>
-  {{ with .Params.author }}
-  <p class="c-card__byline">{{. }}</p>
-  {{ end}}
-  <!--cut cover images -->
-  {{ $cover := .Resources.GetMatch "hero" }}
-  <!-- make sure the cover image exists first!-->
-  {{ if $cover }}
-  <!-- now resize the resource-->
-  {{ $cover := $cover.Fill "600x200" }}
-
-  <!-- now show it -->
-  <img
-    loading="lazy"
-    class="c-card__image"
-    src="{{ $cover.RelPermalink }}"
-    alt=""
-  />
-  {{ else }}
-
-  <!-- but maybe just random pictures -->
+  <!-- just random pictures -->
   <img loading="lazy" class="c-card__image" src="{{ if eq .Section "projects"
   }}{{ range $fallBackProjects }}{{ $.Site.BaseURL }}pictures/depths/{{ .Name
-  }}{{ end }}{{ else }}{{ range
+  }}{{ end }} {{ else }}{{ range
   $fallBack}}{{$.Site.BaseURL}}pictures/svgs/neons/{{ .Name }}{{ end }}{{ end
-  }}" alt="" /> {{end}}
+  }}" alt="" />
 </a>
diff --git a/website/layouts/partials/cells.html b/website/layouts/partials/cells.html
@@ -0,0 +1,14 @@
+<ul class="c-cells">
+  {{ if (eq .Section "projects") }}
+  <!-- projects are ordered by a manifest on the repo to make it friendly for back end devs -->
+  {{ range .Site.Data.projects.metadata.order }}
+  <li class="c-cells__cell">
+    {{$project := print .}} {{$pageObject := $.Site.GetPage $project}} {{ with
+    $pageObject}} {{ partial "card.html" .}} {{end}}
+  </li>
+  {{ end}}
+  <!-- everything else just goes in Hugo order -->
+  {{ else }} {{ range .Pages }}
+  <li class="c-cells__cell">{{ partial "card.html" .}}</li>
+  {{ end}} {{ end}}
+</ul>
diff --git a/website/layouts/partials/lastmod.html b/website/layouts/partials/lastmod.html
diff --git a/website/layouts/partials/page-footer.html b/website/layouts/partials/page-footer.html
diff --git a/website/static/_redirects b/website/static/_redirects
