From b5646a0529679b90b2888dce0e6f8dd3f5837ee7 Mon Sep 17 00:00:00 2001 From: Justin W. Flory (he/him) Date: Oct 15 2023 01:43:48 +0000 Subject: docs: Fix Antora start_path for all components This commit fixes all Antora configuration files for the components underneath this repository. When you run the build script, it reports errors that it is unable to find the reference for the `start_path` for all of the components. This is because the full path is required, including the `.adoc` file ending. So, this commit makes the path explicit and therefore, fixes the errors. Signed-off-by: Justin W. Flory (he/him) --- diff --git a/council/antora.yml b/council/antora.yml index 89c3bcb..8ea16ff 100644 --- a/council/antora.yml +++ b/council/antora.yml @@ -1,12 +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: council + # Title will be visible on the page. title: Fedora Council + # 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: ~ + # 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: -- modules/ROOT/nav.adoc + - modules/ROOT/nav.adoc diff --git a/engineering/antora.yml b/engineering/antora.yml index edd84ec..f10b400 100644 --- a/engineering/antora.yml +++ b/engineering/antora.yml @@ -1,16 +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: engineering # <---- PLEASE MODIFY +name: engineering # Title will be visible on the page. -title: Engineering Teams # <---- PLEASE MODIFY +title: Engineering Teams # 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: ~ # 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: -#- modules/ROOT/nav.adoc +# - modules/ROOT/nav.adoc diff --git a/mindshare/antora.yml b/mindshare/antora.yml index b652af1..bbdec36 100644 --- a/mindshare/antora.yml +++ b/mindshare/antora.yml @@ -1,15 +1,15 @@ # 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: mindshare # <---- PLEASE MODIFY +name: mindshare # Title will be visible on the page. -title: Mindshare Teams # <---- PLEASE MODIFY +title: Mindshare Teams # 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: ~ # 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/project/antora.yml b/project/antora.yml index 30b39aa..6db2236 100644 --- a/project/antora.yml +++ b/project/antora.yml @@ -6,11 +6,11 @@ name: project title: Fedora Project # 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: ~ # 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: -- modules/ROOT/nav.adoc + - modules/ROOT/nav.adoc diff --git a/site.yml b/site.yml index 0aeb2d0..e52f639 100644 --- a/site.yml +++ b/site.yml @@ -1,6 +1,6 @@ -site: +site: title: Local Preview - start_page: council::index + start_page: council::index.adoc content: sources: - url: .