Bug 1400370 - [Doc] [Providers] Edit Managing Containers/Insight and Control content
Summary: [Doc] [Providers] Edit Managing Containers/Insight and Control content
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat CloudForms Management Engine
Classification: Red Hat
Component: Documentation
Version: 5.7.0
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: GA
: 5.10.0
Assignee: Dayle Parker
QA Contact: Suyog Sainkar
URL:
Whiteboard: doc
Depends On:
Blocks: 1405278
TreeView+ depends on / blocked
 
Reported: 2016-12-01 02:07 UTC by Dayle Parker
Modified: 2018-06-12 08:23 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-06-12 08:23:10 UTC
Category: ---
Cloudforms Team: ---
Target Upstream Version:


Attachments (Terms of Use)

Description Dayle Parker 2016-12-01 02:07:48 UTC
I've noticed while working on new container features for 4.2, that much of the container-related content in Managing Providers probably is more suited to the Managing Infrastructure and Inventory guide.

Suggested changes:

1. I suggest moving all the parts about managing/working with components (in 5.8. Insight and Control) in a container provider (ie. viewing templates, pods, projects, etc) to the Managing Infrastructure guide, in a Container Entities chapter or something like that (I created one for the tagging feature in https://bugzilla.redhat.com/show_bug.cgi?id=1389129)

2. While documenting the templates feature, I also noticed that the procedures for viewing inventory are overly complicated.

For example, we document viewing in 4 steps, when it can easily be done as one step:

[4 steps]

Viewing a Pods Summary

   - Navigate to Compute → Containers → Providers.
   - Click the desired containers provider for viewing the provider summary.
   -  In the Relationships box on the right-hand side of the summary page, click Pods.
    - Click the desired pod for viewing.
   

[1 step]
 Alternatively, you can access the desired pod from Compute → Containers → Pods. 


I suggest documenting the viewing navigation via the provider once, mentioning that you can see all these entities, but then trimming the entity-specific instructions to one step, as above.

Thoughts welcome.

Comment 2 Andrew Dahms 2018-05-16 00:43:47 UTC
Assigning to Dayle for review.

Dayle - this one has been around for a while, but I think the issues you have raised here are entirely valid.

I agree in particular that a lot of the "Viewing a..." instructions can be done away with and collapsed into a single paragraph or line.


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