Bug 1416238 - [Docs][Ironic] Implement peer review feedback for the Bare Metal Provisioning guide
Summary: [Docs][Ironic] Implement peer review feedback for the Bare Metal Provisioning...
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 8.0 (Liberty)
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: RHOS Documentation Team
QA Contact: RHOS Documentation Team
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-01-25 02:06 UTC by Lucy Bopf
Modified: 2018-03-26 01:35 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-03-26 01:35:24 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Lucy Bopf 2017-01-25 02:06:08 UTC
The following suggestions were provided by Sandra McCann during peer review of the RHOSP 8 Bare Metal Provisioning guide:

1. The section titles in the Troubleshooting section are quite long, and the resulting links may be truncated by search engines in a way that removes critical information. The titles must be reviewed for clarity and brevity, and to ensure that the key point of the title is immediately clear.

2. A lack of consistency of sample commands can be confusing as you move between chapters. The document must be reviewed to make the consistency between sample commands clearer (so a user can tell which IP address is the internal IP vs VIP vs Bare Metal Node IP, for example).

3. As an extension of 2., a topology with labels that are used throughout the sample commands would be useful. The feasibility of such an approach should be investigated.

Comment 1 Lucy Bopf 2018-03-26 01:35:24 UTC
The Bare Metal Provisioning Guide underwent a restructure with technology changes in RHOSP 10, and much of this feedback either no longer applies or should be captured as part of larger review efforts. Given the team's current commitments for RHOSP 13 and other more recent versions, I'm closing this one as WONTFIX.


Note You need to log in before you can comment on or make changes to this bug.