PR#47: Document multi repo local preview - fedora-docs/documentation-contributors-guide

fedora-docs / documentation-contributors-guide

#47 Document multi repo local preview

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

fedora-docs/ oturpe/documentation-contributors-guide multip-repo-local-preview into master

Otto Urpelainen • 2 years ago

9be195f

modules/contributing/pages/local-preview.adoc

file modified

+17

		`@@ -12,6 +12,23 @@`
		To run the scripts you'll need to install [application]`Podman` if using a Linux OS such as Fedora or [application]`Docker CE` if using macOS.
		`====`

		`+ == Previewing multiple repositories`
		`+ If your work spans content in multiple repositories,`
		`+ e.g. because you xref:asciidoc-fedora:markup.adoc#external-antora-link[link to another repository],`
		+ you can extend the preview by adding more repositories to `site.yml` as follows:
		`+`
		`+ ----`
		`+ content:`
		`+ sources:`
		`+ - url: .`
		`+ branches: HEAD`
		`+ - url: https://pagure.io/fedora-docs/another-repository.git`
		`+ branches: main`
		`+ ----`
		`+`
		`+ Correct entries to use can be found from`
		`+ https://pagure.io/fedora-docs/docs-fp-o/blob/prod/f/site.yml[docs-fp-o site.yml].`
		`+`
		`== Using the regular Antora scripts`
		`If you want to use the regular Antora build and preview workflow - follow the instructions on https://docs.antora.org/[Antora Documentation page].`

oturpe commented 2 years ago

Since docs-fp-o is split into multiple repositories
and these repositories can use content from each other through xrefs,
a local preview on a single repository may not be enough.
Add instructions to build a multi repo local preview
to address this issue.