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) <jwf@redhat.com>
This commit is contained in:
Justin W. Flory (he/him) 2023-10-14 20:43:48 -05:00
parent bdaaa7a85d
commit b5646a0529
No known key found for this signature in database
GPG key ID: 7748B15FA8FA4C7E
5 changed files with 21 additions and 17 deletions

View file

@ -1,12 +1,16 @@
# 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: council name: council
# Title will be visible on the page. # Title will be visible on the page.
title: Fedora Council 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. # 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. # 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. # This lists all the menu definitions of your component.
nav: nav:
- modules/ROOT/nav.adoc - modules/ROOT/nav.adoc

View file

@ -1,16 +1,16 @@
# 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: engineering # <---- PLEASE MODIFY name: engineering
# Title will be visible on the page. # 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. # 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. # 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. # This lists all the menu definitions of your component.
#nav: #nav:
#- modules/ROOT/nav.adoc # - modules/ROOT/nav.adoc

View file

@ -1,15 +1,15 @@
# 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: mindshare # <---- PLEASE MODIFY name: mindshare
# Title will be visible on the page. # 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. # 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. # 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. # This lists all the menu definitions of your component.
#nav: #nav:

View file

@ -6,11 +6,11 @@ name: project
title: Fedora 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. # 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. # 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. # This lists all the menu definitions of your component.
nav: nav:
- modules/ROOT/nav.adoc - modules/ROOT/nav.adoc

View file

@ -1,6 +1,6 @@
site: site:
title: Local Preview title: Local Preview
start_page: council::index start_page: council::index.adoc
content: content:
sources: sources:
- url: . - url: .