174 Commits

Author SHA1 Message Date
Jenkins
0acef68c72 Merge "Update reference link to Ocata" 2017-07-15 14:56:49 +00:00
junboli
f71aa42cf5 Update reference link to Ocata
In the file doc/source/configuration/index.rst, update the
reference link of policy.json from Mitaka to newest Ocata.

Closes-Bug: #1704081
Change-Id: I25d8a5e8e35cb2ad90bbc42734e4cd4aeac2ac13
2017-07-13 08:14:28 +00:00
csatari
6c362ce53e Adding warning-is-error to doc building
As it is required in [1] warning-is-error should be
set for doc building. This change sets the flag and
corrects the warnings.

[1]: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: Ia93fd13645830cd8994ef283b72f31cb22cf3fe9
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: csatari <gergely.csatari@nokia.com>
2017-07-13 10:11:15 +02:00
csatari
a7cd611c78 Applying Pike document structure
This change aligns the Mistral documents folder structure to
the one specified for Pike [1].
Documents were move to thir appropriate folder, but the different
guides do not follow their cookie cutted structure yet.
Install guide is in a separate change [2], while I could not
found the cookie cutter for the rest of the guides.

test-requirements.txt updated with the missing modules.

tox_install.sh modified to do not pass $MODULE_NAME and -e parameter to
edit-constraints.

[1]: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
[2]: https://review.openstack.org/#/c/476499/
[3]: https://etherpad.openstack.org/p/doc-migration-tracking

Change-Id: Ia1101fa2eada446d8eebfefa9bd15d8facd8b3b0
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: csatari <gergely.csatari@nokia.com>
2017-07-11 09:24:17 +02:00
Sharat Sharma
532bfaf600 Switch from oslosphinx to openstackdocstheme
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.

[0]https://review.openstack.org/#/c/472275/

Change-Id: Ic0686fc1f1128d52c2ffb195d3cedb30de6f9c73
2017-07-05 05:10:00 +00:00
Sharat Sharma
6e1e2d568b Update the contents of configuration guide
Contents on the configuration guide page is out-of-date. This patch
updates the contents.

Change-Id: I8f951380739924e52ba257f176115916738ee9bf
Closes-Bug: #1697139
2017-06-06 08:16:08 +05:30
Jenkins
4813542ab6 Merge "Remove the deprecated configuration options" 2017-06-13 11:04:13 +00:00
Van Hung Pham
10c70b707d Optimize the link address
Update link address to ensure safety and preciseness

Change-Id: Ia5da7111faceee5ecfb39f093ed2afee6902776b
2017-06-10 01:23:58 +07:00
Sharat Sharma
1a97344381 Remove the deprecated configuration options
The configuration guide still mentions few deprecated config
options like rabbit_userid, rabbit_host, rabbit_password and
rpc_backend which are deprecated. They are replaced by the
transport_url option.

Change-Id: Iec8ce5c857c4bc0d3f7729d6b71de77cf0addc03
Bug-Id: #1695857
2017-06-05 18:12:45 +05:30
Sharat Sharma
1e20b04c87 Stop using abbreviation DSL in document
Sometimes people get confused when DSL is used. So, to overcome it
Mistral Workflow Language is used instead of DSL throughout the
documentation.

Change-Id: Ic7516b4f45854fd9960cef3e529dcb507439f8e6
Partially-implements: blueprint add-documentation
2017-06-05 17:03:43 +05:30
Jenkins
a43502de1e Merge "Fixing indentation in docs" 2017-06-05 06:14:13 +00:00
Renat Akhmerov
35db34c257 Remove 'sphinxcontrib.autohttp.flask' from sphinx config
* After updating Sphinx to 1.6.2 Sphinx this extension got broken
  and our Mistral "doc" CI job too
* We don't use Flask in the project anyway

Change-Id: I051ec26e155344684b69bad6a50f2162febbc928
2017-06-02 13:32:52 +07:00
Michal Gershenzon
7f03d9fa60 Fixing indentation in docs
One example has bad indentation.

Change-Id: I52dbbe714ba8fc56f25350d937a8925e1cfe1357
2017-05-30 10:48:54 +00:00
Sharat Sharma
daf75c2852 Fix doc generation for python 3
The html_last_updated_fmt option is interpeted as a byte string in
python3, make it utf-8 string.

Change-Id: I7ba038ea1bca354681f973d68c06eb3c4bfa6e29
2017-05-23 14:38:54 +00:00
Boris Bobrov
074a04ad6d Change service name to workflowv2 in docs
Today we use workflowv2 instead of workflow. Clients and puppets expect
it.

Change-Id: Id2994db9bbb2b1440bd9c92706dbd1ff6616569b
Closes-Bug: 1688219
2017-05-05 11:11:54 +00:00
Jenkins
672fb9e88f Merge "Fix the doc for 'concurrency' policy" 2017-04-19 11:32:05 +00:00
Jenkins
d098c63505 Merge "Disable pbrs auto python-api generation" 2017-04-14 11:08:57 +00:00
Jenkins
8778de310a Merge "Add documentation for the engine commands" 2017-04-13 14:00:22 +00:00
Renat Akhmerov
4ef619961f Fix the doc for 'concurrency' policy
Change-Id: I489345a057743603f84b1debd2fd3cbab5b1cecf
Closes-Bug: #1671803
2017-04-13 16:12:53 +07:00
Dougal Matthews
0ad8cdd65c Add documentation for the engine commands
Change-Id: I857e825ab5529e23337ee9f8739dd0bb80b3e7bb
2017-04-13 08:55:17 +01:00
Sharat Sharma
589b8e851f Changed the README.rst and added debug guide
* There was too much of information in the README.rst which was
  redundant. So, added some useful links in the file and removed
  redundant information.

* Added the debug_guide which provides some brief information
  about the debugging of mistral.

Change-Id: I9d3505864bec6b7ae4e4b2c386a98fd5a808564a
Partial-Implements: blueprint mistral-doc
Implements: blueprint mistral-docs-troubleshooting
2017-04-12 10:32:28 +00:00
Dougal Matthews
2553b2be1a Disable pbrs auto python-api generation
Mistral is a service, without a public Python API (other than the
actions api which is being moved out). Therefore including the Python
code in the documentation isn't useful. While it is present, it often
comes up in search results which will be confusing for most users.

Change-Id: Ib9d5e1a7baecf70d8e224cff470f968012317edd
2017-04-11 16:18:21 +01:00
Jenkins
001c8b1c4e Merge "Limit the number of finished executions." 2017-04-11 05:24:46 +00:00
Jenkins
bc397ca56c Merge "Use the Mistral syntax highlighting on the dsl v2 page" 2017-04-11 03:23:30 +00:00
Jenkins
f51d2d8459 Merge "Remove the empty using_yaql gude" 2017-04-11 02:25:38 +00:00
Jenkins
b041dec8c2 Merge "Use the plain syntax highlighting in the webapi example" 2017-04-11 02:25:33 +00:00
Jenkins
12fe3346e3 Merge "Remove the highlighting choice 'HTTP'" 2017-04-11 02:25:20 +00:00
Kupai József
4e3e19bfb3 Limit the number of finished executions.
A new option was intorduced to execution_expiration_policy to limit
the amount of finished and not expired executions. This can be used
to keep the number of finished executions under a limit, even if a
huge number of executions are created in a short period of time.

Change-Id: I05a604285a6fc510dd224613215dac8d2c31c541
Related-Bug: #1658946
2017-04-10 14:38:04 +02:00
Dougal Matthews
3ad596ce57 Rework the CLI Guide
The previous version contained badly formatted reStructuredText which
caused rendering issues. It also contained the help output for commands,
but it wasn't updated or complete.

This new document tells used how to view and use the CLI so they can get
the help output easily themselves. This removes the rendering issues and
the need to keep this page updated.

Change-Id: Ic97185035ef22a9d6d291b9f396488139e8a7e2d
2017-04-06 15:25:38 +01:00
Dougal Matthews
9776bbfae4 Use the Mistral syntax highlighting on the dsl v2 page
The examples in this page hit some limitations with the lexer, so it was
updated to handle the unknown tokens and better handle unicode
whitespace characters.

Change-Id: I7883072844ae99bedb8a4c080572da5a31590dd5
2017-04-06 10:20:34 +01:00
Dougal Matthews
eaf6d80a05 Remove the empty using_yaql gude
The YAQL documentation has greatly improved recently, we should just
reference that rather than starting our own documentation for YAQL.

We may want to include some Mistral specific examples, if we do, we can
re-add this file when needed. Having a file that isn't included in the
documentation tree causes Sphinx to show a warning.

Change-Id: Id7d054697038be5a2e1c03854a8e8f7259e8a7e6
2017-04-05 10:22:14 +01:00
Dougal Matthews
83711c6aea Use the plain syntax highlighting in the webapi example
The current example fails highlighting and is skipped because the YAML
lexer rejects it as invalid. This causes a warning to be displayed.

Change-Id: I86c4570fd1f422651a4711417410e7c7b7515637
2017-04-05 10:20:06 +01:00
Dougal Matthews
29f624d4cd Remove the highlighting choice 'HTTP'
This isn't valid and causes the following error:

    mistral/mistral/doc/source/developer/asynchronous_actions.rst:134:
    WARNING: Could not lex literal_block as "HTTP". Highlighting skipped.

Change-Id: Ibd0ce0a52f623ef8b48eefcfaa7c40e8d70c6d0a
2017-04-05 10:19:21 +01:00
Dougal Matthews
679fe7bbef Add a Mistral lexer for pygments
This allows us to use the following code blocks in the Mistral documentation.

    .. code-block:: mistral

When we do that the code will then be highlighted in a way specific to
Mistral, rather than the generic YAML highlighting or none.

Change-Id: Ie25725b9f803e247d23f58c4b602be938c75cfbd
2017-04-05 10:17:58 +01:00
Sharat Sharma
6973f75d60 [doc] Changed the output fields in quickstart guide
As there are few more fields added to the client and the document
was not updated, this commit updates the output of each command
accordingly.

Change-Id: Ie5c87b269a58c79bf37c7a93b79d6068352b79bd
Closes-Bug: #1670329
2017-03-06 17:48:07 +05:30
Jenkins
d6168c9572 Merge "Update docs for tasks function" 2017-03-03 11:49:49 +00:00
Michal Gershenzon
77084f7de1 Update docs for tasks function
tasks function can be used to get all tasks in state error
of a given workflow execution and more.

Change-Id: I64e101bf36e0d865342e848723b610bfe23423d9
2017-03-02 16:32:08 +00:00
Jenkins
24ff5ed80e Merge "Fix doc build if git is absent" 2017-02-16 06:55:43 +00:00
Jenkins
474a29a5e3 Merge "Add Keycloak authentication doc for client side" 2017-02-15 11:10:17 +00:00
Jenkins
35f2504153 Merge "Add details into docs about semantics of 'on-XXX' clauses." 2017-02-14 13:51:30 +00:00
Renat Akhmerov
ef35090623 Add Keycloak authentication doc for client side
Change-Id: I5b9fc42f7a19492af0dea7d3d6012c67ffaf0780
Implements: blueprint mistral-keycloak-auth-docs
2017-02-14 11:48:05 +00:00
Renat Akhmerov
c82166329b Add details into docs about semantics of 'on-XXX' clauses.
Change-Id: I003b7940ed8e2eee9d7dbd61261a6585964df029
Closes-Bug: #1642908
2017-02-14 17:05:54 +07:00
Renat Akhmerov
f786da42b2 Add Keycloak authentication doc for server side
TODO:
* Add info into client side auth section

Partially implements: blueprint mistral-keycloak-auth-docs

Change-Id: I930d5773ca2607bbe99fb22a17c39eda94ca34d5
2017-02-14 16:31:42 +07:00
Sharat Sharma
3d6184e51a Fix doc build if git is absent
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.

Change-Id: I9a6aba18d40877f24c31d0b44cae4aca4b064655
Closes-Bug: #1552251
2017-01-31 17:18:36 +05:30
Rajiv Kumar
285beb6f84 Removed unnecessary utf-8 encoding
Change-Id: Ic2ac9598e1098a9b75172af0cab1db31bc2cf9e7
2017-01-11 02:58:04 +00:00
Sharat Sharma
581f6a1458 Fix doc for missing dashboard config file
_50_mistral.py.example does not exist in current
mistral-dashboard-master.tar.gz. So, _50_mistral.py file has to
be moved into enabled folder.

Change-Id: I89a2f25d0b64f71dc5733af3df963e3f950b81c7
Depends-on: Ie1415ea66ed6608ecff622c42e3a433be23bbdfe
2016-12-22 07:46:50 +00:00
tengqm
83e2431b35 Fix configuration generator
The current behavior of 'genconfig' is writing file
'mistral.conf.sample' directly to the '/etc/mistral' directory. This has
two problems: the /etc/mistral directory may and may not exist; we are
supposed to write a usable configuration file into the '/etc/mistral'
directory instead of a sample file.

This patch redirects the output path to the local 'etc' subdirectory.
Developers/users can then tune and install the configuration file based
on the sample.

Change-Id: I0c75ab9ffc9960ba12ce6f5d725c0c7bb78ef238
2016-12-19 07:12:41 -05:00
Jenkins
3be004e523 Merge "Minor changes in the document" 2016-12-18 16:07:31 +00:00
Jenkins
c9bbe55355 Merge "Update the wording in the actions terminology docs" 2016-12-14 07:43:58 +00:00
Sharat Sharma
8f7153f6e9 Minor changes in the document
Small changes to document to comply with the openstack document
style and a minor gramatical correction.

Change-Id: Icf1412b5957e00347e13aed9b9685d42539de30f
Partial-Implements: blueprint mistral-doc
2016-12-11 00:58:14 +05:30