Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Disable openstackdocs_auto_name to use 'project' variable as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
Remove python 3 versioning from lower-constraints and
requirements to pass requirements-check.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: Id478711abb1783422ebb4ee9937d1b7202fdf2f3
* This patch also adds handling for iterators in the sanitizing
function for YAQL results. JSON serialization for iterators now
works correctly but the issue is that they can be used only once.
So, for example, if we got a result from YAQL and performed JSON
serialization for it, then the iterator is already empty and
the data structure is just corrupted. So we can't further pass
to executors and other subsystems. The solution is just to sanitize
iterators after they're just returned from YAQL.
* Added a test to make sure that action input reaches an executor
not corrupted, although it gets saved into DB and hence serialized
into JSON.
* Changed the Sphinx entry in requirements.txt so that the version
3.0.0 is now excluded (it breaks the build).
Closes-Bug: #1871567
Change-Id: I47abe0904b49d72e33eb10080c71fb81980d44da
Removed dupliocated Mistral overviews and merged content into description on
index page.
Change-Id: Ia7c260494a8a659988db2329bf3504be9b4b67fa
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
* Some ".. image:" RST directives changed to ".. figure:" where
it's more suitable.
* All images moved to subfolder where they're used
* Fixed indentation in the Workflow Language specification
* Other minor changes in docs
Change-Id: If2f206a5191d1eecdcf95e1f7b44a87968432876
* Since Mistral Wiki has been retired we need to move all important
info published there into the docs residing in the project repo.
This patch moves the article published at
https://wiki.openstack.org/wiki/Mistral/Cookbooks/AdministrationCloudCron
to the docs.
Change-Id: I4764fb3beba1ff05091a4ce04c93fe56d39528d5
Partial-Bug: #1779318
* Grouped documentation articles into several main parts: user docs,
admin docs, developer docs.
* Changed the index page so that it contains links to the index pages
of the main documentation parts like user docs, admin docs etc.
* Fixed all the broken links
* Removed index generation since it's not informative at all in its
current form and it exposes code internals (REST controller class
names)
* Removed obsolete properties that are no longer used by the
"openstackdocstheme" project
* Removed obsolete static html files
* Moved part of the images to the folders where they are used
Further work:
* Refactor main chapters (user, admin, developer) one by one and
make them look consistent. For example, there are several pages
that provide similar kind of information: overview, quick start,
main features etc. It is a mess that's been accumulated throughout
the last 4-5 years.
* Fill the gaps. Add all missing pages like: event notifications,
workflow environment, etc.
* Move cookbooks from Wiki to this doc.
Partially implements: blueprint mistral-restructure-docs
Change-Id: Ia722a6885ad2fb97d63a34285b0a5b1a23da79e8
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.
[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045
Change-Id: Ife98c47af59355540fa30d7ca762f857759c1274
The task_execution_id is required to be able to restore the hierarchy
of tasks and workflows on the notification receiver side. Also, including
the event in the notification is very useful.
Also fix the documentation as multiline strings are not supported in
ini files.
Change-Id: I714fd5c32b0f31f85ac5a4d22d161e662bf18687
Fail-on policy allows to fail success tasks by condition. It is useful
in cases we have to fail task if its result is unacceptable and it makes
workflow definition more readable.
Change-Id: I57b4f3d1533982d3b9b7063925f8d70f044aefea
Implements: blueprint fail-on-policy
Signed-off-by: Oleg Ovcharuk <vgvoleg@gmail.com>
Some minor updates including fixing issues with the HTML5 output
generated by Sphinx 2.0, inlining the OpenStack logo rather than
referencing it from elsewhere, and adding a new SOURCE_DATE_EPOCH option
for use in reproducible builds in new release openstackdocstheme 1.30.0.
...to pick up many improvements, including the return of table borders.
Change-Id: I22b652e1eb007616e697cb238fcd9e5f010cd693
NetworkX released 2.3, dropping support for Python 2.
https://github.com/networkx/networkx/blob/master/doc/news.rst
Also see I0a9700926c9a0db93e782c853c33f1aaee3d4876
fixed sphinx requirements also according to global requirements
jsonschema should be uncaped also according to global requirements
but there are conflicts with zakarclient designateclient and irconicclient
so for now I put it in remark
Change-Id: Iea3dbcfa1f6ddf2c413ede5e73fa076c6edccfdf
A not obvious point for users is the task does not retry after a
timeout is triggered. Added clarification in the retry section.
The documentation contains enough example with Jinja usage. Improved
only the create_vm workflow definition.
Added global publishing to the doc. It is brash copy-paste from
https://specs.openstack.org/openstack/mistral-specs/specs/pike/approved/advanced_publishing.html without mention of atomic publish.
Move Docker guides to the installation section.
Change-Id: I149b2e1dff7f86bd356f4dd2f758659469e6a4a8
Closes-Bug: #1789384
Closes-Bug: #1690156
Closes-Bug: #1779244
Signed-off-by: Vitalii Solodilov <mcdkr@yandex.ru>
Reply to address is useful when sending email from an unmonitored email
address and to give user a place to respond in order to contact us.
Add Reply-to as described in section 3.6.2 of RFC5222
https://tools.ietf.org/html/rfc5322#section-3.6.2
Change-Id: Ib6b2bdc130e4f9e5170eb88760d69c3e08d2a1c7
keystone_authtoken/auth_uri is deprecated [1]. Use www_authenticate_uri
instead.
keystonemiddleware in requirements and lower constraints should be increased
because www_authenticate_uri was introduced in keystonemiddleware 4.18.0.
[1] https://review.openstack.org/#/c/508522/
Change-Id: I99b0ee941d702a28fb4f392d9747d0e2257a42c8
Closes-Bug: #1788174