Skip to content

Commit

Permalink
Update Template Unit documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pieqq committed Feb 13, 2024
1 parent 83904fa commit f2dc015
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/reference/units/template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,24 @@ Template-Specific Fields
``stress/reboot_{iterations}_times``, the computed ``template-id`` field
will be ``stress/reboot_iterations_times``.

.. _Template template-summary field:

``template-summary``
A human readable name for the template. This value is available for
translation into other languages. It must be one line long, ideally it
should be short (50-70 characters max).

This field is optional (Checkbox will only advise you to provide one when
running provider validation).

.. _Template template-description field:

``template-description``
A long form description of what the template does or the kind of jobs it
instantiates. This value is available for translation into other languages.

This field is optional.

.. _Template template-unit field:

``template-unit``
Expand Down

0 comments on commit f2dc015

Please sign in to comment.