PR#15: Antora 3.0 related updates - fedora-docs/flatpak

fedora-docs / flatpak

#15 Antora 3.0 related updates

Merged a year ago by kalev. Opened 2 years ago by siosm.

Unknown source antora3 into master

*.yaml: Minor styling fixes

Timothée Ravier • a year ago

d8ef0c5

build & preview: Update with latest version from template

Timothée Ravier • a year ago

86cb86f

Update configuration for Antora 3.0

Timothée Ravier • a year ago

88652f8

antora.yml

file modified

+11 -5

		`@@ -1,15 +1,21 @@`
		`# 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: flatpak`

		`- # Title will be visible on the page.`
		`+ # Title will be visible on the page.`
		`title: Flatpak`

		`- # 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.`
		`- start_page: ROOT:index`
		`+ # 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:`

build.sh

file modified

+50 -1

		`@@ -1,3 +1,52 @@`
		`#!/bin/sh`

		`- podman run --rm -it -v $(pwd):/antora:z antora/antora --html-url-extension-style=indexify site.yml`
		`+ image="docker.io/antora/antora"`
		`+ cmd="--html-url-extension-style=indexify site.yml"`
		`+`
		`+ 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}`
		`+`
		`+ 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 \| 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}`
		`+`
		`+ 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 "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}`
		`+ 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`

preview.sh

file modified

+16 -1

		`@@ -1,3 +1,18 @@`
		`#!/bin/sh`

		`- podman run --rm --network=host -v $(pwd):/antora:ro,z -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro,z nginx`
		`+ 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 ""`
		`+ cd ./public`
		`+ python3 -m http.server 8080`
		`+ fi`

site.yml

file modified

+7 -7

		`@@ -1,6 +1,6 @@`
		`- site:`
		`+ site:`
		`title: Flatpak Packager Docs (Preview)`
		`- start_page: flatpak::index`
		`+ start_page: flatpak::index.adoc`
		`content:`
		`sources:`
		`- url: .`
		`@@ -10,11 +10,11 @@`
		`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:`
		`- pull: true`
		`+ fetch: true`
		`cache_dir: ./cache`