From 18f810f607c55f19511426a7f850b6bec04c080d Mon Sep 17 00:00:00 2001
From: Janne Valkealahti <janne.valkealahti@gmail.com>
Date: Sun, 3 Nov 2019 16:08:13 +0000
Subject: [PATCH] Update docs

- Relates #1
---
 docs/README.adoc | 49 ++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 47 insertions(+), 2 deletions(-)

diff --git a/docs/README.adoc b/docs/README.adoc
index b772f98..68a4f0f 100644
--- a/docs/README.adoc
+++ b/docs/README.adoc
@@ -82,10 +82,32 @@ image::images/vscode-docs-streams-explorer-1.png[]
 === Stream Language
 
 _SCDF Stream Language_ is a *scdfs* format for defining stream definitions and their
-launch configurations.
+deploy configurations.
 
 image::images/vscode-docs-streams-language-1.gif[]
 
+_Stream Definition_ can have associated metadata sections which either adds instructions
+to main definition or its deployer configuration. For example it's possible to define
+_@env_ to associate it to particular environment, _@name_ to define a stream name,
+_@desc_ to define a stream description.
+
+For deploy sections it's also possible to define generic deployment properties using
+_@prop_ tag.
+
+[source]
+----
+# Debug launch configuration
+-- @env local
+-- @name ticktock-debug
+-- @prop deployer.log.local.debug-port=20001
+-- @prop deployer.log.local.debug-suspend=n
+
+# Main stream definition
+-- @env local
+-- @desc my stream description
+-- @name ticktock-debug
+time | log
+----
 
 [[vscode-manage-tasks]]
 == Manage Tasks
@@ -96,10 +118,33 @@ image::images/vscode-docs-tasks-explorer-1.png[]
 
 === Task Language
 
-_SCDF Task Language_ is a *scdfs* format
+_SCDF Task Language_ is a *scdfs* format for defining task definition and their
+launch configurations.
 
 image::images/vscode-docs-tasks-language-1.gif[]
 
+_Task Definition_ can have associated metadata sections which either adds instructions
+to main definition or its launch configuration. For example it's possible to define
+_@name_ to define a stream name or _@desc_ to define a stream description.
+
+For deploy sections it's also possible to define generic deployment properties using
+_@prop_ tag and a _@arg_ tag to define tasks command line arguments.
+
+[source]
+----
+# launch with a command line arg
+-- @arg --timestamp.format=yyyy
+
+# launch with debug suspend
+# we need to suspend task to allow time to connect to it
+-- @prop deployer.timestamp.local.debug-port=20100
+-- @prop deployer.timestamp.local.debug-suspend=y
+
+# Main task definition
+-- @name task
+timestamp
+----
+
 [[vscode-manage-jobs]]
 == Manage Jobs