From c2bc401ae3aaa798506da97d93dafe092fa25b11 Mon Sep 17 00:00:00 2001 From: Anthony Lapenna Date: Tue, 18 Apr 2017 18:20:02 +0200 Subject: [PATCH] docs(templates): add a section about the note field --- docs/source/templates.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/source/templates.rst b/docs/source/templates.rst index bff8985e..9801ada9 100644 --- a/docs/source/templates.rst +++ b/docs/source/templates.rst @@ -194,6 +194,22 @@ This field is **optional**. "privileged": true } +``note`` +-------- + +Usage / extra information about the template. This will be displayed inside the template +creation form in the Portainer UI. + +Supports HTML. + +This field is **optional**. + +.. code-block:: json + + { + "note": "You can use this field to specify extra information.
It supports HTML." + } + Build and host your own templates =================================