Let's treat warnings as errors. Typical warnings are not
existing link targets, missing toctree entry,...
Change-Id: Ic7b70026ef508cd0c41be4fc35435bc15e429916
Docs build on python3 has some extra demands, like that a global
toctree argument (e.g. ocata/*) always needs to list at least one
file. To satisfy that, the easiest solution was to remove the
"approved" and "implemented" folders. We were not using them anyhow.
Change-Id: I453e74932b95cc8f3e13e1fb74437f3da86f659f
Release Notes section was returning empty for nova-dpm in RTD.
This patch fixes the same.
Closes-Bug: 1718103
Change-Id: Iac1832331b50f1b971c686be77d83a60f1bd53cd
Signed-off-by: Sreeram Vancheeswaran <sreeram.vancheeswaran@in.ibm.com>
Created a place holder for release notes files in the right location
in the source tree and include them in the documentation build with
a history file.
Related-Bug: #1661319
Change-Id: I451ee6d0876bc987d2d066fdd95efca2bda9261e
In order to grow the file system of a partition using cloud-init the
package 'cloud-utils-growpart' is required.
As rhel7 uses a pretty old version of util-linux (which inclues
'sfdsik'), resizing the partition fails with
awk: cmd. line:1: (FILENAME=- FNR=1) fatal: attempt to access field -1
FAILED: failed to get total number of sectors from /dev/sdb
Change-Id: Ifc43722730f5616451dc002edd35e8fe8ff50a64
The rhel7 image doc specified an invalid path to the dpm
guest image tools. This fix corrects that path.
Change-Id: I05d48eb536297030c06f6492c7516c1b7d124319
Topics that have been added
* Release: Getting started
* Handling the project in Launchpad
* Dealing with requirements
Change-Id: If62e38bc6909db55c2b5a0cbdd6ddf40d4948b7b
All the specs are listed in our "Contributing to the project"
section of the docs. Also the templates are shown there. At the
moment we have more templates than specs listed there.
Removing the duplicated template file and replace it by a .dummy file
which is not displayed when building the docs. Now only the common
ocata template is shown.
Change-Id: I7b8af6566b4d422d4e26f433e608706786d7c38d
Moving all bash functions into a separate file. This avoids that the
main script gets executed when testing function, as now just this
new function file get be sourced.
Change-Id: Ia9219080790d92f671618ba4aef90e2b6bab78b3
We publish our docs on ReadTheDocs (RTD). We also want to use "reno"
as release notes tools. Reno has issues to determine the repo root
when it gets used in an RTD build (see bug 1661319).
The bug is solved in reno>2.0.3 but that will be released *after*
the Ocata release. This means we need an interim solution to have
release notes ready at the same time when the actual release is
happening. This change is this interim solution.
Change-Id: I90c5419b7338b312a469308a59501f3bd0ef02ba
Co-Authored-By: Sreeram Vancheeswaran <sreeram.vancheeswaran@in.ibm.com>
RTD is not rendering the bullets of toctree items when the
oslosphinx extension containing the 'openstack' theme is used.
This patch is a circumvention until the issue has been fixed
in oslosphinx [1].
[1] https://bugs.launchpad.net/oslosphinx/+bug/1664976
Change-Id: Id78caa0022c2d1257a651712bdb14f126bf854fc
Closes-Bug: #1664863
This change adds a how-to description of:
* how to tag a release (candidate)
* how to create a stable branch
Change-Id: Ia7fee9db91523288779b7ec200ff2ecd9c7c46e1
The guest image tools must be installed inside an operating system
to allow automated network configuration.
* autoconfigure_networking
A systemd service that starts before cloud-init. It groups qeth
devices to network interfaces that can be consumed by Linux.
Therefore all devices listed in /proc/cmdline get configured with
the provided portno in layer2 mode. The format of the data in the
cmdline must be
<devno>,<portno>[,<mac>];
* Setmac
A udev rule and the corresponding script to change the MAC address
of a network interface from within the guests operating system.
This is done along the data provided via /proc/cmdline. The format
of the data in the cmdline must be
<devno>,<portno>,<mac>;
Note: The boot-os-specific-parameters property of a partition is used
to pass in data from Nova into the operation system. This data is
appended to /proc/cmdline.
Change-Id: Iea199b085aca34769128a8691e95e790a396ee80
This describes the process to create an OpenStack image for the IBM
System z PRSM hypervisor in DPM mode.
closes-Bug: 1657719
Change-Id: Icc65fcbafc4889e3f147bae9cfadfc8890439fc4
This change adds summaries of the official upstream docs of how
to handle:
* release management
* stable branch handling
This answers:
* which release model to we use?
* which version numbers will we use and how are they applied?
* how is the release handled?
* how many supported releases do we have?
* what is allowed to backport and in which way?
Change-Id: I4b506fb9e48e1c885bde87ed348cd248f303329f
Details:
- Addressed the comments made on this change set:
https://review.openstack.org/#/c/427346/4, as documented there.
- Changed TOC depth on main index page from 1 to 2.
Change-Id: I151d0605ce14a6771cee405d7b7f9661b15f27e4
Partial-Bug: 1660689
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
The installation section was updated to document an installation
from PyPI, using the upper constraints file of OpenStack.
There is now a table that maps package versions to OpenStack
releases.
Three different currency variants are described:
- recommended: Latest released fix level for a particular stable
OpenStack release.
- Latest fix level in development, for a particular stable OpenStack
release.
- For developers: Latest development level for OpenStack release in
development.
Change-Id: I2e4cce2d694ea233dbdb5af9b73cebf83cb2228a
Partial-Bug: 1660689
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
Currently, nova-dpm documentation does not have the version number
in the footer. This patch set adds the version information to the
``doc/source/conf.py``.
Closes-Bug: #1662519
Change-Id: I00de3cadda730fb78303579142d82d1ed10c01fa
This change is supposed to improve the documentation that currently
exists, without adding much new content.
Details:
* Reorganized the main page into a common overview section, a
section for users of the driver, and a section for contributors,
and a section with links for quick access.
* Separated between the `README.rst` file and the introductory text
on the main page, because the `README.rst` file stands on its own
when shown on the Github code page, while the introductory text
is part of the larger documentation. As a result, removed the
`doc/source/readme.rst` file.
* Added an empty chapter for the topology to the overview section
of the main page, instead of referencing the readme file.
* Cleaned up headings and file names somewhat.
* Added link targets to any major headings.
* Adapted the contributions page to the project, and added links
for the Git repo and the Gerrit review page.
Change-Id: Id7a9a632984ad8945ca1dd347a7766601030a373
Partial-Bug: 1660689
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
The build process of RTD might not be suitable for the way reno
has designed the processing of release notes. Let's stop that
for now and find an alternative solution.
Change-Id: I182825f691b7fc7e5cf505ed04b7ff9f5394909c
To give customers a glimpse of what to expect from each release,
this change adds a way to add release notes.
The "normal" OpenStack projects have two different sphinx directories:
* doc/source/
* releasenotes/source
That's reasonable for them, as they publish to two different locations.
As an out-of-tree driver, we cannot use the usual release notes
location at http://docs.openstack.org/releasenotes/ All our docs go
to http://nova-dpm.rtfd.io/
This made it necessary to *not* use the default release notes
directory "releasenotes/source/" like the other projects.
Otherwise we would have two different RTD projects, one for the
"normal" docs and another one for the release notes.
As we only have one place for documentation (including release notes)
it didn't make sense to have a separate tox target to create those
release notes. They are included when the docs are built with:
$ tox -e docs
This slight deviation from the upstream defaults made it necessary
to explain the dealing with reno release notes in a developer reference
(devref).
The one added release note is only to double-check if everything
behaves as expected. It has to be updated before the next release.
Closes bug: 1657842
Change-Id: I0d2d10ea2d91bb5193aa1092997db310b277878b