From 5258eaa6ca0325fe6f0bc369fb6dbcc90c4b7187 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Holcroft Date: Sat, 9 Nov 2019 23:20:32 +0100 Subject: [PATCH] first commit --- .gitignore | 3 +++ LICENSE | 10 ++++++++ antora.yml | 16 ++++++++++++ build.sh | 46 +++++++++++++++++++++++++++++++++++ modules/ROOT/nav.adoc | 0 modules/ROOT/pages/index.adoc | 5 ++++ modules/ROOT/pages/test.csv | 2 ++ nginx.conf | 14 +++++++++++ preview.sh | 18 ++++++++++++++ site.yml | 20 +++++++++++++++ 10 files changed, 134 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 antora.yml create mode 100755 build.sh create mode 100644 modules/ROOT/nav.adoc create mode 100644 modules/ROOT/pages/index.adoc create mode 100644 modules/ROOT/pages/test.csv create mode 100644 nginx.conf create mode 100755 preview.sh create mode 100644 site.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..9f3ebf55 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +build +cache +public diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..ba8d521a --- /dev/null +++ b/LICENSE @@ -0,0 +1,10 @@ +The text of and illustrations in this document are licensed by Red Hat +under a Creative Commons Attribution–Share Alike 3.0 Unported license +("CC-BY-SA"). An explanation of CC-BY-SA is available at +http://creativecommons.org/licenses/by-sa/3.0/. In accordance with +CC-BY-SA, if you distribute this document or an adaptation of it, you +must provide the URL for the original version. + +Red Hat, as the licensor of this document, waives the right to +enforce, and agrees not to assert, Section 4d of CC-BY-SA to the +fullest extent permitted by applicable law. diff --git a/antora.yml b/antora.yml new file mode 100644 index 00000000..58952785 --- /dev/null +++ b/antora.yml @@ -0,0 +1,16 @@ +# 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) +name: localization # <---- PLEASE MODIFY + +# Title will be visible on the page. +title: Localization help and stats # <---- 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 "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 + +# This lists all the menu definitions of your component. +nav: +- modules/ROOT/nav.adoc diff --git a/build.sh b/build.sh new file mode 100755 index 00000000..1e4db2da --- /dev/null +++ b/build.sh @@ -0,0 +1,46 @@ +#!/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/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc new file mode 100644 index 00000000..e69de29b diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc new file mode 100644 index 00000000..17892617 --- /dev/null +++ b/modules/ROOT/pages/index.adoc @@ -0,0 +1,5 @@ += Stats + +=== +include::test.csv[] +=== diff --git a/modules/ROOT/pages/test.csv b/modules/ROOT/pages/test.csv new file mode 100644 index 00000000..2096e37a --- /dev/null +++ b/modules/ROOT/pages/test.csv @@ -0,0 +1,2 @@ +header one, header to +text 1, text 2 diff --git a/nginx.conf b/nginx.conf new file mode 100644 index 00000000..f7093b3e --- /dev/null +++ b/nginx.conf @@ -0,0 +1,14 @@ +server { + listen 80; + server_name localhost; + + location / { + root /antora/public; + index index.html index.htm; + } + + error_page 500 502 503 504 /50x.html; + location = /50x.html { + root /usr/share/nginx/html; + } +} diff --git a/preview.sh b/preview.sh new file mode 100755 index 00000000..acc52afe --- /dev/null +++ b/preview.sh @@ -0,0 +1,18 @@ +#!/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 "" + cd ./public + python3 -m http.server 8080 +fi diff --git a/site.yml b/site.yml new file mode 100644 index 00000000..bd8ae0de --- /dev/null +++ b/site.yml @@ -0,0 +1,20 @@ +site: + title: Local Preview + start_page: localization::index +content: + sources: + - url: . + branches: HEAD +ui: + bundle: + url: https://asamalik.fedorapeople.org/ui-bundle.zip + snapshot: true + default_layout: with_menu +output: + clean: true + dir: ./public + destinations: + - provider: archive +runtime: + pull: true + cache_dir: ./cache