From dc30347bcc64cb648fc9d8b615a5dd3df203ec8f Mon Sep 17 00:00:00 2001 From: Otto Urpelainen Date: Apr 21 2022 04:50:47 +0000 Subject: [PATCH 1/3] Add generated preview files to .gitignore --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5f96717 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +build/ +cache/ +public/ From f2e05b8a20360758579bf461cd99516604097657 Mon Sep 17 00:00:00 2001 From: Otto Urpelainen Date: Apr 21 2022 04:51:15 +0000 Subject: [PATCH 2/3] Update site.yml to work with Antora 3 Fedora Docs has moved to using Antora 3 and Antora 3 renamed site.yml parameter runtime.pull to runtime.fetch. Change parameter name to fix local preview generation. --- diff --git a/site.yml b/site.yml index fa45f41..2fd6c21 100644 --- a/site.yml +++ b/site.yml @@ -16,5 +16,5 @@ output: destinations: - provider: archive runtime: - pull: true + fetch: true cache_dir: ./cache From b288ab551a9d6739219de6be3b9333837ed699b0 Mon Sep 17 00:00:00 2001 From: Otto Urpelainen Date: Apr 21 2022 04:57:39 +0000 Subject: [PATCH 3/3] Use index.adoc as start page The default start page recommended by fedora-docs/template is index.adoc. Java-packaging-howto was using simply 'index'. Antora does not automatically guess file extensions, so this configuration caused the following warning during local preview generation: [04:55:16.835] WARN (@antora/content-classifier): Start page specified for site not found: java-packaging-howto::index Also, it was difficult to link to java-packaging-howto from other components, because the expected reference java-packaging-howto::index.adoc did not work. This has caused a broken link in the Packaging Guidelines. Fix everything by switching to use the default index.adoc start page. --- diff --git a/antora.yml b/antora.yml index d0e93b9..21b2286 100644 --- a/antora.yml +++ b/antora.yml @@ -9,7 +9,7 @@ title: Java-Packaging HOWTO 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 +start_page: ROOT:index.adoc # This lists all the menu definitions of your component. nav: diff --git a/site.yml b/site.yml index 2fd6c21..f57687d 100644 --- a/site.yml +++ b/site.yml @@ -1,6 +1,6 @@ site: title: Local Preview - start_page: java-packaging-howto::index + start_page: java-packaging-howto::index.adoc content: sources: - url: .