16 Commits

Author SHA1 Message Date
Renat Akhmerov
7423a58365 Explain better combinations of task names and engine commands in docs
Closes-Bug: #1682377
Change-Id: I6c53fc6b3debaf27b01a03b5180f3ef56ddf3e8f
2018-02-20 10:31:30 +02: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
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
Sharat Sharma
5d480e9a8b Admin guide landing page added
Added the admin guide in the mistral document index file as per
the doc-migration spec.

Change-Id: I821257f5be8b6778b1a6eaf9c138a06cef8b2792
Closes-Bug: #1706449
2017-07-26 10:16:56 +00:00
Sharat Sharma
5ab8ef1e3e Change the misplaced index links
The  Mistral Upgrade Guide and Mistral Workflow Language Specification
links were misplaced. Changed them. Also removed the unwanted admin
index page.

Change-Id: I49984971ee8ae10105291043ee3240133784fed2
Closes-Bug: #1705462
2017-07-20 17:28:24 +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
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
Sharat Sharma
912056dd8b Few changes related to the doc blueprint
1. * We need to either remove "Roadmap" from the index page completely
   and add it to some special article devoted to development or at least
   to move it to the end of the list
   (http://docs.openstack.org/developer/mistral/) - Done

2. * Article "Mistral Client / CLI guide" is messed up. Two problems:
   1) "Mistral Client" in this name is about installation which doesn't
   explicitly tell this (should be "Mistral Client Installation Guide")
   2) "CLI guide" is not about installation and should exist as a
   separate article. (http://docs.openstack.org/developer/mistral/) - Done

Change-Id: I9f2e7e24ce71e1c022b2918f455d805bab4740fe
Partial-Implements: blueprint mistral-doc
2016-11-11 11:36:23 +00:00
Anastasia Kuznetsova
3eae50d5cd [Docs] Add 'Cookbooks' page
Added new page "Cookbooks" which will contain links to
existing cookbooks which are published on wiki.

Change-Id: I9114e16e3afad3087c47513a04f6fa26de91ff28
2015-10-22 13:54:15 +03:00
Nikolay Mahotkin
8e610103a5 Minor changes to Mistral docs
* Removed incomplete 'how to write workflow' and link on it
 * Fixed showing extra titles in 'Installation' section on main page

Change-Id: Ib3f8061f05c30a7593af4716c6619604e9fd93ce
2015-09-14 14:23:59 +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
Dmitri Zimine
e328238c4c Add documentation - part 1
Setup structure and clean-up docs 

Coming up next: 

* TODO: migrate DSL specs from wiki
* TODO: setup autodocs to for REST v2

Change-Id: Ia15a65a2909bd71821c8a6e94b3f9470ee6145d5
2014-10-05 12:56:37 -07:00
Christian Berendt
f8a6018333 Cleaning up index.rst file
Removed notes about the generation of the file.

Change-Id: I7a2339d8ca83b19a19ca2abe6731d0ff4f37ca36
2014-07-21 08:29:54 +02:00
Angus Salkeld
a7bf5cecc7 Add autogenerated API documentation
Change-Id: I859be6d47d58fee13875d02a7839864348829687
2014-05-28 21:28:24 +10:00
Renat Akhmerov
04903b823e Add .gitreview, setup.py and other infrastructure.
* .gitreview
* Disutils files
* tox configuration
* add .venv to ignore
* "mistral" package
* Sphinx documentation skeleton

Change-Id: I1d9aa5105b0dbc458665e9b16fd84826a18a36bf
2013-11-01 02:57:27 +07:00