Reference the new list of Project Install Guides.
Update preface to make it clear the guide is multi-version.
Remove mention of non-existing debconf Install Guide.
Change-Id: I0619cb68854106191d050afa0bfac06d3b6bc12e
The PDF build does not include content multiple times if the same file
is included in a toctree more than once. That means we need to
restructure the guide to handle the common parts differently. This
approach merges some of the previously split sections back together
using inline prose to indicate where minor variations apply for
different operating systems but retaining separate files for cases where
the differences are significant.
Change-Id: I5d9ff549b05ca4ce54486719d70858589b8fcfa3
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Provide a script for interpreting the "only" directives and splitting
the existing content up into standalone files for each OS to make it
easier for project teams to copy the parts they need into their own
project documentation trees without requiring separate platform builds.
The files have been hand-edited to pass the niceness check and to allow
the install guide to build.
The script for building the guide has been changed to not build separate
copies per OS.
Change-Id: Ib88f373190e2a4fbf14186418852d971b33dca85
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Since Icehouse, the training-labs scripts have offered an automated
method of installing the exact cluster described in the install-guide
for every OpenStack release. In order to make this option easier to
find, this changeset adds a brief note and a link from the install-guide
to training-labs.
Change-Id: Iada7ad7b0d52176d1a1ad405769882b24a6d1f15
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>
With the change to search.html, the search page now
searches docs.openstack.org, not the specific guide.
Update the header to reflect this.
Change-Id: I9cb4b7669e4c0767e73b105867240a1079d0c086
Add distro versions in a consistent way to tutorials and index page.
Remove project specific links from distros when there is not support for
that distribution.
Add newton project-install-guide to local index for review.
Change-Id: Icf40f34e2b330b602002b44c64b7927f2d0be6ca
Training labs parser will allow us to automatically parse RST code
to BASH. This BASH code in turn will be invoked by install-guides for
validating the install guides. To provide the correct information to the
parser for generating BASH code, there are a few changes required to the
RST syntax.
Introduces the following changes to RST syntax:
- `.. end`
This tag provides information for the parser to stop extracting the
given block which could be code, file injection or configuration
file edit.
- `.. endonly`
This tag provides information for the parser with the correct
distro-switch logic for identifying distro-specific code.
For .. only:: tags, it is better to avoid nesting. If nesting
is not avoidable then it is preferable to add the .. endonly
tag to close the outer block immediately.
- Extra new lines in code-blocks
Some commands in the code-blocks provides the expected output of the
given command. This is not a BASH command which we want to run but
rather some visual niceness for the users. These new lines provides
the parser information to identify the end of the command. This
basic logic would be something similar to find '\r\n' which at least
for python means new empty line.
- `mysql>`
Introducing this operator for mysql commands. This could potentially
be changed to `pgsql>` or similar for other SQL type databases.
This allows the parser to identify mysql commands and then run
them in mysql instead of in 'sh' or 'bash'.
- `.. path`
Introducing this tag to provide the parser with the information with
the path of the configuration file. Using the description text for
the same is not reliable since the description text may not be
consistent.
This commit should ideally introduce all the syntax changes required for
the parser to convert the code-blocks in here to BASH code. These
changes should have no impact on the HTML output of the RST code.
Change-Id: I47830b1bc61c8b1a0f3350932d15aa3ce88fa672
SUSE is testing this on both SP1 and SP2, update the instructions. The
repository used is named SP2, it can be used for both.
Change-Id: Ifef1610395459cdaf5dd5aaaf465fbc73ebb7928
- manila content has been moved to the project-specific install-guide.
- Add link to the shared-file-systems installation tutorial
published from within the manila project code tree
Change-Id: Ie541df1d38706bc0c0603b94bffaf06a9316b1c2
Partially-Implements: blueprint projectspecificinstallguides
Partially-Implements: blueprint manila-in-tree-install-guide
Part of "consistency-file-rename" spec [1]
This commit also changes the following:
* Update corresponding references to common in various guides
* Rename excluded_patterns in conf.py of various guide
* Rename existing entries in www/static/.htaccess
* Add entries to .htaccess to redirect renamed files
[1] http://specs.openstack.org/openstack/docs-specs/specs/newton/consistency-file-rename.html
Change-Id: I39a9d5b95535cad1918ee64e95dee5ef18ab2cbe
Since all the guide is using the non-interactive mode of Debconf,
we must explain how to select it.
Change-Id: I2f4d614f13b3087acf7449bd973242105e4caa00
This is a following patch of I8df6b3b382137d08d60f85bc41bcd98ac1f4eb47
"Factor out Install Guide for Debian with debconf".
Mainly, remove Debian specific procedure from build tool.
Also, remove debconf content from Debian Install Guide,
but there are still some debconf content, which is needed to
cleanup at further following patches.
Change-Id: Iffced3907ac2fddd42e6adc56b6e4859fde8e987
Modified the file to get a list of contents
Change-Id: Ib33a8ce346d76ae4ac099d9904bf8e6be1ba3261
Closes-Bug: #1491122
Co-Authored-By: KATO Tomoyuki <kato.tomoyuki@jp.fujitsu.com>
The install guide currently does not include trove.
This commit provides instructions for how to install
trove.
Change-Id: Ib0fcba5e5a88e1ff3fd4b7138895dc1faf81af36
Implements: bp installguide-add-trove
It is an effort to document manila install guide.
Only Ubuntu distro has been properly updated until now.
Liberty packages have been used for the tests, but it can be
changed to mitaka as soon as they are available. Thanks in
advance for any feedback about this initial effort.
Change-Id: I686bdda2ee27de4e5c43bb8d95c0126c8c300558
Implements: blueprint create-manila-install-guide
Update for openSUSE Leap 42.1 and SLES 12 SP1. Adjust OpenStack link to
use new Mitaka repositories.
Remove extra version information.
Update gpg key.
Also, update title for draft-index.
Change-Id: I68e67c269f4c7bfb584d75b3884ebe3cd20eb071
We have two index files for Debian and other distributions.
On the other hand, when the tool generates translation resources,
uses only one index file, Debian index as of now.
Therefore, translation for index files is applied
to only one index file.
For example, Translation for Ubuntu index file
are not applied for Ubuntu Installation Guide.
* Unify index files into one file
* Process toctree for each distribution dynamically
Change-Id: I3abcd7da3569bb8e9edbc02574dcb74c12752ede
Closes-Bug: #1507861
Updates the admonition warning that the
Install Guide is a work-in-progress, and
adds a line advising that the book was tested
using pre-release packages.
Change-Id: Icc974ef63ec9f76a7dcd27244048d6e49f41a4f0
In the index of the Liberty Install Guide, specified that Ubuntu
packages are coming from Canonical's Ubuntu Cloud archive.
Change-Id: I3882be46f35b35adc0e39bca1bd40a3a556201b8
Closes-Bug: #1502742
Implement initial networking architecture changes for Liberty
as follows:
1) Remove nova-network.
2) Develop architecture for provider networks with Linux
bridge agent.
3) Develop architecture for self-service networks with
Linux bridge agent.
4) Munge the neutron controller and network node configuration
together.
5) Rejigger neutron to use the Linux bridge agent.
6) Restructure launch an instance content to account for
two networking options.
7) Other restructuring as necessary to meet the primary
goal.
For simplicity, both architectures require only two nodes,
each with two network interfaces, to deploy core OpenStack
services. Also, to address recurring issues about the lack
of support for connecting instances directly to the
public/external network, the self-service architecture
augments the provider networks architecture which allows
connection to both private and public networks.
Change-Id: Ie3ab9a15ebfe82c0ce54f709c87a66d7cc46db3f
Implements: blueprint installguide-liberty
Converting from DocBook to XML we lost the initial conventions section,
write it and add it to all RST guides.
Change-Id: I2ff3d863c72af97a3f70a1ae34083623b7c7006e
We cannot use ..only.. with a toctree, it gets parsed at the wrong
time.
Add a second Debian specific index file so that Debian gets only this
file. This avoids the double index entry in the sidetable but leads to
no index table for Debian.
Change-Id: I6f4e7dffb2c5cd4416607817dcb3685b65b0674d
Partial-Fix: #1488187
Remove DocBook XML files and rename directory from install-guide-rst to
install-guide.
Adjust everything so that publishing works.
Update README to remove DocBook XML Install Guide specific instructions.
Implements: blueprint installguide-liberty
Change-Id: If723c44c3c0383dc8ab8e53798d82e7f0ee2cc57
Doug Hellmann