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
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>
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
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
Remove reference to AMQP messaging action as it doesn't exist.
Change-Id: I84801ec5f25857c1537b6e0688e2c28c345da3ca
Signed-off-by: Márton Csuha <marton.csuha@nokia.com>
* 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
* 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