Adjust images in the docs and other small fixes

* Some ".. image:" RST directives changed to ".. figure:" where
  it's more suitable.
* All images moved to subfolder where they're used
* Fixed indentation in the Workflow Language specification
* Other minor changes in docs

Change-Id: If2f206a5191d1eecdcf95e1f7b44a87968432876
This commit is contained in:
Renat Akhmerov 2020-01-24 12:10:44 +07:00
parent 6928615fde
commit 0ec5e48012
13 changed files with 73 additions and 71 deletions

View File

@ -6,7 +6,7 @@ How to work with asynchronous actions
Concept Concept
******* *******
.. image:: /img/Mistral_actions.png .. image:: /user/terminology/img/actions.png
During a workflow execution Mistral eventually runs actions. Action During a workflow execution Mistral eventually runs actions. Action
is a particular function (or a piece of work) that a workflow task is a particular function (or a piece of work) that a workflow task

View File

@ -64,8 +64,10 @@ script running on a single machine that is responsible for solving this
task just fails for whatever reason then the whole process of updating task just fails for whatever reason then the whole process of updating
a hundred servers will not complete and end up in an unknown state. a hundred servers will not complete and end up in an unknown state.
.. image:: img/cloud_cron_updating_multiple_servers.png .. figure:: img/cloud_cron_updating_multiple_servers.png
:alt: Updating multiple tenant servers :align: center
Figure 1. Updating multiple tenant servers
So that shows that we need to take care of at least: So that shows that we need to take care of at least:
@ -192,8 +194,10 @@ we can actually ssh other VMs. That's why we're using special action called
"std.ssh_proxied" where "proxied" means that we have a proxy VM to access "std.ssh_proxied" where "proxied" means that we have a proxy VM to access
all tenant VMs. all tenant VMs.
.. image:: img/ssh_proxied.png .. figure:: img/ssh_proxied.png
:alt: Ssh access through a gateway VM :align: center
Figure 2. Ssh access through a gateway VM.
Mistral is a distributed highly-available system and its designed not only Mistral is a distributed highly-available system and its designed not only
to survive infrastructural failures but also keep its workflows running. to survive infrastructural failures but also keep its workflows running.

View File

@ -17,7 +17,7 @@ result of the action. The third-party service should send a request to the
Mistral API and provide information corresponding to the *action execution* and Mistral API and provide information corresponding to the *action execution* and
its state and result. its state and result.
.. image:: /img/Mistral_actions.png .. image:: img/actions.png
:doc:`How to work with asynchronous actions </user/asynchronous_actions>` :doc:`How to work with asynchronous actions </user/asynchronous_actions>`
@ -27,7 +27,7 @@ System actions
System actions are provided by Mistral out of the box and are available to all System actions are provided by Mistral out of the box and are available to all
users. Additional actions can be added via the custom action plugin mechanism. users. Additional actions can be added via the custom action plugin mechanism.
:doc:`How to write an Action Plugin :doc:`How to create a custom action
</developer/extensions/creating_custom_action>` </developer/extensions/creating_custom_action>`

View File

@ -5,8 +5,9 @@ Cron trigger is an object allowing to run workflow on a schedule. User
specifies what workflow with what input needs to be run and also specifies specifies what workflow with what input needs to be run and also specifies
how often it should be run. how often it should be run.
.. image:: /img/Mistral_cron_trigger.png .. image:: img/cron_trigger.png
:align: center :align: center
Cron-pattern is used to describe the frequency of execution in Mistral. Cron-pattern is used to describe the frequency of execution in Mistral.
To see more about cron-patterns, refer to `Cron expression <https://en.wikipedia.org/wiki/Cron#CRON_expression>`_ To see more about cron-patterns, refer to
`Cron expression <https://en.wikipedia.org/wiki/Cron#CRON_expression>`_

View File

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View File

Before

Width:  |  Height:  |  Size: 3.3 KiB

After

Width:  |  Height:  |  Size: 3.3 KiB

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

View File

@ -18,7 +18,7 @@ name as a prefix for generating final names of workflows and actions included
into the workbook. To illustrate this principle let's take a look at the into the workbook. To illustrate this principle let's take a look at the
figure below: figure below:
.. image:: /img/Mistral_workbook_namespacing.png .. image:: img/workbook_namespacing.png
:align: center :align: center
So after a workbook has been uploaded its workflows and actions become So after a workbook has been uploaded its workflows and actions become

View File

@ -56,7 +56,7 @@ workflow has a notion of transition. Direct workflow is considered to be
completed if there aren't any transitions left that could be used to completed if there aren't any transitions left that could be used to
jump to next tasks. jump to next tasks.
.. image:: /img/Mistral_direct_workflow.png .. image:: img/direct_workflow.png
YAML example of direct workflow YAML example of direct workflow
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -97,7 +97,7 @@ task that needs to be completed, it can be conventionally called 'target
task'. When Mistral Engine starts a workflow it recursively identifies task'. When Mistral Engine starts a workflow it recursively identifies
all the dependencies that need to be completed first. all the dependencies that need to be completed first.
.. image:: /img/Mistral_reverse_workflow.png .. image:: img/reverse_workflow.png
The figure explains how reverse workflow works. In the example, task The figure explains how reverse workflow works. In the example, task
**T1** is chosen a target task. So when the workflow starts Mistral will **T1** is chosen a target task. So when the workflow starts Mistral will

View File

@ -43,10 +43,11 @@ Mistral is a perfect fit for being this kind of coordinator. In order to
illustrate everything described so far, lets consider an imaginary workflow illustrate everything described so far, lets consider an imaginary workflow
of calculating employees salaries in an enterprise. of calculating employees salaries in an enterprise.
.. image:: img/long_running_business_process.png .. figure:: img/long_running_business_process.png
:alt: Picture 1. Mistral maintains business workflows spanning multiple systems.
:align: center :align: center
Figure 1. Mistral maintains business workflows spanning multiple systems.
Given an employee full name (or id) such workflow may include the following Given an employee full name (or id) such workflow may include the following
computation steps: computation steps:

View File

@ -532,7 +532,7 @@ starts after another one depending on produced result. So direct workflow has a
notion of transition. Direct workflow is considered to be completed if there notion of transition. Direct workflow is considered to be completed if there
aren't any transitions left that could be used to jump to next tasks. aren't any transitions left that could be used to jump to next tasks.
.. image:: /img/Mistral_direct_workflow.png .. image:: /user/terminology/img/direct_workflow.png
Figure 1. Mistral Direct Workflow. Figure 1. Mistral Direct Workflow.
@ -962,7 +962,7 @@ be completed, it can be conventionally called 'target task'. When Mistral
Engine starts a workflow it recursively identifies all the dependencies that Engine starts a workflow it recursively identifies all the dependencies that
need to be completed first. need to be completed first.
.. image:: /img/Mistral_reverse_workflow.png .. image:: /user/terminology/img/reverse_workflow.png
Figure 2 explains how reverse workflow works. In the example, task **T1** is Figure 2 explains how reverse workflow works. In the example, task **T1** is
chosen a target task. So when the workflow starts Mistral will run only tasks chosen a target task. So when the workflow starts Mistral will run only tasks
@ -1421,7 +1421,7 @@ name as a prefix for generating final names of workflows, actions and triggers
included into the workbook. To illustrate this principle let's take a look at included into the workbook. To illustrate this principle let's take a look at
the figure below. the figure below.
.. image:: /img/Mistral_workbook_namespacing.png .. image:: /user/terminology/img/workbook_namespacing.png
So after a workbook has been uploaded its workflows and actions become So after a workbook has been uploaded its workflows and actions become
independent objects but with slightly different names. independent objects but with slightly different names.
@ -1585,10 +1585,6 @@ Workflow definition:
Task publish result (partial to keep the documentation short): Task publish result (partial to keep the documentation short):
.. warning::
The return value for each task execution hasn't been finalized and isn't
considered stable. It may change in a future Mistral release.
.. code-block:: json .. code-block:: json
{ {