14 Commits

Author SHA1 Message Date
Brad P. Crochet
f2d8b14ac1 Clarify usage of break-on and continue-on
Usage of break-on and continue-on are not very clear. This hopefully
gives some pointers on their usage.

Change-Id: Ide237a23ab85fac7342a8fc9bf748fd0b78bf41d
2018-03-15 08:29:27 -04:00
junboli
a2c1db4b14 Add doc8 rule and check doc/source files
doc8 is a linter for documents and used in openstack-manuals. It is better to enforce
document linters for simple checking. This change is to add doc8 in tox file and fix
line too long in some files.

The current rules are as bellow:
- invalid rst format - D000
- lines should not be longer than 79 characters - D001
- no trailing whitespace - D002
- no tabulation for indentation - D003
- no carriage returns (use unix newlines) - D004
- no newline at end of file - D005

Change-Id: Ibba3f0e1c3f724563deb27bbf4f13a8040799687
Closes-bug: #1709571
2017-08-09 16:50:33 +08:00
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
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
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
c07cf48a60 Changes made to comply with OpenStack writing style
The writing styles at few places were not in compliance with
the OpenStack writing style as mentioned in
http://docs.openstack.org/contributor-guide/writing-style
/general-writing-guidelines.html. This patch changes the heading
styles and adds a few other minor changes in the documents.

Change-Id: I0d90ba32ddcef0427b1dc4358206210f166e798a
Partial-Implements: blueprint mistral-doc
2016-10-04 20:06:15 +05:30
Miles Gould
f962038e5c Fix SPAG errors in Quickstart and Main Features docs
Change-Id: I1c7457a04845cc9116d2996733f111c1ac7eda21
2016-07-15 18:43:33 +01:00
Dougal Matthews
909241c642 Update Expiration Policy Documentation
This change re-writes the section covering the expiration policy to explain it
in more detail and also include the required evaluation_interval setting which
was previously undocumented.

Change-Id: Ib7f4e8ccf4c15cc6e22472b28004d0a9ad34497f
2016-07-01 15:06:49 +01:00
venkatamahesh
32b0121720 Fix the yaql github repository
Change-Id: I0a4320a3f2169ee75b1a9809f89c115878d05d20
Closes-Bug: #1581973
2016-05-15 21:35:39 +05:30
Jenkins
d2296b0890 Merge "Fixing "Task result / Data Flow" section of "Main Features" in docs" 2015-10-15 18:08:41 +00:00
Renat Akhmerov
66a4f85214 Fixing "Task result / Data Flow" section of "Main Features" in docs
Change-Id: I63881f13f0c517a9b50f90d387b6cfcaa7f03d52
Partial-Bug: #1504582
2015-10-14 17:48:33 +06:00
Renat Akhmerov
04ff532ae1 Fixing small issues in documentation
Change-Id: I07801f9093ea047c8b8a32d91f2afe20d01fa7fc
Partial-Bug: #1504582
2015-10-13 15:42:20 +06:00
Nikolay Mahotkin
174dd39807 Mistral documentation: main features
Implements blueprint mistral-docs-features

Change-Id: I26902db03b6db0b68491aa0c3374efebb8ce840a
2015-08-26 13:29:23 +00:00
Nikolay Mahotkin
f0d95d99ea Mistral documentation: Initial commit
* initial documentation skeleton for further writing.
 * Added man page to the conf (otherwise we get warning message)
 * Added ChangeLog to .gitignore
 * Changed html theme on readthedocs

Partially implements blueprint mistral-documentation

Change-Id: Iffc6e0e8b97d3599aa8c09b03011586354241abd
2015-08-07 12:06:53 +03:00