From a0229581069a9b957dfec10714f0a4d5ef0dc162 Mon Sep 17 00:00:00 2001 From: Michel Lind Date: Apr 07 2025 21:51:10 +0000 Subject: Remove old build scripts Stick to using docsbuilder.sh only to avoid confusion Signed-off-by: Michel Lind --- diff --git a/Makefile b/Makefile deleted file mode 100644 index 2940918..0000000 --- a/Makefile +++ /dev/null @@ -1,18 +0,0 @@ -# This is borrowed from -# https://pagure.io/packaging-committee/blob/f1b1d86f206630219b4e01e34621f79ce93c1317/f/Makefile - -mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST))) -mkfile_dir := $(patsubst %/,%,$(dir $(mkfile_path))) - -doc: - podman run --rm -it -v "$(mkfile_dir):/antora:z" \ - antora/antora --html-url-extension-style=indexify site.yml - -.ONESHELL: -serve: - @cd "$(mkfile_dir)/public" - $(info *** Make sure to refresh pages without cache ***) - python3 -m http.server - -.DEFAULT_GOAL := doc -.PHONY: doc serve diff --git a/build.sh b/build.sh deleted file mode 100755 index 1e4db2d..0000000 --- a/build.sh +++ /dev/null @@ -1,46 +0,0 @@ -#!/bin/sh - -image="docker.io/antora/antora" -cmd="--html-url-extension-style=indexify site.yml" - -if [ "$(uname)" == "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 - -elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then - # Running on Linux. - # Check whether podman is available, else faill back to docker - # which requires root. - - if [ -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 - - elif [ -f /usr/bin/docker ]; then - echo "" - echo "This build script is using Docker to run the build in an isolated environment." - echo "" - - if groups | grep -wq "docker"; then - docker run --rm -it -v $(pwd):/antora:z $image $cmd - else - 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 - else - echo "" - echo "Error: Container runtime haven't been found on your system. Fix it by:" - echo "$ sudo dnf install podman" - exit 1 - fi -fi diff --git a/fesco/antora.yml b/fesco/antora.yml index e735c25..c24f9f6 100644 --- a/fesco/antora.yml +++ b/fesco/antora.yml @@ -1,6 +1,22 @@ +# 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) name: fesco + +# Title will be visible on the page. title: FESCo -version: master + +# 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. start_page: ROOT:index.adoc + +# This lists all the menu definitions of your component. nav: - modules/ROOT/nav.adoc diff --git a/preview.sh b/preview.sh deleted file mode 100755 index aeed9f1..0000000 --- a/preview.sh +++ /dev/null @@ -1,17 +0,0 @@ -#!/bin/sh - -if [ "$(uname)" == "Darwin" ]; then - # Running on macOS. - # Let's assume that the user has the Docker CE installed - # which doesn't require a root password. - echo "The preview will be available at http://localhost:8080/" - docker run --rm -v $(pwd):/antora:ro -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro -p 8080:80 nginx - -elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then - # Running on Linux. - # Fedora Workstation has python3 installed as a default, so using that - echo "" - echo "The preview is available at http://localhost:8080" - echo "" - python3 -m http.server --directory ./public 8080 -fi