From 7a0170ad0b58a18f27e37d37970334385ec75bbb Mon Sep 17 00:00:00 2001 From: David Jencks Date: Thu, 24 Oct 2019 12:46:25 -0700 Subject: [PATCH] docs: suggest lowercase component name and version --- docs/modules/ROOT/pages/component-descriptor.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/modules/ROOT/pages/component-descriptor.adoc b/docs/modules/ROOT/pages/component-descriptor.adoc index fb8bcc06b..f1c337e75 100644 --- a/docs/modules/ROOT/pages/component-descriptor.adoc +++ b/docs/modules/ROOT/pages/component-descriptor.adoc @@ -57,6 +57,8 @@ The value isn't related to the name of the repository or directory the component For instance, a documentation component might be stored in a GitLab repository named _Coco B's Massive Quantum App_ but this doesn't impact how Antora handles the component when it publishes a documentation site that uses it. Antora only uses the value assigned to the component's name key when converting resource IDs and generating the URLs for the component's pages. //, which Coco B's docs manager decided should be `mq`, +[TIP] +To minimise the likelyhood of portability issues between web servers, letters used in component name and component version should be lowercase. === `title` -- GitLab