Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
- Relates spring-attic#1
  • Loading branch information
jvalkeal committed Nov 3, 2019
1 parent b547685 commit 18f810f
Showing 1 changed file with 47 additions and 2 deletions.
49 changes: 47 additions & 2 deletions docs/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down

0 comments on commit 18f810f

Please sign in to comment.