From 04ff532ae1b874385d0f5e0c562dcfc0fe78dca9 Mon Sep 17 00:00:00 2001 From: Renat Akhmerov Date: Tue, 13 Oct 2015 13:27:47 +0600 Subject: [PATCH] Fixing small issues in documentation Change-Id: I07801f9093ea047c8b8a32d91f2afe20d01fa7fc Partial-Bug: #1504582 --- doc/source/developer/index.rst | 1 - doc/source/developer/webapi/v2.rst | 2 -- doc/source/dsl/dsl_v2.rst | 3 +-- doc/source/main_features.rst | 2 +- doc/source/quickstart.rst | 9 ++++++--- 5 files changed, 8 insertions(+), 9 deletions(-) diff --git a/doc/source/developer/index.rst b/doc/source/developer/index.rst index 69ec08ec..951fe744 100644 --- a/doc/source/developer/index.rst +++ b/doc/source/developer/index.rst @@ -4,7 +4,6 @@ Developer's Reference .. toctree:: :maxdepth: 3 - webapi/index creating_custom_action devstack troubleshooting diff --git a/doc/source/developer/webapi/v2.rst b/doc/source/developer/webapi/v2.rst index adeb2d93..1c5259e7 100644 --- a/doc/source/developer/webapi/v2.rst +++ b/doc/source/developer/webapi/v2.rst @@ -1,8 +1,6 @@ V2 API ====== -.. warning:: (2014-10-5): API described in this document might slightly change within a short period of time (2-3 weeks) and should be now considered experimental. Mistral team is now actively working on stabilization. - This API describes the ways of interacting with Mistral service via HTTP protocol using Representational State Transfer concept (ReST). diff --git a/doc/source/dsl/dsl_v2.rst b/doc/source/dsl/dsl_v2.rst index f34ea606..f47e547e 100644 --- a/doc/source/dsl/dsl_v2.rst +++ b/doc/source/dsl/dsl_v2.rst @@ -790,8 +790,7 @@ Input parameters: dependencies and JS engine.** Currently Mistral uses only V8 Engine and its wrapper - PyV8. For installing it, do the next steps: -1. Install required libraries - boost, g++, libtool, autoconf, -subversion, libv8-legacy-dev: On Ubuntu:: +1. Install required libraries - boost, g++, libtool, autoconf, subversion, libv8-legacy-dev: On Ubuntu:: sudo apt-get install libboost-all-dev g++ libtool autoconf libv8-legacy-dev subversion make diff --git a/doc/source/main_features.rst b/doc/source/main_features.rst index 11050b05..119e696e 100644 --- a/doc/source/main_features.rst +++ b/doc/source/main_features.rst @@ -21,7 +21,7 @@ tasks on specific Mistral executors. In fact, there are 2 cases: 1. Need to execute the task on single executor. 2. Need to execute the task on one of executor in executors group which has one name. -For enabling task affinity feature, edit edit section "executor" host property +For enabling task affinity feature, edit section "executor" host property in configuration file:: [executor] diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst index 091e0b57..891cb2ad 100644 --- a/doc/source/quickstart.rst +++ b/doc/source/quickstart.rst @@ -24,7 +24,7 @@ To use the OpenStack command line tools you should specify environment variables Write Workflow -------------- -For example, the following workflow has been written:: +For example, we have the following workflow:: --- version: "2.0" @@ -44,10 +44,13 @@ For example, the following workflow has been written:: task2: action: std.echo="Done" +This is a simple workflow iterates through the given list of names in its first task (using "with-items") and stores +them as a task result (using echo action) and then stores word "Done" as a result of the second task. + Create Workflow Object ---------------------- -Use *python-mistralclient* to create the workflow:: +Use *Mistral CLI* to create the workflow:: mistral workflow-create @@ -63,7 +66,7 @@ Make sure that output is like the following:: Run Workflow and Check the Result --------------------------------- -Use *python-mistralclient* to run just created workflow. Pass variable **names** as **workflow_input**:: +Use *Mistral CLI* to run just created workflow. Pass variable **names** as **workflow_input**:: mistral execution-create my_workflow '{"names": ["John", "Mistral", "Ivan", "Crystal"]}'