Bug 1486077

Summary: [RFE] [6.3] Remove the 'Configuring Activation Keys' chapter
Product: Red Hat Satellite Reporter: Andrew Dahms <adahms>
Component: Docs Managing HostsAssignee: Michaela Slaninkova <mslanink>
Status: CLOSED NEXTRELEASE QA Contact: Russell Dickenson <rdickens>
Severity: medium Docs Contact:
Priority: medium    
Version: 6.3.0CC: adahms
Target Milestone: UnspecifiedKeywords: FutureFeature
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-09-12 08:00:44 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: 1473936    

Description Andrew Dahms 2017-08-28 23:53:41 UTC
The Configuring Activation Keys chapter of the Host Configuration Guide must be removed, and the following content migrated to the Content Management Guide -

* Move the content at the start of the chapter to between the last two paragraphs
  at the start of the 'Managing Activation Keys' chapter in the Content
  Management Guide.

* Move the content at the start of the 'Defining Subscription Properties of an 
  Activation Key' section - except for the paragraph near the end that contains
  xrefs to instructions - the start of 'Creating an Activation Key' in the
  Content Management Guide.

* Move the sections 'Enabling Auto-Attach' and 'Setting the Service Level' to
  the Content Management Guide immediately before the 'Chapter Summary' section,
  and make the following changes -

  - Remove the procedure titles and add 'For Web UI Users' instead

  - Add a 'For CLI Users' block to both procedures in a way that follows the
    current style in the guide.

Comment 1 Andrew Dahms 2017-08-28 23:54:33 UTC
Assigning to Misa for review.

Comment 2 Andrew Dahms 2017-08-28 23:57:26 UTC
Let's also move the block of content under 'Combining Multiple Activation Keys for Host Registration' to the end of the 'Using Activation Keys' section.

Comment 3 Michaela Slaninkova 2017-09-01 14:11:55 UTC
Hello Andrew,

I have some questions regarding this bug:


(In reply to Andrew Dahms from comment #0)
> * Move the content at the start of the 'Defining Subscription Properties of
> an Activation Key' section - except for the paragraph near the end that
> contains xrefs to instructions - the start of 'Creating an Activation Key' in 
> the Content Management Guide.

Should I also move a note- "If a custom product (typically containing content not provided by Red Hat) is..."? 


> - Add a 'For CLI Users' block to both procedures in a way that follows the
> current style in the guide.

Can you confirm that the following hammer commands are correct?

_______________________
*Enabling Auto-Attach*

To enable auto-attach on the activation key `development-stack`:

# hammer activation-key update --name "development-stack" \
--organization "ACME" --auto-attach true
________________________

____________________________
*Setting the Service Level*

To set a default service level to Premium on the activation key `development-stack`:

# hammer activation-key update --name "development-stack" \
--organization "ACME" --service-level "premium"
____________________________

>>
There is an inconsistency in the parameter values in the Content Management Guide. The value of the "--name" parameter is "development-stack", however in "Creating an Activation Key" and "Using Activation Keys" sections, it is "stack-development". Is it a typo? Should I change the values to "development-stack"?


Thank you.

Comment 4 Andrew Dahms 2017-09-03 04:24:13 UTC
Hi Misa,

Thank you for the needinfo request.

Comments inline below -

> Should I also move a note- "If a custom product (typically containing
> content not provided by Red Hat) is..."? 

That sounds good - the information contained in that 'Note' box doesn't look like it is contained in the Content Management Guide, and it is a helpful hint.

> Can you confirm that the following hammer commands are correct?

I am not in a position to confirm whether these commands are correct, I'm afraid. It would be best if we can test them in a test environment, or at least check the syntax in the Hammer CLI Guide or using the Hammer output itself.

> There is an inconsistency in the parameter values in the Content Management
> Guide. The value of the "--name" parameter is "development-stack", however
> in "Creating an Activation Key" and "Using Activation Keys" sections, it is
> "stack-development". Is it a typo? Should I change the values to
> "development-stack"?

Well spotted! Yes, it looks like this is a good opportunity to standardize these references. It looks like "development-stack" is the correct version based on the number of instances, but as long as we choose one and make it consistent, it should be fine.

Let me know if there is anything else you need!

Kind regards,

Andrew

Comment 7 Michaela Slaninkova 2017-09-12 08:00:44 UTC
Thank you Russell for reviewing my work.


I am closing this BZ ticket as next release.

Comment 8 Andrew Dahms 2018-01-15 01:11:00 UTC
Updating the component and doc type.