From bd0b244ce88df92281a8d744bc73f7524cc0e369 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Tue, 10 Jun 2025 08:39:15 +0100 Subject: [PATCH 1/3] Add a Makefile for bundle commands. --- docs/Gemfile.lock | 36 ++++++++++++++++++------------------ docs/Makefile | 23 +++++++++++++++++++++++ 2 files changed, 41 insertions(+), 18 deletions(-) create mode 100644 docs/Makefile diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index b84964bd..452089a2 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -13,15 +13,15 @@ GEM http_parser.rb (~> 0) eventmachine (1.2.7) ffi (1.17.2) - ffi (1.17.2-aarch64-linux-gnu) + ffi (1.17.2-aarch64-linux) ffi (1.17.2-aarch64-linux-musl) - ffi (1.17.2-arm-linux-gnu) + ffi (1.17.2-arm-linux) ffi (1.17.2-arm-linux-musl) ffi (1.17.2-arm64-darwin) - ffi (1.17.2-x86-linux-gnu) + ffi (1.17.2-x86-linux) ffi (1.17.2-x86-linux-musl) ffi (1.17.2-x86_64-darwin) - ffi (1.17.2-x86_64-linux-gnu) + ffi (1.17.2-x86_64-linux) ffi (1.17.2-x86_64-linux-musl) forwardable-extended (2.6.0) google-protobuf (4.30.2) @@ -100,33 +100,33 @@ GEM sass-embedded (1.87.0) google-protobuf (~> 4.30) rake (>= 13) - sass-embedded (1.87.0-aarch64-linux-android) + sass-embedded (1.87.0-aarch64-linux) google-protobuf (~> 4.30) - sass-embedded (1.87.0-aarch64-linux-gnu) + sass-embedded (1.87.0-aarch64-linux-android) google-protobuf (~> 4.30) sass-embedded (1.87.0-aarch64-linux-musl) google-protobuf (~> 4.30) sass-embedded (1.87.0-aarch64-mingw-ucrt) google-protobuf (~> 4.30) - sass-embedded (1.87.0-arm-linux-androideabi) + sass-embedded (1.87.0-arm-linux) google-protobuf (~> 4.30) - sass-embedded (1.87.0-arm-linux-gnueabihf) + sass-embedded (1.87.0-arm-linux-androideabi) google-protobuf (~> 4.30) sass-embedded (1.87.0-arm-linux-musleabihf) google-protobuf (~> 4.30) sass-embedded (1.87.0-arm64-darwin) google-protobuf (~> 4.30) - sass-embedded (1.87.0-riscv64-linux-android) + sass-embedded (1.87.0-riscv64-linux) google-protobuf (~> 4.30) - sass-embedded (1.87.0-riscv64-linux-gnu) + sass-embedded (1.87.0-riscv64-linux-android) google-protobuf (~> 4.30) sass-embedded (1.87.0-riscv64-linux-musl) google-protobuf (~> 4.30) sass-embedded (1.87.0-x86_64-darwin) google-protobuf (~> 4.30) - sass-embedded (1.87.0-x86_64-linux-android) + sass-embedded (1.87.0-x86_64-linux) google-protobuf (~> 4.30) - sass-embedded (1.87.0-x86_64-linux-gnu) + sass-embedded (1.87.0-x86_64-linux-android) google-protobuf (~> 4.30) sass-embedded (1.87.0-x86_64-linux-musl) google-protobuf (~> 4.30) @@ -136,32 +136,32 @@ GEM webrick (1.9.1) PLATFORMS + aarch64-linux aarch64-linux aarch64-linux-android - aarch64-linux-gnu aarch64-linux-musl aarch64-mingw-ucrt + arm-linux + arm-linux arm-linux-androideabi - arm-linux-gnu - arm-linux-gnueabihf arm-linux-musl arm-linux-musleabihf arm64-darwin + riscv64-linux riscv64-linux-android - riscv64-linux-gnu riscv64-linux-musl ruby x86-cygwin x86-linux + x86-linux x86-linux-android - x86-linux-gnu x86-linux-musl x86-mingw-ucrt x86_64-cygwin x86_64-darwin x86_64-linux + x86_64-linux x86_64-linux-android - x86_64-linux-gnu x86_64-linux-musl DEPENDENCIES diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..ddccd295 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,23 @@ +SHELL := /bin/bash + +help: ## Show this help + @echo + @grep -E '^[a-zA-Z_0-9-]+:.*?## .*$$' $(MAKEFILE_LIST) \ + | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%s\033[0m|%s\n", $$1, $$2}' \ + | column -t -s '|' + @echo + +serve: install ## Start a local server and serve the site + bundle exec jekyll serve + +build: install ## Build the site + bundle exec jekyll build + +install: check ## Pull all jekyll dependencies + bundle install + +clean: ## Remove build files + rm -rf _site + +check: ## Check ruby (bundle) is installed + @command -v bundle &> /dev/null || { echo >&2 "Please install ruby >= 2.7 to use Jekyll"; exit 1; } From f5d193dd3cbbe2e5776b11bb8eaf465d8e885f71 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Tue, 10 Jun 2025 08:59:41 +0100 Subject: [PATCH 2/3] Add to CONTRIBUTING guidelines. --- CONTRIBUTING.md | 8 +++----- docs/Gemfile.lock | 36 ++++++++++++++++++------------------ 2 files changed, 21 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 90c98b6f..93393475 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,11 +75,9 @@ Pages all live in the `docs/pages` sub-directory, and are written in markdown. To build the webpage locally (for testing) 1. [Install jekyll] -2. Run `bundle install` from the `docs/` directory of this repository to - install dependencies. -3. Run `bundle exec jekyll serve` from the root directory of this repository. - This should fire up a local web server and tell you its address. By default - the server will automatically refresh the HTML pages if any changes are made +2. Run `make serve` from the `docs/` directory of this repository to + install dependencies and start a local web server. + The server will automatically refresh the HTML pages if any changes are made to the markdown sources. See the [jekyll docs] for more info. diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 452089a2..b84964bd 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -13,15 +13,15 @@ GEM http_parser.rb (~> 0) eventmachine (1.2.7) ffi (1.17.2) - ffi (1.17.2-aarch64-linux) + ffi (1.17.2-aarch64-linux-gnu) ffi (1.17.2-aarch64-linux-musl) - ffi (1.17.2-arm-linux) + ffi (1.17.2-arm-linux-gnu) ffi (1.17.2-arm-linux-musl) ffi (1.17.2-arm64-darwin) - ffi (1.17.2-x86-linux) + ffi (1.17.2-x86-linux-gnu) ffi (1.17.2-x86-linux-musl) ffi (1.17.2-x86_64-darwin) - ffi (1.17.2-x86_64-linux) + ffi (1.17.2-x86_64-linux-gnu) ffi (1.17.2-x86_64-linux-musl) forwardable-extended (2.6.0) google-protobuf (4.30.2) @@ -100,34 +100,34 @@ GEM sass-embedded (1.87.0) google-protobuf (~> 4.30) rake (>= 13) - sass-embedded (1.87.0-aarch64-linux) - google-protobuf (~> 4.30) sass-embedded (1.87.0-aarch64-linux-android) google-protobuf (~> 4.30) + sass-embedded (1.87.0-aarch64-linux-gnu) + google-protobuf (~> 4.30) sass-embedded (1.87.0-aarch64-linux-musl) google-protobuf (~> 4.30) sass-embedded (1.87.0-aarch64-mingw-ucrt) google-protobuf (~> 4.30) - sass-embedded (1.87.0-arm-linux) - google-protobuf (~> 4.30) sass-embedded (1.87.0-arm-linux-androideabi) google-protobuf (~> 4.30) + sass-embedded (1.87.0-arm-linux-gnueabihf) + google-protobuf (~> 4.30) sass-embedded (1.87.0-arm-linux-musleabihf) google-protobuf (~> 4.30) sass-embedded (1.87.0-arm64-darwin) google-protobuf (~> 4.30) - sass-embedded (1.87.0-riscv64-linux) - google-protobuf (~> 4.30) sass-embedded (1.87.0-riscv64-linux-android) google-protobuf (~> 4.30) + sass-embedded (1.87.0-riscv64-linux-gnu) + google-protobuf (~> 4.30) sass-embedded (1.87.0-riscv64-linux-musl) google-protobuf (~> 4.30) sass-embedded (1.87.0-x86_64-darwin) google-protobuf (~> 4.30) - sass-embedded (1.87.0-x86_64-linux) - google-protobuf (~> 4.30) sass-embedded (1.87.0-x86_64-linux-android) google-protobuf (~> 4.30) + sass-embedded (1.87.0-x86_64-linux-gnu) + google-protobuf (~> 4.30) sass-embedded (1.87.0-x86_64-linux-musl) google-protobuf (~> 4.30) terminal-table (3.0.2) @@ -136,32 +136,32 @@ GEM webrick (1.9.1) PLATFORMS - aarch64-linux aarch64-linux aarch64-linux-android + aarch64-linux-gnu aarch64-linux-musl aarch64-mingw-ucrt - arm-linux - arm-linux arm-linux-androideabi + arm-linux-gnu + arm-linux-gnueabihf arm-linux-musl arm-linux-musleabihf arm64-darwin - riscv64-linux riscv64-linux-android + riscv64-linux-gnu riscv64-linux-musl ruby x86-cygwin x86-linux - x86-linux x86-linux-android + x86-linux-gnu x86-linux-musl x86-mingw-ucrt x86_64-cygwin x86_64-darwin x86_64-linux - x86_64-linux x86_64-linux-android + x86_64-linux-gnu x86_64-linux-musl DEPENDENCIES From 5acaa4589448bfc51ae6787cccf09dafeb6486cc Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Tue, 10 Jun 2025 09:06:44 +0100 Subject: [PATCH 3/3] Add .phony. --- docs/Makefile | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Makefile b/docs/Makefile index ddccd295..930f9095 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,4 +1,5 @@ SHELL := /bin/bash +.PHONY: help serve build install clean check help: ## Show this help @echo