* 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
Add documentation on the notifier architecture and configuration
of the event publishers.
Co-Authored-By: Dougal Matthews <dougal@redhat.com>
Change-Id: I5e7d8ac81225cfe4082a827a52447f95dd4789a0
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
* Article "Architecture" is too small. It makes sense to add more
information. - Added some more information
* I think we need to change "How to write an Action Plugin" to just
"How to write a custom action". I think the word "plugin" here is
not important from user perspective - Done
* I think we need to change "How to extend YAQL with a new function"
to "How to write a custom YAQL function" and put it right next to
"How to write a custom action". That would be more consistent.
- Done
Change-Id: I9b43694072cb23271e33440741204da3e10b89ac
Partial-Implements: blueprint mistral-doc
The writing styles at few places were not in compliance with
the OpenStack writing style as mentioned in
http://docs.openstack.org/contributor-guide/writing-style
/general-writing-guidelines.html. This patch changes the heading
styles and adds a few other minor changes in the documents.
Change-Id: I0d90ba32ddcef0427b1dc4358206210f166e798a
Partial-Implements: blueprint mistral-doc
* 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
Renat Akhmerov