Commit Graph

5 Commits

Author SHA1 Message Date
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
Jenkins 3707b3c011 Merge "Docs: Add Feature Support Matrix" 2017-02-02 06:48:12 +00:00
Markus Zoeller ec9ad7dbcc Docs: Add Feature Support Matrix
To give customers a glimpse of what to expect from this driver,
this change adds a feature support matrix.
As the nova-dpm driver is out-of-tree, we cannot add it to the
in-tree documentation at
    http://docs.openstack.org/developer/nova/support-matrix.html
Having *all* drivers in this change would add too much maintenance
and manual sync-up between the two repositories (novavs. nova-dpm),
therefore we list only the dpm-driver here.

Closes bug: 1657700

Change-Id: Ie65cb50dc54ce8116f608c3a5280407cf820a2b0
2017-02-01 17:21:49 +01:00
Markus Zoeller 91aad2a0fc Add link to RTD to ReadMe file
The README links now to our "read the docs" (RTD) project
which contains the latest (automatically built) docs of
this project.

Change-Id: I4355ea2756671f4de1f80839fa20dc7733197626
2017-01-24 17:02:16 +01:00
preethipy 83c2926d1c Initial Cookiecutter Commit
* It's the initial commit based on coockiecutter template
* Upstream nova is installed using tox_install.sh as install_command
* zhmcclient is installed via tox dependencies as zhmcclient is not
listed in global openstack requirements and therefore cannot be
listed in requirements.txt

Partial-Bug: #1644216

Change-Id: Ic53e59ebdcb574f4e9fb9d09471c9ddff9bb1759
2016-12-01 12:48:30 +05:30