Bug 1365383 - [RFE] [6.3] Administration Guides confusing
Summary: [RFE] [6.3] Administration Guides confusing
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Documentation
Version: 6.2.0
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: Unspecified
Assignee: satellite-doc-list
QA Contact: satellite-doc-list
URL:
Whiteboard:
Depends On: 1473936 1473937
Blocks: 1122832
TreeView+ depends on / blocked
 
Reported: 2016-08-09 06:48 UTC by Peter Vreman
Modified: 2019-04-01 20:27 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-10-03 01:23:40 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Peter Vreman 2016-08-09 06:48:23 UTC
The Documentation set is confusing for the user.
- Where to start
- Where to find what

From https://access.redhat.com/documentation/en/red-hat-satellite?version=6.2/
Administration
    
    Server Administration Guide
    Administering a Red Hat Satellite 6 Server
    
    Host Configuration Guide
    A guide to managing hosts in a Red Hat Satellite 6 environment
    
    Content Management Guide
    An end-to-end guide on managing content from Red Hat and custom sources
    
    Provisioning Guide
    A guide to provisioning physical and virtual hosts on Red Hat Satellite Servers
    
    Virtual Instances Guide
    Information to help users manage virtual instances with Red Hat Satellite 6.2.
	
For me as user in all documentantion the following words are mixed
- Server = Host = Virtual Instances
See also "Virtual Instanecs" and "Virtual Hosts" (as mentioned in the Provisioning Guide description)

Another thing is where to start with the Host Configuration Guide, Provisiong Guide or Virtual Instances Guide?

Also the Host Configuration Guide contains sections that are part of Provisioning, make it even more confusing what the purpose is:
    Host Configuration Guide
    Chapter 1. Using the Red Hat Satellite Content Dashboard
    Chapter 2. Using Content Views
    Chapter 3. Viewing and Applying Errata
    Chapter 4. Security Compliance Management
    Chapter 5. Working with Containers
    Chapter 6. Configuring Activation Keys
    Chapter 7. Configuring GPG Keys
    Chapter 8. Configuring the Provisioning Environment
    Chapter 9. Configuring Hosts
    Chapter 10. Discovering Bare-metal Hosts on Satellite
    Chapter 11. Running Remote Jobs on Satellite Hosts
    Chapter 12. Configuring Host Collections
    Appendix A. Template Writing Reference
    Legal Notice


Recommendations:
- Rename "Server Administration Guide" to "Satellite Server Administration Guide"
- Rename "Host Configuration Guide" to "Managing Hosts Guide" and in the description include text like. Managing hosts after they are Provisioned
- Drop all Provisioning relevant sections from "Host Configuration Guide"
   - Move 'Chapter 6. Configuring Activation Keys' to 'Provisioning Guide'
   - Move 'Chapter 8. Configuring the Provisioning Environment' to 'Provisioning Guide'
   - Move 'Chapter 10. Discovering Bare-metal Hosts on Satellite' to 'Provisioning Guide'
- Create new Documenation "Bare-metal Hosts" to complement the "Virtual Instances" Guide.
- Use constistent naming "Virtual Isntances" or "Virtual Hosts"

Comment 1 Andrew Dahms 2017-06-01 04:01:27 UTC
Assigning to Steve for consideration as part of planning for Red Hat Satellite 6.3.

Comment 2 Steve Bream 2017-07-18 09:50:27 UTC
Thanks Andrew,

I'll include this info for 6.3 planning as part of a larger effort to organize the information into a workflow that requires users to do less jumping from guide to guide. 

I'll also bring the "virtual hosts" vs "virtual instances" discussion to the larger community, as this is something that should be consistent across all Red Hat docs.

Comment 3 Stephen Wadeley 2017-07-18 12:00:21 UTC
Hello

I like "Satellite Server Administration Guide"

but for "Host Configuration Guide" to "Managing Hosts Guide"

how about "Satellite Client Management Guide"

Comment 5 Andrew Dahms 2018-01-16 00:10:03 UTC
Updating the doc type.

Comment 6 Andrew Dahms 2018-03-05 00:48:32 UTC
Removing the tracker bug for Satellite 6.3.

Comment 7 Andrew Dahms 2018-10-03 01:23:40 UTC
Thank you for raising this bug.

We have evaluated this request, and while we recognize that it is a valid request for the documentation, we do not expect this to be implemented in the product in the foreseeable future. We are therefore closing this out as WONTFIX. 

Peter - we appreciate the detail you have put into this request, and have taken several steps over the past few releases to address this and other workflow concerns.

At the same time, we realize we still have a ways to go, and if you have any feedback on the documentation in the state it lands for Satellite 6.4, we would love to hear from you and work with you on incorporating further feedback to improve the overall consistency in a new request.

If you have any concerns about this, please feel free to contact me at any time.


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