Add strippable comment tags around frontmatter (#106)

illicitonion · web-flow · commit b4ae9be88bfb · 2023-01-09T22:57:16.000Z
This will allow frontmatter to exist for hugo but not be displayed on GitHub
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="Contributing"
 +++
+forhugo-->
 
 # Contributing to Code Your Future Immersive Go Course
 
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="Immersive Engineering Programme"
 +++
+forhugo-->
 
 ![](./readme-assets/giphy.gif)
 
diff --git a/prep/README.md b/prep/README.md
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="Preparation"
 +++
+forhugo-->
 
 ## Prerequisite learning
 
diff --git a/primers/_index.md b/primers/_index.md
@@ -1,7 +1,9 @@
+<!--forhugo
 +++
 title="Primers"
 date="28 Dec 2022 12:22:11 BST"
 +++
+forhugo-->
 
 ## Reading, Building, and Working
 
diff --git a/primers/distributed-software-systems-architecture/_index.md b/primers/distributed-software-systems-architecture/_index.md
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="Distributed Software Systems Architecture"
 +++
+forhugo-->
 
 ## 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,6 +1,8 @@
+<!--forhugo
 +++
 title="4. Asynchronous Work and Pipelines" 
 +++
+forhugo-->
 
 # 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,6 +1,8 @@
+<!--forhugo
 +++
 title="5. Distributed Locking and Distributed Consensus"
 +++
+forhugo-->
 
 # 5
 
diff --git a/primers/distributed-software-systems-architecture/reliable-rpcs.md b/primers/distributed-software-systems-architecture/reliable-rpcs.md
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="1. Reliable RPCs"   
 +++
+forhugo-->
 
 # 1
 
diff --git a/primers/distributed-software-systems-architecture/scaling-stateless-services.md b/primers/distributed-software-systems-architecture/scaling-stateless-services.md
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="3. Scaling Stateless Services"
 +++
+forhugo-->
 
 # 3
 
diff --git a/primers/distributed-software-systems-architecture/state.md b/primers/distributed-software-systems-architecture/state.md
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="2. State"   
 +++
+forhugo-->
 
 # 2
 
diff --git a/primers/troubleshooting/_index.md b/primers/troubleshooting/_index.md
@@ -1,8 +1,10 @@
+<!--forhugo
 +++
 title="Troubleshooting Primer"
 author="Laura Nolan and Radha Kumari"
 date="28 Dec 2022 12:22:11 BST"    
 +++
+forhugo-->
 
 # Troubleshooting Primer
 
diff --git a/primers/troubleshooting/primer.md b/primers/troubleshooting/primer.md
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="Troubleshooting Primer"   
 +++
+forhugo-->
 
 # Troubleshooting Primer
 
diff --git a/projects/README.md b/projects/README.md
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="Projects"
 +++
+forhugo-->
 
 ## Requirements
 
diff --git a/projects/batch-processing/README.md b/projects/batch-processing/README.md
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="Batch Processing"
 +++
+forhugo-->
 
 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,8 @@
+<!--forhugo
 +++
 title="Buggy App"
 +++
+forhugo-->
 
 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,8 @@
+<!--forhugo
 +++
 title="CLI & Files"
 +++
+forhugo-->
 
 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,8 @@
+<!--forhugo
 +++
 title="Docker & Cloud Deployment"
 +++
+forhugo-->
 
 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,8 @@
+<!--forhugo
 +++
 title="GRPC Client and Server Communication"
 +++
+forhugo-->
 
 Timebox: 3 days
 
diff --git a/projects/http-auth/README.md b/projects/http-auth/README.md
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="Servers & HTTP requests"
 +++
+forhugo-->
 
 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,8 @@
+<!--forhugo
 +++
 title="Distributed Cron Based on Kafka"
 +++
+forhugo-->
 
 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,8 @@
+<!--forhugo
 +++
 title="Memcached Clusters: Replicated and Sharded"
 +++
+forhugo-->
 
 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,8 @@
+<!--forhugo
 +++
 title="Multiple servers"
 +++
+forhugo-->
 
 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
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="RAFT implementation"
 +++
+forhugo-->
 
 # RAFT implementation with Distributed Tracing
 
diff --git a/projects/server-database/README.md b/projects/server-database/README.md
@@ -1,6 +1,8 @@
+<!--forhugo
 +++
 title="Server and database"
 +++
+forhugo-->
 
 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/archetypes/default.md b/website/archetypes/default.md
@@ -1,3 +1,4 @@
+<!--forhugo
 +++
 title= "{{ replace .Name "-" " " | title }}"
 summary= {{.GitInfo.Subject}}
@@ -6,3 +7,4 @@ date= {{ .Date }}
 publishDate= {{ .Date }}
 lastmod= {{ .GitInfo.AuthorDate}}
 +++
+forhugo-->
diff --git a/website/build.sh b/website/build.sh
@@ -1,20 +1,35 @@
 #!/bin/bash -eu
 
-if "$(command -v hugo)" >/dev/null 2>/dev/null; then
-  hugo=hugo
-else
-  td="$(mktemp -d)"
-  case "$(uname)" in
-    Darwin)
+case "$(uname)" in
+  Darwin)
+    sed_i=("sed" "-i" "")
+    ;;
+  Linux)
+    sed_i=("sed" "-i")
+    ;;
+  *)
+    echo >&2 "Unrecognised uname: $(uname) - script assumes Linux or Darwin"
+    exit 1
+    ;;
+esac
+
+td="$(mktemp -d)"
+case "$(uname)" in
+  Darwin)
+    if command -v hugo >/dev/null 2>/dev/null; then
+      hugo=hugo
+    else
       curl -L https://github.com/gohugoio/hugo/releases/download/v0.109.0/hugo_extended_0.109.0_darwin-universal.tar.gz | tar xzf - -C "${td}" hugo
-      ;;
-    Linux)
-      curl -L https://github.com/gohugoio/hugo/releases/download/v0.109.0/hugo_extended_0.109.0_Linux-64bit.tar.gz | tar xzf - -C "${td}" hugo
-      ;;
-  esac
-  chmod 0755 "${td}/hugo"
-  hugo="${td}/hugo"
-fi
+      chmod 0755 "${td}/hugo"
+      hugo="${td}/hugo"
+    fi
+    ;;
+  Linux)
+    curl -L https://github.com/gohugoio/hugo/releases/download/v0.109.0/hugo_extended_0.109.0_Linux-64bit.tar.gz | tar xzf - -C "${td}" hugo
+    chmod 0755 "${td}/hugo"
+    hugo="${td}/hugo"
+    ;;
+esac
 
 cp -r prep primers projects website/content/
 
@@ -28,5 +43,7 @@ for file in $(find website/content/projects -name README.md); do
   mv "${file}" "${file%README.md}index.md"
 done
 
+find website/content -name '*.md' -print0 | xargs -0 "${sed_i[@]}" -e '/^<!--forhugo$/d' -e '/^forhugo-->$/d'
+
 cd website
 "${hugo}"
