PR#208: docs: Fix Antora start_path for all components - Fedora-Council/council-docs

Fedora-Council / council-docs

#208 docs: Fix Antora start_path for all components

Merged 2 years ago by jflory7. Opened 2 years ago by jflory7.

Fedora-Council/ jflory7/council-docs change/fix-start_path into main

docs: Fix Antora start_path for all components

Justin W. Flory (he/him) • 2 years ago

b5646a0

council/antora.yml

file modified

+7 -3

		`@@ -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`

engineering/antora.yml

file modified

+5 -5

		`@@ -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`

mindshare/antora.yml

file modified

+4 -4

		`@@ -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:`

project/antora.yml

file modified

+3 -3

		`@@ -6,11 +6,11 @@`
		`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`

site.yml

file modified

+2 -2

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

jflory7 commented 2 years ago

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.