Commit Graph

54 Commits

Author SHA1 Message Date
Andreas Scheuring 9ef3e43489 Docs build: Treat warning as error
Let's treat warnings as errors. Typical warnings are not
existing link targets, missing toctree entry,...

Change-Id: Ic7b70026ef508cd0c41be4fc35435bc15e429916
2018-04-10 14:46:32 +02:00
Andreas Scheuring 7b4bbc20aa Simplify Specs folder structure
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
2018-04-10 14:46:28 +02:00
Sreeram Vancheeswaran bc6a8828b6 Get release notes back on nova-dpm RTD
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>
2017-09-18 22:57:27 -07:00
Jenkins c3e60f32c8 Merge "Update the documentation link for doc migration" 2017-08-30 13:14:31 +00:00
Jenkins 2b513d6859 Merge "Docs: Getting started page and storage chapter" 2017-08-28 07:48:10 +00:00
Jenkins 4a5a13c5dc Merge "rhel7 image docs: Add installation of growpart" 2017-08-28 07:47:13 +00:00
Sreeram Vancheeswaran 1acca0b2a1 Remove openstackdocstheme
As per [1] removed the openstackdocstheme

[1] -http://lists.openstack.org/pipermail/openstack-dev/2017-July/119566.html

Change-Id: I4f643ff91f44b6b1f264318dbe52f6e5296df878
Signed-off-by: Sreeram Vancheeswaran <sreeram.vancheeswaran@in.ibm.com>
2017-07-27 11:17:13 +05:30
Hangdong Zhang 9f87d9ed04 Update the documentation link for doc migration
Change-Id: I268b5dc4b1a079e6ca26a439541e7a2ea74456af
2017-07-21 14:05:27 +08:00
Jenkins 959e00e459 Merge "fix up release notes build" 2017-05-17 07:01:55 +00:00
Doug Hellmann 5cbac25ce5 fix up release notes build
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
2017-05-17 12:11:45 +05:30
Jenkins cdb4adf1a8 Merge "Cleanup spec folder" 2017-05-15 13:40:06 +00:00
Andreas Scheuring 41693f3e8a Docs: Getting started page and storage chapter
Change-Id: I36c2d284cf8d937eca2ad73293877118604273fe
2017-04-28 18:55:02 +02:00
Jenkins 163ee6f3b7 Merge "Update release docs for milestone releases" 2017-04-28 15:00:53 +00:00
Andreas Scheuring 80a1f8e576 rhel7 image docs: Add installation of growpart
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
2017-04-28 14:48:25 +02:00
Andreas Scheuring 079df16a6e Fix invalid path in rhel7 image doc
The rhel7 image doc specified an invalid path to the dpm
guest image tools. This fix corrects that path.

Change-Id: I05d48eb536297030c06f6492c7516c1b7d124319
2017-04-14 16:13:21 +05:30
Jenkins dfbfacef7f Merge "Move functions into separate method" 2017-04-12 15:17:47 +00:00
Andreas Scheuring 203f59a66f Update release docs for milestone releases
Adding a crisp getting started for milestone releases.

Change-Id: I9f103f4f3749f10634d331166ac13ddec2c33b9f
2017-04-11 15:20:51 +02:00
Jenkins 9c387e8328 Merge "Update Release documentation" 2017-04-07 10:31:33 +00:00
Andreas Scheuring 62255a7e05 Update Release documentation
Topics that have been added

* Release: Getting started
* Handling the project in Launchpad
* Dealing with requirements

Change-Id: If62e38bc6909db55c2b5a0cbdd6ddf40d4948b7b
2017-04-07 12:12:27 +02:00
Andreas Maier e783ca5b3d Added empty specs subtrees for Pike and Queens.
Change-Id: I80ef4529aa527a5ee561bbca57d69f360121613d
2017-04-04 09:44:26 +02:00
Andreas Scheuring a7547be709 Cleanup spec folder
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
2017-03-31 08:47:34 +02:00
Andreas Scheuring dad341f2ff Move functions into separate method
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
2017-03-06 17:46:24 +01:00
Jenkins 5437a44e8a Merge "Add Ocata (1.0.0) release notes" 2017-02-23 09:09:11 +00:00
Markus Zoeller a3e4d40811 Add Ocata (1.0.0) release notes
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>
2017-02-23 09:36:34 +01:00
Jenkins 3caa3cd256 Merge "Specs: Setting MAC for DPM NIC" 2017-02-23 06:15:18 +00:00
Jenkins 9304820eed Merge "Spec for inital Neutron integration" 2017-02-23 06:13:16 +00:00
Jenkins 39e5b37987 Merge "Small correction with command instruction" 2017-02-22 09:48:29 +00:00
preethipy b4cfb4c01c Small correction with command instruction
Change-Id: I02e8da536ef172d465f5c70018ef36899b041e50
2017-02-22 15:08:11 +05:30
Andreas Scheuring 399dfe06f2 Fix RTD not rendering bullets of toctree
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
2017-02-22 09:30:14 +01:00
Andreas Scheuring 260cd8ad4e Specs: Setting MAC for DPM NIC
Implements: blueprint neutron-integration-set-mac
Change-Id: I4da0a674790e38253bbebb799f86c84723c10bd3
2017-02-22 09:10:01 +01:00
Andreas Scheuring 5d7ef47f56 Spec for inital Neutron integration
Implements: blueprint neutron-integration
Change-Id: Ie94a41404ffbd11c90ea9ae324f668ee7eaf02da
2017-02-22 09:09:58 +01:00
Jenkins a30e1bc424 Merge "docs: add release tagging and stable branch creation description" 2017-02-22 06:25:09 +00:00
Jenkins e760974b5c Merge "Add DPM Guest Image Tools" 2017-02-21 08:36:27 +00:00
Markus Zoeller 00634add3e docs: add release tagging and stable branch creation description
This change adds a how-to description of:
* how to tag a release (candidate)
* how to create a stable branch

Change-Id: Ia7fee9db91523288779b7ec200ff2ecd9c7c46e1
2017-02-20 16:14:03 +01:00
Jenkins 2e6a112137 Merge "docs: add release and stable branch management summaries" 2017-02-20 13:20:09 +00:00
Andreas Scheuring 2544312093 Add DPM Guest Image Tools
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
2017-02-20 09:34:19 +01:00
sreeteja fcd516a111 DPM Nova image creation docs
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
2017-02-17 15:38:41 +00:00
Markus Zoeller 6f75c064d9 docs: add release and stable branch management summaries
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
2017-02-17 14:35:42 +01:00
Jenkins 21b06bcf2b Merge "Added content of Topology chapter." 2017-02-13 18:26:47 +00:00
Jenkins 4af1089917 Merge "Updated installation section." 2017-02-13 18:25:13 +00:00
Andreas Maier 325d6237d8 Added content of Topology chapter.
Change-Id: If8510d58a27a4e2d9520d4e08d3f491223c15d0e
Partial-Bug: 1660689
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
2017-02-10 10:14:04 +01:00
Andreas Maier 0247163cf3 Addressed minor comments on 'overhauled docs' change.
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>
2017-02-10 09:46:33 +01:00
Andreas Maier c73d6bd088 Updated installation section.
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>
2017-02-09 13:55:56 +01:00
Jenkins 85a7be2696 Merge "Overhauled the documentation" 2017-02-08 14:00:39 +00:00
Tin Lam b35d7bd059 Add version number to the documentation footer
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
2017-02-07 16:04:37 +00:00
Andreas Maier cf932be130 Overhauled the documentation
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>
2017-02-07 15:47:55 +01:00
Markus Zoeller 474eb617f6 rtd: revert release notes creation (partially)
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
2017-02-02 17:09:14 +01:00
Markus Zoeller 6576a01314 rtd: fix release note creation
ReadTheDocs (RTD) is confused by the different release notes subdir.

Change-Id: I17d21a83d82dc8246e78387a438adf8292496f48
2017-02-02 15:30:40 +01:00
Jenkins a8abe1c1c0 Merge "Docs: Add Release Notes" 2017-02-02 07:25:36 +00:00
Markus Zoeller 462956ba1f Docs: Add Release Notes
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
2017-02-01 18:05:56 +01:00