Merge #416 Antora 3.0 related updates

This commit is contained in:
Ankur Sinha 2022-02-10 09:40:44 +00:00
commit 682417fcf1
5 changed files with 37 additions and 30 deletions

View file

@ -1,15 +1,21 @@
# Name will be mostly visible in the URL. Treat it as an indentifier. # 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 name: quick-docs
# Title will be visible on the page. # Title will be visible on the page.
title: Quick Docs 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 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
start_page: ROOT:index # 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. # This lists all the menu definitions of your component.
nav: nav:

View file

@ -3,30 +3,30 @@
image="docker.io/antora/antora" image="docker.io/antora/antora"
cmd="--html-url-extension-style=indexify site.yml" cmd="--html-url-extension-style=indexify site.yml"
if [ "$(uname)" == "Darwin" ]; then if uname | grep -iwq darwin; then
# Running on macOS. # Running on macOS.
# Let's assume that the user has the Docker CE installed # Let's assume that the user has the Docker CE installed
# which doesn't require a root password. # which doesn't require a root password.
echo "" echo ""
echo "This build script is using Docker container runtime to run the build in an isolated environment." echo "This build script is using Docker container runtime to run the build in an isolated environment."
echo "" 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. # Running on Linux.
# there isn't an antora/aarch64 container, antora can be installed locally # there isn't an antora/aarch64 container, antora can be installed locally
# Check whether podman is available, else faill back to docker # Check whether podman is available, else faill back to docker
# which requires root. # which requires root.
if [ -f /usr/local/bin/antora ]; then if [ -f /usr/local/bin/antora ]; then
/usr/local/bin/antora $cmd /usr/local/bin/antora "${cmd}"
elif [[ `uname -m` == "aarch64" ]]; then elif uname -m | grep -iwq aarch64; then
echo "no antora/aarch64 container try just \`npm install -g @antora/cli @antora/site-generator-default\`" echo "no antora/aarch64 container try just \`npm install -g @antora/cli @antora/site-generator-default\`"
elif [ -f /usr/bin/podman ]; then elif [ -f /usr/bin/podman ]; then
echo "" echo ""
echo "This build script is using Podman to run the build in an isolated environment." echo "This build script is using Podman to run the build in an isolated environment."
echo "" 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 elif [ -f /usr/bin/docker ]; then
echo "" echo ""
@ -34,13 +34,14 @@ elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
echo "" echo ""
if groups | grep -wq "docker"; then 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 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 ""
echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password." sudo docker run --rm -it -v "$(pwd):/antora:z" "${image}" "${cmd}"
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 fi
else else
echo "" echo ""

View file

@ -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."] [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] 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. 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. Finally, Anaconda allows the user to install the operating system software on the target computer.

View file

@ -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 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 needs, you can rebuild the kernel and change options as you see fit. See the
documentation on <<build-custom-kernel.adoc#,building a custom kernel>>. documentation on xref:kernel/build-custom-kernel.adoc[building a custom kernel].
[[community]] [[community]]

View file

@ -1,6 +1,6 @@
site: site:
title: Local Preview title: Local Preview
start_page: quick-docs::index start_page: quick-docs::index.adoc
content: content:
sources: sources:
- url: . - url: .
@ -16,5 +16,5 @@ output:
destinations: destinations:
- provider: archive - provider: archive
runtime: runtime:
pull: true fetch: true
cache_dir: ./cache cache_dir: ./cache