Adding information about the applicable releases, also
moves the community information to the front of the page similar
to the security guide and arch guide.
Change-Id: Ie89ef331a0192e9f81c4d5444e43556443277f1a
The openstackdocstheme requires now setting of bug_project, set it up
everywhere.
Change-Id: I778800b8944e3e1d89cdbd1f844c5830a94012d6
Depends-On: Ifd715d1d46d1b1796d79679c9e954d21e9d09455
With the new openstackdocstheme used, we can simplify conf.py.
Also, update our docs for it.
Note that Sphinx 1.6 needs latexmk for building, add it.
Sphinx 1.6 introduces a few new warnings, fix them so that the guides
built.
Change-Id: If2e431725eb54f8be79b9fa4bf9ede2089f321a5
In OpenStack HA guide, we used to configure 'rabbit_hosts' parameter
before Newton release. From Newton onwards, this parameter is
deprecated and now 'transport_url' parameter is being used. Updated
the same for shared messaging page.
Also, added a link for oslo messaging page for more details regarding
Transport URL.
Change-Id: Ie93b199b78d3fe16c01eb4346fb14adee443ccf7
Closes-Bug: #1687402
admin-guide and ha-guide updated to explicitly state
that content may not apply to EOL releases Kilo and Liberty.
Also applies to Security Guide and hence will fix it in the
ossp-security-documentation project.
Change-Id: I9d4711f853004193f9aeea3f64b6081e0efeb5b2
Partial-Bug: #1691058
This makes it clearer how to find the open TODO items for the HA
guide, which in turn will increase the chances of people helping out
with the HA guide.
Change-Id: Ie913c4f97250d5ed481961969855a70080bb363f
Signed-off-by: Adam Spiers <aspiers@suse.com>
Move glossary and appendix in one chapter called appendix.
This has been done already for arch-design and ops-guide, do it for the
other guides. Share common appendix.
Change-Id: I6bf4e94f6c0569850cca6558be672de298bb208c
This commit applies theme and styling to PDF generation
using xelatex with customized styles.
In openstackdocstheme, style is defined in pdftheme.sty,
and conf.py makes use of the file as LaTeX package.
Also, some rst files are modified to add PDF directives
to adjust better UI in PDFs.
Not all documents are our targets in this commit but feel
free to add more here if anyone wants.
- Current applied styles with openstackdocstheme
: Dedicated title without a blank page
: Put a logo image into suitable place.
: No chapter/section number
: Light gray background for code blocks
: Font definition is in openstackdocstheme not in conf.py
- rst modification
: Table wrap adjustment (".. tabularcolumns::" directive)
: Exclude "Search in this page" section (".. only:: html" directive)
Change-Id: I2782e0a1f0258a6016559b16c8967cc52f48f734
Depends-On: I423675ff79827966e789df70b0f970ac2a10da50
Implements: blueprint build-pdf-from-rst-guides
Co-Authored-By: Ian Y. Choi <ianyrchoi@gmail.com>
Version numbers will be used in PDFs such as
"Release Version: 15.0" following short X.Y version.
Note that Ocata is 15th release.
Change-Id: I6a11992e819626f3b4f4360222521795f7e3b74d
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.
Remove all-files, we do not have man pages.
Note that the build_sphinx section is not used by our toolchain, still
doesn't harm to use proper setup so that it could be used.
Change-Id: I03403b1ed20c4a4bccb1c03311d3999e12a98416
- ha notes are redundant to ha-guide
- move meter definition section under notifications as that's what
it relates to
- move the configuration of standard meters to install guide.
Change-Id: Ib09dea06c609e3611a8a9d20d5f3a1c8f757a547
- publishers are currently shown on collection and retrieval pages
but is really related to pipeline. move it all to pipeline page and
remove from other places.
- pipeline doesn't do collection so drop the polling stuff because that's
not part of pipeline.
- fix headings to make each transformers and publisher under general
'Transformer' and 'Publisher' section
- put rate of change transformer under it's own section similar to others
- put deprecated publishers in own section for easier removal and to make
deprecation more obvious.
Change-Id: I2b2c2021a346062e4525bbb53bff4b8e528211c2