From 9be195fae5363fa4d7ddb4b105db7a5fdeab57e8 Mon Sep 17 00:00:00 2001 From: Otto Urpelainen Date: Feb 14 2022 20:17:56 +0000 Subject: Document multi repo local preview 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. --- diff --git a/modules/contributing/pages/local-preview.adoc b/modules/contributing/pages/local-preview.adoc index f868563..cfe1864 100644 --- a/modules/contributing/pages/local-preview.adoc +++ b/modules/contributing/pages/local-preview.adoc @@ -12,6 +12,23 @@ To preview, run the `build.sh` script; this is the one that actually builds a lo 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].