#19 Antora 3.0 updates
Merged 6 months ago by darknao. Opened 7 months ago by siosm.
fedora-docs/ siosm/template main  into  main

file modified
+11 -5
@@ -1,15 +1,21 @@ 

  # 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)

+ # 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: pizza-factory  # <---- PLEASE MODIFY

  

- # Title will be visible on the page. 

+ # Title will be visible on the page.

  title: Pizza Factory # <---- 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 "~" 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 "~" 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

+ # 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:

file modified
+5 -5
@@ -10,7 +10,7 @@ 

      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 uname | grep -iq linux; then

      # Running on Linux.
@@ -19,14 +19,14 @@ 

      # which requires root.

  

      if [ -f /usr/local/bin/antora ]; then

-         /usr/local/bin/antora $cmd

+         /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,14 +34,14 @@ 

          echo ""

  

          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

              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

+             sudo docker run --rm -it -v "$(pwd):/antora:z" "${image}" "${cmd}"

          fi

      else

          echo ""

file modified
+7 -7
@@ -1,6 +1,6 @@ 

- site: 

+ site:

    title: Local Preview

-   start_page: pizza-factory::index

+   start_page: pizza-factory::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

1 new commit added

  • build.sh: Fix indentation
7 months ago

rebased onto e8c1ed7

7 months ago

The quotes don't look right here.

The quotes don't look right here.

Thanks for the review. This triggers https://github.com/koalaman/shellcheck/wiki/SC2046 when removed. What makes you think it's not right?

@siosm Can you rebase this PR please?

rebased onto 52d839b

6 months ago

Pull-Request has been merged by darknao

6 months ago