From e739047b6541f78aa534ba3674a0645d5bfb3a85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Ravier?= Date: Wed, 12 Jan 2022 18:47:05 +0100 Subject: [PATCH 1/5] Update configuration for Antora 3.0 --- antora.yml | 2 +- site.yml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/antora.yml b/antora.yml index b763b15..201dc99 100644 --- a/antora.yml +++ b/antora.yml @@ -9,7 +9,7 @@ title: Quick Docs version: master # 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 7472e1d..ee9bef1 100644 --- a/site.yml +++ b/site.yml @@ -1,6 +1,6 @@ site: title: Local Preview - start_page: quick-docs::index + start_page: quick-docs::index.adoc content: sources: - url: . @@ -16,5 +16,5 @@ output: destinations: - provider: archive runtime: - pull: true + fetch: true cache_dir: ./cache From bab6efcf1432ad402b028e647de280905356f601 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Ravier?= Date: Wed, 12 Jan 2022 18:47:22 +0100 Subject: [PATCH 2/5] build.sh: Update with latest version from template --- build.sh | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/build.sh b/build.sh index 75dd387..21c0325 100755 --- a/build.sh +++ b/build.sh @@ -3,30 +3,30 @@ image="docker.io/antora/antora" cmd="--html-url-extension-style=indexify site.yml" -if [ "$(uname)" == "Darwin" ]; then +if uname | grep -iwq darwin; then # Running on macOS. # Let's assume that the user has the Docker CE installed # which doesn't require a root password. 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 [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then +elif uname | grep -iq linux; then # Running on Linux. # there isn't an antora/aarch64 container, antora can be installed locally # Check whether podman is available, else faill back to docker # which requires root. if [ -f /usr/local/bin/antora ]; then - /usr/local/bin/antora $cmd - elif [[ `uname -m` == "aarch64" ]]; then + /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,18 +34,19 @@ elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then echo "" if groups | grep -wq "docker"; then - docker run --rm -it -v $(pwd):/antora:z $image $cmd - else + 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 "" - echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password." - echo "You can avoid this by adding your user to the 'docker' group, but be aware of the security implications. See https://docs.docker.com/install/linux/linux-postinstall/." - echo "" - sudo docker run --rm -it -v $(pwd):/antora:z $image $cmd - fi + sudo docker run --rm -it -v "$(pwd):/antora:z" "${image}" "${cmd}" + fi else echo "" - echo "Error: Container runtime haven't been found on your system. Fix it by:" - echo "$ sudo dnf install podman" - exit 1 + echo "Error: Container runtime haven't been found on your system. Fix it by:" + echo "$ sudo dnf install podman" + exit 1 fi fi From 009a537f38971af0d490093b69bfa58ab8f4ba5e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Ravier?= Date: Wed, 12 Jan 2022 18:48:03 +0100 Subject: [PATCH 3/5] *.yaml: Minor styling fixes --- antora.yml | 14 ++++++++++---- site.yml | 10 +++++----- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/antora.yml b/antora.yml index 201dc99..c927f1f 100644 --- a/antora.yml +++ b/antora.yml @@ -1,14 +1,20 @@ # Name will be mostly visible in the URL. Treat it as an indentifier. -# 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: quick-docs -# Title will be visible on the page. +# Title will be visible on the page. title: Quick Docs -# 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 "master" 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 "master" to a specific version. version: master -# 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 ee9bef1..78caa14 100644 --- a/site.yml +++ b/site.yml @@ -1,4 +1,4 @@ -site: +site: title: Local Preview start_page: quick-docs::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 40e1d055c409a5abed8e5293e477247af9e15680 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Ravier?= Date: Wed, 12 Jan 2022 18:54:51 +0100 Subject: [PATCH 4/5] anaconda: Remove broken link The page linked here was removed in: 00d3c9c Remove anaconda distros page Fixes: ``` [17:48:30.714] ERROR (asciidoctor): target of xref not found: anaconda/anaconda_distros.adoc file: /antora/modules/ROOT/pages/anaconda/anaconda.adoc source: /antora (refname: master ) ``` --- modules/ROOT/pages/anaconda/anaconda.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/anaconda/anaconda.adoc b/modules/ROOT/pages/anaconda/anaconda.adoc index 16423e8..9a0b293 100644 --- a/modules/ROOT/pages/anaconda/anaconda.adoc +++ b/modules/ROOT/pages/anaconda/anaconda.adoc @@ -3,7 +3,7 @@ [caption="Entering Anaconda, Montana. A city probably named after this installation program. David Cantrell took this picture in 2011. His grey VW Jetta is parked in the background."] image::DSC_3217.JPG[Anaconda,400] -Anaconda is the installation program used by Fedora, Red Hat Enterprise Linux and xref:anaconda/anaconda_distros.adoc[some other distributions]. +Anaconda is the installation program used by Fedora, Red Hat Enterprise Linux and some other distributions. During installation, a target computer's hardware is identified and configured, and the appropriate file systems for the system's architecture are created. Finally, Anaconda allows the user to install the operating system software on the target computer. From 028a77bad27720c16aa22b166bf60fef7c852ee7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Ravier?= Date: Wed, 12 Jan 2022 18:58:28 +0100 Subject: [PATCH 5/5] kernel/overview: Fix broken link to "Building a Custom Kernel" Fixes: ``` [17:57:31.052] ERROR (asciidoctor): target of xref not found: build-custom-kernel.adoc file: /antora/modules/ROOT/pages/kernel/overview.adoc source: /antora (refname: master ) ``` --- modules/ROOT/pages/kernel/overview.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/kernel/overview.adoc b/modules/ROOT/pages/kernel/overview.adoc index f76c100..0795353 100644 --- a/modules/ROOT/pages/kernel/overview.adoc +++ b/modules/ROOT/pages/kernel/overview.adoc @@ -160,7 +160,7 @@ the overall size of the vmlinux that is loaded to a core set of functionality. If you find that the Fedora configuration options are not sufficient for your needs, you can rebuild the kernel and change options as you see fit. See the -documentation on <>. +documentation on xref:kernel/build-custom-kernel.adoc[building a custom kernel]. [[community]]