18 Commits

Author SHA1 Message Date
pengdake
acbbeac61c Fix doc format
We need make a little changes to let
https://docs.openstack.org/mistral/latest/terminology/index.html
look more suitable.

Change-Id: Iaabb95e7c0c8064ab8cc69e68041fb10f170eea1
2018-02-26 21:54:03 +08:00
Renat Akhmerov
57e6936d6c Fix docs to better reflect Jinja and YAQL usage
Closes-Bug: #1641174
Change-Id: I6e2a10932c648836a1e0632b4cd0fce3ab78f946
2018-01-31 17:27:09 +07:00
Jenkins
134fb8c5c9 Merge "Add doc8 rule and check doc/source files" 2017-08-10 21:06:08 +00: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
4a64ae1bb5 Move dsl_v2 document to user guide
Also added a note for to indicate std.js as the alias for
std.javascript.

Change-Id: I20cd94d0423c1b97f8ec83973aabbb7ecee75b49
2017-08-07 16:10:04 +05:30
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
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
Dougal Matthews
24405a4f99 Update the wording in the actions terminology docs
This patch rewords the action terminology to improve the readability.

Change-Id: I5bdb6c1ab9b10d2dc6ad19a335c04048cf01a89e
2016-12-08 10:08:22 +00:00
fengchaoyang
769c3fea73 Fix two errors in YAML example and a error in action doc
Errors list:
1. "on-complete" is incorrectly written as "on_complete".
2. Use ":" will raise "ERROR (app) Definition could not be parsed: mapping values are not allowed here".
3. Action note description is out of frame.

Change-Id: I7f4e8c7755f11a1f0a040f14481e5f7374a1d87f
2016-12-06 16:31:35 +08:00
Sharat Sharma
26f5658c44 Small changes to docs to comply with openstack document style
Change-Id: I65608499eb5793f7bdbaaf529def7bb934fc4d05
2016-11-30 11:16:49 +00:00
Márton Csuha
bb92ee905e Fix documentation
Remove reference to AMQP messaging action as it doesn't exist.

Change-Id: I84801ec5f25857c1537b6e0688e2c28c345da3ca
Signed-off-by: Márton Csuha <marton.csuha@nokia.com>
2016-08-23 13:29:00 +02:00
Renat Akhmerov
cf0cc484bc Add asynchronous actions doc
Change-Id: Idef3fed51099875d2200b1a29af152be23a0215f
Implements: blueprint mistral-async-actions-doc
2016-03-02 17:08:56 +06:00
Renat Akhmerov
bec6fc0cd3 Fixing terminoloty/actions section in documentation
* Changed the order of description for synchronous and asynchronous
  actions according to the attached picture.
* Shortened text lines to fit 80 characters limit.

Change-Id: I1e6810816cb3490f9347bc6a85b59af4e5e467ca
2015-10-14 17:33:00 +06:00
Lingxian Kong
b0cc7a4830 Renaming state DELAYED to RUNNING_DELAYED in doc
Please refer to https://review.openstack.org/#/c/227728/

Change-Id: Iafe9e9949eb36a0df591e57ea3fae3d91634263a
Related-Bug: #1470369
2015-09-28 16:27:32 +08:00
Nikolay Mahotkin
6288bf2ec0 Mistral terminology: cron-triggers and actions
Implements blueprint: mistral-docs-terminology

Change-Id: I56e45122fdbeddf0dfa79a1904a8fd646d03d7ad
2015-09-08 16:51:54 +03:00
Nikolay Mahotkin
0ec07768c4 Mistral docs terminology: executions
Partially implements: blueprint mistral-docs-terminology

Change-Id: Iab9187286cad1d2f591c281d022f9e90a543bfbc
2015-09-08 11:30:10 +03:00
Nikolay Mahotkin
e6f2b3f0d2 Mistral docs terminology: workbooks and workflows
* Fixed workbook namespacing image (deleted triggers)

Partially implements: blueprint mistral-docs-terminology

Change-Id: I008afe34abf916a23401f81de38fddb4e5f7622f
2015-09-02 08:54:23 +03: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