From 52d839b4d3e6e1cf5aa05da75516bdb7021217a2 Mon Sep 17 00:00:00 2001 From: Timothée Ravier Date: Feb 08 2022 17:18:50 +0000 Subject: [PATCH 1/3] Update configuration for Antora 3.0 --- diff --git a/antora.yml b/antora.yml index 19e9b09..50930e3 100644 --- a/antora.yml +++ b/antora.yml @@ -9,7 +9,7 @@ title: Pizza Factory # <---- PLEASE MODIFY version: ~ # We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise. -start_page: ROOT:index +start_page: ROOT:index.adoc # This lists all the menu definitions of your component. nav: diff --git a/site.yml b/site.yml index 96b79fd..87c75cd 100644 --- a/site.yml +++ b/site.yml @@ -1,6 +1,6 @@ site: title: Local Preview - start_page: pizza-factory::index + start_page: pizza-factory::index.adoc content: sources: - url: . @@ -16,5 +16,5 @@ output: destinations: - provider: archive runtime: - pull: true + fetch: true cache_dir: ./cache From 298ac19b610cac2971e1a1a1a830b30a3dff4637 Mon Sep 17 00:00:00 2001 From: Timothée Ravier Date: Feb 08 2022 17:19:43 +0000 Subject: [PATCH 2/3] Whitespace and formating cleanup --- diff --git a/antora.yml b/antora.yml index 50930e3..0b0237f 100644 --- a/antora.yml +++ b/antora.yml @@ -1,14 +1,20 @@ # Name will be mostly visible in the URL. Treat it as an identifier. -# Tip: If you want to use the local preview scripts that come with this repository, please change this value in the site.yml file as well. (under site/start_page) +# Tip: If you want to use the local preview scripts that come with this +# repository, please change this value in the site.yml file as well (under +# site/start_page) name: pizza-factory # <---- PLEASE MODIFY -# Title will be visible on the page. +# Title will be visible on the page. title: Pizza Factory # <---- PLEASE MODIFY -# If you don't plan to have multiple versions of the docs (for example, to document multiple versions of some software), you can ignore this field. Otherwise, change "~" to a specific version. +# If you don't plan to have multiple versions of the docs (for example, to +# document multiple versions of some software), you can ignore this field. +# Otherwise, change "~" to a specific version. version: ~ -# We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise. +# We encourage you to name the index page as "index.adoc". If you absolutely +# have to use a different name, please reflect it here. You can ignore this +# field otherwise. start_page: ROOT:index.adoc # This lists all the menu definitions of your component. diff --git a/site.yml b/site.yml index 87c75cd..53baca6 100644 --- a/site.yml +++ b/site.yml @@ -1,4 +1,4 @@ -site: +site: title: Local Preview start_page: pizza-factory::index.adoc content: @@ -10,11 +10,11 @@ ui: url: https://asamalik.fedorapeople.org/ui-bundle.zip snapshot: true default_layout: with_menu -output: - clean: true +output: + clean: true dir: ./public - destinations: - - provider: archive + destinations: + - provider: archive runtime: fetch: true cache_dir: ./cache From 3ae656c7332f5504279daf47850ddb040a0f5371 Mon Sep 17 00:00:00 2001 From: Timothée Ravier Date: Feb 08 2022 17:24:01 +0000 Subject: [PATCH 3/3] build.sh: Properly quote all variables --- diff --git a/build.sh b/build.sh index 0c0f3f0..21c0325 100755 --- a/build.sh +++ b/build.sh @@ -10,7 +10,7 @@ if uname | grep -iwq darwin; then echo "" echo "This build script is using Docker container runtime to run the build in an isolated environment." echo "" - docker run --rm -it -v "$(pwd):/antora" $image $cmd + docker run --rm -it -v "$(pwd):/antora" "${image}" "${cmd}" elif uname | grep -iq linux; then # Running on Linux. @@ -19,14 +19,14 @@ elif uname | grep -iq linux; then # which requires root. if [ -f /usr/local/bin/antora ]; then - /usr/local/bin/antora $cmd + /usr/local/bin/antora "${cmd}" elif uname -m | grep -iwq aarch64; then echo "no antora/aarch64 container try just \`npm install -g @antora/cli @antora/site-generator-default\`" elif [ -f /usr/bin/podman ]; then echo "" echo "This build script is using Podman to run the build in an isolated environment." echo "" - podman run --rm -it -v "$(pwd):/antora:z" $image $cmd + podman run --rm -it -v "$(pwd):/antora:z" "${image}" "${cmd}" elif [ -f /usr/bin/docker ]; then echo "" @@ -34,14 +34,14 @@ elif uname | grep -iq linux; then echo "" if groups | grep -wq "docker"; then - docker run --rm -it -v "$(pwd):/antora:z" $image $cmd + docker run --rm -it -v "$(pwd):/antora:z" "${image}" "${cmd}" else echo "You might be asked for your password." echo "You can avoid this by adding your user to the 'docker' group," echo "but be aware of the security implications." echo "See https://docs.docker.com/install/linux/linux-postinstall/" echo "" - sudo docker run --rm -it -v "$(pwd):/antora:z" $image $cmd + sudo docker run --rm -it -v "$(pwd):/antora:z" "${image}" "${cmd}" fi else echo ""