From d2c241a6a44ebb0789da7f104f5aa1508b1e726f Mon Sep 17 00:00:00 2001 From: Pierre Equoy Date: Tue, 16 Apr 2024 16:54:42 +0800 Subject: [PATCH] Mention allowed characters in template ids in the reference page (infra) (#1187) Mention allowed characters in template ids in the reference page Template ids, like job ids, should only include characters in [a-z0-9/-]. --- docs/reference/units/job.rst | 2 +- docs/reference/units/template.rst | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/reference/units/job.rst b/docs/reference/units/job.rst index f8a0e7fcb9..97cf8a7d05 100644 --- a/docs/reference/units/job.rst +++ b/docs/reference/units/job.rst @@ -26,7 +26,7 @@ Following fields may be used by the job unit: ``id``: (mandatory) - A name for the job. Should be unique, an error will be generated if there are duplicates. Should contain characters in - [a-z0-9/-]. + ``[a-z0-9/-]``. This field used to be called ``name``. That name is now deprecated. For backwards compatibility it is still recognized and used if ``id`` is missing. diff --git a/docs/reference/units/template.rst b/docs/reference/units/template.rst index 2eafab1e37..ff1bf82198 100644 --- a/docs/reference/units/template.rst +++ b/docs/reference/units/template.rst @@ -34,7 +34,8 @@ Template-Specific Fields .. _Template template-id field: ``template-id`` - Unique identifier for this template. + Unique identifier for this template. Should contain characters in + ``[a-z0-9/-]``. This field is optional. If absent, a ``template-id`` value will be computed from the ``id`` field. For instance, if the ``id`` field is