Update the docs for nstack start

This includes https://github.com/nstack/nstack-server/issues/468, but they were generally out of date.
nstack · May 12, 2017 · 2ceda1b · 2ceda1b
1 parent c0cc661
commit 2ceda1b
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 19 deletions.
diff --git a/quick_start/workflow.rst b/quick_start/workflow.rst
@@ -105,7 +105,7 @@ To start our workflow in the cloud, we use the start command:
 
 .. code :: bash
 
- ~/DemoWorkflow/ $ nstack start DemoWorkflow:0.0.1-SNAPSHOT.w
+ ~/DemoWorkflow/ $ nstack start DemoWorkflow:0.0.1-SNAPSHOT w
 
 We now have a live HTTP endpoint on ``localhost:8080/demo``. The HTTP endpoint is configured to accept JSON-encoded values. We defined it to use an input schema of ``Text``, so we will be able to send it any JSON ``string``. In our JSON, we put ``params`` as the key, and our input as the value:
 

diff --git a/reference/nstack_toolkit.rst b/reference/nstack_toolkit.rst
@@ -122,29 +122,21 @@ Builds a module on your hosted nstack instance.
 ^^^^^^^^^
 .. code:: bash
 
-    $ nstack start <workflow>
+    $ nstack start <module_name> <function_name>
 
 
-==============  ===========
-Option          Description
-==============  ===========
-``<workflow>``  The workflow to start, in NStack Workflow Language
-==============  ===========
-
+=================  ====================================================================
+Option             Description
+=================  ====================================================================
+``module_name``    The nstack module which contains a fully-composed workflow function
+``function_name``  The fully-composed workflow function name
+=================  ====================================================================
 
-Used to start a workflow as a process. Workflows can either be provided as an argument such as:
+Used to start a workflow as a process. For example,
 
 .. code:: bash
-    $ nstack start
-    > import MySource:0.0.1 as MySource;
-    > import MySink:0.0.1 as MySink;
-    > import MyModule:0.0.1 as MyModule;
-    > MySource.src | MyModule.myMethod | MySink.snk
 
-Or, if you have built a workflow as a module, you can start it with:
-
-.. code:: bash
-    $ nstack start "Import MyWorkflow:0.0.1 as W; W.myWorkflow"
+    $ nstack start MyWorkflow:0.0.1 myWorkflow
 
 
 ``notebook`` 

diff --git a/resources/screencasts/creating.sh b/resources/screencasts/creating.sh
@@ -56,7 +56,7 @@ nstack build
 nstack list workflows
 
 # let's start our complete workflow, with NStack handling the runtime
-nstack start nstack/Demo.Workflow:0.0.1-SNAPSHOT.w
+nstack start nstack/Demo.Workflow:0.0.1-SNAPSHOT w
 
 # we can send events into our workflow from the CLI for testing
 # let's try it...