From b1c1094da455dcdd257066c0d62a278b866c534f Mon Sep 17 00:00:00 2001
From: "Q.hongtao" <qihongtao@inspur.com>
Date: Thu, 9 Apr 2020 17:28:21 +0800
Subject: [PATCH] Add version info into doc

Vitrage have multiple versions of the template syntax. Although the check and
upload service may have a default version  I think the template verison should
be added to the meta in each example, after all, the default version will change
with the code version upgrade.

Change-Id: Ia74458073891bd273a5c51ccdf386b8ea702cd20
---
 doc/source/contributor/not_operator_support.rst | 5 +++++
 doc/source/contributor/templates-loading.rst    | 1 +
 2 files changed, 6 insertions(+)

diff --git a/doc/source/contributor/not_operator_support.rst b/doc/source/contributor/not_operator_support.rst
index 3a669a59c..263d34bf2 100644
--- a/doc/source/contributor/not_operator_support.rst
+++ b/doc/source/contributor/not_operator_support.rst
@@ -16,6 +16,7 @@ The template is written in YAML language, with the following structure.
 ::
 
   metadata:
+    version: <template version>
     name: <unique template identifier>
     description: <what this template does>
   definitions:
@@ -73,6 +74,7 @@ There exists an instance on Host but there is no Alarm on the instance.
  ::
 
     metadata:
+        version: 2
         name: no_alarm_on_instance_that_contained_in_host
         description: when host contains vm that has no alarm on it, show implications on the host
     definitions:
@@ -126,6 +128,7 @@ There exists a host with no alarm.
  ::
 
     metadata:
+        version: 2
         name: no_alarm_on_host
         description: when there is no alarm on the host, show implications on the host
     definitions:
@@ -183,6 +186,7 @@ There is no edge between the Vm and the Port.
  ::
 
     metadata:
+        version: 2
         name: no_connection_between_vm_and_port
         description: when there is no edge between the port and the vm, show implications on the instances
     definitions:
@@ -268,6 +272,7 @@ In the subgraphs above, we had only one vertex which was not connected to the ma
  ::
 
     metadata:
+        version: 2
         name: host_contains_vm_with_no_edge_to_stack_that_has_alarm_on_it
         description: when host contains vm without and edge to a stack that has no alarms, show implications on the instances
     definitions:
diff --git a/doc/source/contributor/templates-loading.rst b/doc/source/contributor/templates-loading.rst
index 91d342086..fee76324c 100644
--- a/doc/source/contributor/templates-loading.rst
+++ b/doc/source/contributor/templates-loading.rst
@@ -23,6 +23,7 @@ Let's take a basic template as example
 .. code-block:: yaml
 
   metadata:
+   version: 2
    name: basic_template
    description: basic template for general tests
   definitions: