205 Commits

Author SHA1 Message Date
Zuul
d5dfa2e242 Merge "Fix error sql about privileges in doc" 2018-02-12 11:03:36 +00:00
pengdake
79d1f87980 Update mysql connection in doc
Change-Id: If7f5eea5f87ada7c6bc4783b04e9a792bb5cd6f3
2018-02-02 02:31:13 +08:00
Zuul
e6a7ba2af4 Merge "Fix docs to better reflect Jinja and YAQL usage" 2018-02-05 09:37:29 +00:00
pengdake
0ca36b2819 Fix error sql about privileges in doc
Change-Id: I4893e1415a6e0820900353270b62e20279d5bf1c
2018-02-02 00:29:00 +08:00
Zuul
93ec9fbbe8 Merge "Modify error spelling word" 2018-01-31 12:24:43 +00:00
Zuul
fb3c6f9d4a Merge "Use the latest policy-json-file reference" 2018-01-31 12:10:43 +00: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
hardikj
cbb7179dbd Fix std.http action doc
Add missing input parameter 'verify'
to std.http action in dsl documentation

Change-Id: I3198012e3e2336b0febcf0b36dff528a49f74a31
2018-01-23 12:20:17 +05:30
wudong
68825bdb57 Modify error spelling word
Change-Id: If3cec149b9faafc67194b193c4d1de2d93c467ba
2018-01-19 00:36:43 +00:00
Zuul
989f5c95dc Merge "fix syntax error the 'that' can not be ignore" 2018-01-18 11:34:07 +00:00
MaoyangLiu
670150f6fb fix syntax error the 'that' can not be ignore
Change-Id: Ie51ad7ee0c0b052e715e69130797713860639b70
2018-01-18 17:25:49 +08:00
pengdake
94ef4e2b12 Fix the error url
Change-Id: I9c6bf111c7d4a7b1234c6b54b2555df4392bfb02
2018-01-12 20:29:12 +08:00
Adriano Petrich
ad733d3112 Add executions yaql filter
This allows for filtering or executions

Implements: blueprint mistral-workflow-executions-yaql-function
Change-Id: I8d41c662d8659375750b52f7510e9a35f8b42f93
2017-12-20 13:34:33 +00:00
junboli
fc3fdc1081 Use the latest policy-json-file reference
Deprecated the ocata policy-json-file reference, use the latest
instead.

Change-Id: I1c609ebc2e8a6fd011463e31baca0d75a3ebf998
2017-12-11 23:50:20 +08:00
Hieu LE
60d1627650 Implement policy in code - docs and reno (end)
This commit adds docs and reno for migrating policies
into code [1].

Like oslo.config, with oslo.policy, we can define all of
default rules in code base and only change some rules
via policy file. Another thing that we should use yaml
format instead of json format.

[1] https://governance.openstack.org/tc/goals/queens/policy-in-code.html
Co-authored-By: Dai Dang-Van <daidv@vn.fujitsu.com>

Change-Id: I67984292022e2a92306b268a40861cff625c22c9
2017-11-27 02:47:56 +00:00
Adriano Petrich
3ce34674cf Dynamic action name evaluation.
Evaluate action names dynamically, so yaql or jinja expression can be
used

Change-Id: I48761c215f0255976c330ffa34f27bb695c944a9
Implements: blueprint mistral-dynamic-actions
2017-10-05 03:30:59 +00:00
junboli
76bafad3ec TrivialFix: pretty format the json code block
In the file doc/source/user/dsl_v2.rst, the json format of
task publish result is not well formated, this change is to
pretty format the json code block

Change-Id: I783472c1d7c13cd7b6a464325cf7213abf3ac359
2017-09-15 01:35:33 +00:00
Istvan Imre
ff78d7f659 Dynamic workflow name evaluation.
Evaluate workflow names dynamically, so yaql or jinja expression
is allowed as sub-workflow name. Tasks names are not yet
dynamically evaluated.

Partially implements: blueprint mistral-dynamic-actions

Change-Id: Icfe591e27a4f45c2e3dcfa83512217f3b2122189
2017-08-16 13:17:10 +02:00
Jenkins
134fb8c5c9 Merge "Add doc8 rule and check doc/source files" 2017-08-10 21:06:08 +00:00
Jenkins
77bae03e88 Merge "Move dsl_v2 document to user guide" 2017-08-10 21:05:52 +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
liuyamin
827aca56e1 TrivialFix: Fix typo
Change-Id: I5cc1ba791f4b8508af521adfa0493c8caff85731
2017-08-08 16:14:10 +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
junboli
1539bfad76 TrivialFix: Fix typo
Change-Id: I185843cacbb4626841a74f6577c467910adf6830
2017-07-31 18:57:22 +08:00
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
Jenkins
281668a000 Merge "Change the misplaced index links" 2017-07-25 10:01:07 +00:00
Jenkins
a7357a7492 Merge "Remove note for nested ad-hoc actions" 2017-07-24 15:23:13 +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
Sharat Sharma
bf4073a313 Remove note for nested ad-hoc actions
There is a note saying that nested ad-hoc actions are not supported.
https://review.openstack.org/#/c/334312/ has added this feature.

Change-Id: Ieb17560e57d622507d09c86311014b583d1a4d3a
Closes-Bug: #1705183
2017-07-20 10:39:47 +05:30
Hangdong Zhang
060d400d30 Update and optimize documentation links
1. Update URLs according to document migration
2. Update the dead and outdated links

Change-Id: I9dd7b1ae7fb9fcb0af1e22f789ffa89138649862
2017-07-19 17:10:49 +08:00
Jenkins
0acef68c72 Merge "Update reference link to Ocata" 2017-07-15 14:56:49 +00:00
junboli
f71aa42cf5 Update reference link to Ocata
In the file doc/source/configuration/index.rst, update the
reference link of policy.json from Mitaka to newest Ocata.

Closes-Bug: #1704081
Change-Id: I25d8a5e8e35cb2ad90bbc42734e4cd4aeac2ac13
2017-07-13 08:14:28 +00:00
csatari
6c362ce53e Adding warning-is-error to doc building
As it is required in [1] warning-is-error should be
set for doc building. This change sets the flag and
corrects the warnings.

[1]: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: Ia93fd13645830cd8994ef283b72f31cb22cf3fe9
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: csatari <gergely.csatari@nokia.com>
2017-07-13 10:11:15 +02:00
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
532bfaf600 Switch from oslosphinx to openstackdocstheme
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.

[0]https://review.openstack.org/#/c/472275/

Change-Id: Ic0686fc1f1128d52c2ffb195d3cedb30de6f9c73
2017-07-05 05:10:00 +00:00
Sharat Sharma
6e1e2d568b Update the contents of configuration guide
Contents on the configuration guide page is out-of-date. This patch
updates the contents.

Change-Id: I8f951380739924e52ba257f176115916738ee9bf
Closes-Bug: #1697139
2017-06-06 08:16:08 +05:30
Jenkins
4813542ab6 Merge "Remove the deprecated configuration options" 2017-06-13 11:04:13 +00:00
Van Hung Pham
10c70b707d Optimize the link address
Update link address to ensure safety and preciseness

Change-Id: Ia5da7111faceee5ecfb39f093ed2afee6902776b
2017-06-10 01:23:58 +07:00
Sharat Sharma
1a97344381 Remove the deprecated configuration options
The configuration guide still mentions few deprecated config
options like rabbit_userid, rabbit_host, rabbit_password and
rpc_backend which are deprecated. They are replaced by the
transport_url option.

Change-Id: Iec8ce5c857c4bc0d3f7729d6b71de77cf0addc03
Bug-Id: #1695857
2017-06-05 18:12:45 +05:30
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
Jenkins
a43502de1e Merge "Fixing indentation in docs" 2017-06-05 06:14:13 +00:00
Renat Akhmerov
35db34c257 Remove 'sphinxcontrib.autohttp.flask' from sphinx config
* After updating Sphinx to 1.6.2 Sphinx this extension got broken
  and our Mistral "doc" CI job too
* We don't use Flask in the project anyway

Change-Id: I051ec26e155344684b69bad6a50f2162febbc928
2017-06-02 13:32:52 +07:00
Michal Gershenzon
7f03d9fa60 Fixing indentation in docs
One example has bad indentation.

Change-Id: I52dbbe714ba8fc56f25350d937a8925e1cfe1357
2017-05-30 10:48:54 +00:00
Sharat Sharma
daf75c2852 Fix doc generation for python 3
The html_last_updated_fmt option is interpeted as a byte string in
python3, make it utf-8 string.

Change-Id: I7ba038ea1bca354681f973d68c06eb3c4bfa6e29
2017-05-23 14:38:54 +00:00
Boris Bobrov
074a04ad6d Change service name to workflowv2 in docs
Today we use workflowv2 instead of workflow. Clients and puppets expect
it.

Change-Id: Id2994db9bbb2b1440bd9c92706dbd1ff6616569b
Closes-Bug: 1688219
2017-05-05 11:11:54 +00:00
Jenkins
672fb9e88f Merge "Fix the doc for 'concurrency' policy" 2017-04-19 11:32:05 +00:00
Jenkins
d098c63505 Merge "Disable pbrs auto python-api generation" 2017-04-14 11:08:57 +00:00
Jenkins
8778de310a Merge "Add documentation for the engine commands" 2017-04-13 14:00:22 +00:00
Renat Akhmerov
4ef619961f Fix the doc for 'concurrency' policy
Change-Id: I489345a057743603f84b1debd2fd3cbab5b1cecf
Closes-Bug: #1671803
2017-04-13 16:12:53 +07:00
Dougal Matthews
0ad8cdd65c Add documentation for the engine commands
Change-Id: I857e825ab5529e23337ee9f8739dd0bb80b3e7bb
2017-04-13 08:55:17 +01:00