From 78f95ff85400b2acc50c29ead1cb1441dbc0a920 Mon Sep 17 00:00:00 2001 From: David Jencks Date: Wed, 6 Nov 2019 14:11:54 -0800 Subject: [PATCH 1/2] clarify sources start path --- docs/modules/playbook/pages/playbook-schema.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/modules/playbook/pages/playbook-schema.adoc b/docs/modules/playbook/pages/playbook-schema.adoc index ad6fe4b86..3d3e1d22d 100644 --- a/docs/modules/playbook/pages/playbook-schema.adoc +++ b/docs/modules/playbook/pages/playbook-schema.adoc @@ -180,6 +180,7 @@ Learn more: Antora automatically looks for the xref:ROOT:component-descriptor.adoc[component descriptor] file at the root of a repository. When the documentation component isn't stored at the root, you need to specify the repository relative path to the component descriptor's location using `start_path`. +The url identifies where the git repository is and the start_path identifies where antora.yml is in the git repository (or local worktree). Learn more: -- GitLab From 3a18817b113f62f7b3928ffebbaecc239a937fd6 Mon Sep 17 00:00:00 2001 From: Sarah White Date: Mon, 24 Feb 2020 20:32:23 +0000 Subject: [PATCH 2/2] add ` to key names and path markup to antora.yml --- docs/modules/playbook/pages/playbook-schema.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/playbook/pages/playbook-schema.adoc b/docs/modules/playbook/pages/playbook-schema.adoc index 3d3e1d22d..7db774518 100644 --- a/docs/modules/playbook/pages/playbook-schema.adoc +++ b/docs/modules/playbook/pages/playbook-schema.adoc @@ -180,7 +180,7 @@ Learn more: Antora automatically looks for the xref:ROOT:component-descriptor.adoc[component descriptor] file at the root of a repository. When the documentation component isn't stored at the root, you need to specify the repository relative path to the component descriptor's location using `start_path`. -The url identifies where the git repository is and the start_path identifies where antora.yml is in the git repository (or local worktree). +The `url` identifies where the git repository is and the `start_path` identifies where [.path]_antora.yml_ is in the git repository (or local worktree). Learn more: -- GitLab