Bug 1473937

Summary: [RFE] [6.3] Review the structure and title of the Server Administration Guide
Product: Red Hat Satellite Reporter: Andrew Dahms <adahms>
Component: Docs Server Administration GuideAssignee: csherrar
Status: CLOSED CURRENTRELEASE QA Contact: Vlada Grosu <vgrosu>
Severity: high Docs Contact:
Priority: high    
Version: 6.3.0CC: adahms, mcorr, swadeley, vgrosu
Target Milestone: UnspecifiedKeywords: FutureFeature
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-03-08 11:28:18 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1365383, 1486095    

Description Andrew Dahms 2017-07-22 15:21:39 UTC
This is a tracker for reviewing the structure and title of the Server Administration Guide in accordance with the changes raised in BZ#1365383.

Comment 1 Andrew Dahms 2018-01-17 04:01:55 UTC
Using this bug for the following tasks -

* The Server Administration Guide must be converted into AsciiDoc so that 
  content can be more easily shared with other titles.

* After the guide has been converted, it must be renamed 'Administering Red 
  Hat Satellite'.

Comment 9 csherrar 2018-02-01 14:50:45 UTC
Hi Andrew,

Regarding renaming "Server Administration Guide" to "Administering Red Hat Satellite", this does not appear in BZ#1365383? CAn you confirm that this is correct?

Should I just rename the titles or should I rename the IDs and links?

Comment 10 Andrew Dahms 2018-02-01 23:05:29 UTC
Hi Clifton,

Thank you for the needinfo request.

This specific rename isn't part of the original bug, but it is aligned with the strategic direction of using more active titles that reflect the contents of their guides.

As for where the name changes should be applied, we only need to take care of references in the guide itself this time around. The title in the master.adoc file and docinfo.xml file are the main references, but if the name of the guide is also included in any section IDs, it would be good to update those as well.

Let me know if you have any other questions. :)

Kind regards,

Andrew

Comment 56 csherrar 2018-03-09 10:42:31 UTC
These changes are live on the customer portal, see https://access.redhat.com/documentation/en-us/red_hat_satellite/6.3/html/administering_red_hat_satellite/.