Usage of break-on and continue-on are not very clear. This hopefully
gives some pointers on their usage.
Change-Id: Ide237a23ab85fac7342a8fc9bf748fd0b78bf41d
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
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
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
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
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
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
* 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