Documentation bugs on initial commit

Bug #1712583 reported by Alex Kavanagh on 2017-08-23
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Charms Deployment Guide
Undecided
Unassigned

Bug Description

Initial docs issues found in the document:

Some review comments on 'install-openstack.rst':

In the "Deploy OpenStack" section under "Ceph OSD"

odd wording "Change or ignore this to match your own configuration. "
Under "Swift proxy":

It mentions the "uuid command used previously". However, this is never mentioned anywhere else in the documentation.

On the "install-openstack-bundle.html" page:

The links are missing for:

Install the openstack bundle
For our project, [download the OpenStack][downloadbundle] and deploy OpenStack using the above command.

Also something is probably needed to be said about customising the bundle for the hardware available; e.g. placement of services, etc. according to hardware, convergence, etc.

In "config-openstack.html":

In the 'define and external network' section:

typo: " called Pub_Net that will use a subnet with within the range of "
The Note should be an rst note: !!! Note: OpenStack has deprecated the use of the neutron command for network configuration, migrating most of its functionality into the Python OpenStack client. Version 2.4.0 or later of this client is needed for the subnet create command.

description: updated
description: updated

Reviewed: https://review.openstack.org/496722
Committed: https://git.openstack.org/cgit/openstack/charm-deployment-guide/commit/?id=bed2dd42bd423711e4ff9561ff82b3a5c83e4f54
Submitter: Jenkins
Branch: master

commit bed2dd42bd423711e4ff9561ff82b3a5c83e4f54
Author: Alex Kavanagh <email address hidden>
Date: Wed Aug 23 14:22:11 2017 +0100

    Fix some documentation issues

    - Fixed odd wording in install-openstack.rst.
    - Fixed up uuid command usage.
    - Added missing links and added note about editting bundles.
    - Fixed up the note to be an RST note rather than just regular
      text.

    Also add .gitreview as the project is managed on review.openstack.org

    Change-Id: Id96104928bd95d9d82dfe2a1e90fbbc60c661c28
    Closes-Bug: #1712583

Changed in charm-deployment-guide:
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers