BZ1466952 Provide clarification for enabling clusters in Managing Providers guide #474
Conversation
There was a problem hiding this comment.
@cbudz
Hi Chris,
The content and placement looks good! I think it's great you've mentioned the important points in both the relevant guides (Managing Providers and Gen Config).
Just a few small changes needed, mostly relating to style, plus a couple corrections, and I think this should be all good to merge.
Cheers,
Dayle
| Hence, the OpenStack adminURL endpoint should be assigned an IP address other than `192.168.x.x`. Additionally, all the Keystone endpoints must be accessible, otherwise refresh will fail. | ||
| * Collecting C & U data from am OpenStack cloud provider requires selecting the *Collect for All Clusters* option under *Configuration*, in the setting menu. For information, see https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.5/html-single/general_configuration/#enabling-a-cluster,-host,-or-datastore-for-capacity-and-utilization-collection[ Enabling a Cluster, Host, or Datastore for Capacity and Utilization Collection] in the Red Hat CloudForms _General Configuration_ guide. |
There was a problem hiding this comment.
A few fixes needed for this sentence: "Collecting C & U data from am OpenStack cloud provider requires selecting the Collect for All Clusters option under Configuration, in the setting menu."
- am --> an
- C & U data --> I'd recommend spelling out as "capacity and utilization data", just to avoid acronyms. Looking through the guide we only abbreviate it when it's a UI label.
- setting menu --> settings menu
- The Gen Config link currently goes to the top of the guide -- I know there's not a great way to link to sections in this behemoth guide, but would it be better to link to 4.1.1 Regions maybe? https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.5/html-single/general_configuration/#regions That's how I tend to handle links to the GC guide, but happy to discuss ideas.
- "Red Hat CloudForms" should either be an entity, or could be removed for upstreaming.
| @@ -93,7 +93,8 @@ To enable a cluster, host, or datastore for Capacity and Utilization Collection: | |||
|
|
|||
| [NOTE] | |||
| ========================= | |||
| As new clusters, hosts, and datastores are discovered, you will need to come back to this configuration to enable collection of capacity and utilization data unless you have used the *Collect for All* check boxes. | |||
| . As new clusters, hosts, and datastores are discovered, you will need to come back to this configuration to enable collection of capacity and utilization data unless you have used the *Collect for All* check boxes. | |||
| . *Collect for All Clusters* must be checked to be able to collect C & U data from Cloud Providers such as Red Hat OpenStack or Amazon EC2. | |||
There was a problem hiding this comment.
A few fixes:
- C & U data (as in above topic) --> I'd recommend spelling out as "capacity and utilization data", just to avoid acronyms. Looking through the guide we only abbreviate it when it's a UI label.
- Cloud Providers should be lower case --> cloud providers
- I think Red Hat OpenStack is normally written as Red Hat OpenStack Platform, but we could probably also abbreviate it to just OpenStack like the rest of the procedure (not sure how crucial this is.)
| @@ -4,7 +4,7 @@ | |||
| Configure the following to collect capacity and utilization data from a Red Hat Virtualization provider: | |||
|
|
|||
| * In {product-title_short}, enable the capacity and utilization server roles from the settings menu, in menu:Configuration[Server > Server Control]. For more information on capacity and utilization collection, see https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.5/html-single/deployment_planning_guide/#assigning_the_capacity_and_utilization_server_roles[Assigning the Capacity and Utilization Server Roles] in the _Deployment Planning Guide_. | |||
|
|
|||
| * For information on selecting clusters and datastores used to collect data, see https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.5/html-single/deployment_planning_guide/#enabling-a-cluster,-host,-or-datastore-for-capacity-and-utilization-collection[Enabling a Cluster, Host, or Datastore for Capacity and Utilization Collection] in the _General Configuration Guide_. | |||
There was a problem hiding this comment.
This link goes to the wrong guide/section. Also, we should write/markup "in the General Configuration Guide." as "in the General Configuration guide." to be consistent.
|
Checked commits cbudz/manageiq_docs@15e4d96~...3002be8 with ruby 2.2.6, rubocop 0.47.1, and haml-lint 0.20.0 |
|
Hi Dayle, I've made updates and corrections based on your feedback. Thanks so much for catching all of that. A few things: I've directed the user to to the link in the General Configuration guide for "Capacity and Utilization Collections" since I believe that to be the most direct path. I've tested the links and they should work properly in the preview. I updated General Configuration Guide to abide by the style of other references to guides in the doc. -Chris |
|
Thanks for making those update, Chris -- it looks great, and good call on that link. Merging... |
Hey Dayle,
I've updated the Managing Providers guide with some information based on a request submitted in BZ1466952. Let me know what you think of the placement of the additional items.
Thanks,
Chris