From 00be75ca3bc7db0b52d0cff618bbf463af30598e Mon Sep 17 00:00:00 2001 From: Anthony Lapenna Date: Fri, 19 May 2017 09:14:29 +0200 Subject: [PATCH] doc(templates): add documentation about the platform and categories template fields --- docs/source/templates.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/source/templates.rst b/docs/source/templates.rst index 9801ada9..04e265a8 100644 --- a/docs/source/templates.rst +++ b/docs/source/templates.rst @@ -210,6 +210,33 @@ This field is **optional**. "note": "You can use this field to specify extra information.
It supports HTML." } +``platform`` +------------ + +Supported platform. This field value must be set to **linux** or **windows**. This will display a small +platform related icon in the Portainer UI. + +This field is **optional**. + +.. code-block:: json + + { + "platform": "linux" + } + +``categories`` +-------------- + +An array of categories that will be associated to the template. Portainer UI category filter +will be populated based on all available categories. + +This field is **optional**. + +.. code-block:: json + + { + "categories": ["webserver", "open-source"] + } Build and host your own templates =================================