Documentation bugs on initial commit
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
OpenStack Charms Deployment Guide |
Fix Released
|
Undecided
|
Unassigned |
Bug Description
Initial docs issues found in the document:
Some review comments on 'install-
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-
The links are missing for:
Install the openstack bundle
For our project, [download the OpenStack]
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-
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.
Reviewed: https:/ /review. openstack. org/496722 /git.openstack. org/cgit/ openstack/ charm-deploymen t-guide/ commit/ ?id=bed2dd42bd4 23711e4ff9561ff 82b3a5c83e4f54
Committed: https:/
Submitter: Jenkins
Branch: master
commit bed2dd42bd42371 1e4ff9561ff82b3 a5c83e4f54
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: Id96104928bd95d 9d82dfe2a1e90fb bc60c661c28
Closes-Bug: #1712583