PR#17: antora 3.0 compatibility fix - neuro-sig/documentation

neuro-sig / documentation

#17 antora 3.0 compatibility fix

Merged 2 years ago by ankursinha. Opened 2 years ago by darknao.

neuro-sig/ darknao/documentation main into main

antora 3.0 compatibility fix

darknao • 2 years ago

fb685dc

antora.yml

file modified

+2 -2

		`@@ -6,10 +6,10 @@`
		`title: NeuroFedora User Documentation`

		`# 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:overview`
		`+ start_page: ROOT:overview.adoc`

		`# This lists all the menu definitions of your component.`
		`nav:`

site.yml

file modified

+3 -3

		`@@ -1,13 +1,13 @@`
		`site:`
		`title: Local Preview - NeuroFedora User Documentation`
		`- start_page: neurofedora::overview`
		`+ start_page: neurofedora::overview.adoc`
		`content:`
		`sources:`
		`- url: .`
		`branches: HEAD`
		`ui:`
		`bundle:`
		`- url: https://asamalik.fedorapeople.org/ui-bundle.zip`
		`+ url: https://releases.pagure.org/fedora-docs/fedora-docs-ui/ui-bundle-1.02.zip`
		`snapshot: true`
		`default_layout: with_menu`
		`output:`
		`@@ -16,5 +16,5 @@`
		`destinations:`
		`- provider: archive`
		`runtime:`
		`- pull: true`
		`+ fetch: true`
		`cache_dir: ./cache`

darknao commented 2 years ago

Required changes for Antora 3.0.0 compatibility, which should go live on prod very soon.
Note that without this fix, the start page for the neuroFedora component will not work properly (ie.: https://docs.stg.fedoraproject.org/en-US/neurofedora/)