Bug 1459463 - Review the API Guide
Review the API Guide
Status: CLOSED CURRENTRELEASE
Product: Red Hat Satellite 6
Classification: Red Hat
Component: Docs API Guide (Show other bugs)
6.2.9
Unspecified Unspecified
medium Severity medium (vote)
: 6.2.11
: 6.2
Assigned To: Sergei Petrosian
Stephen Wadeley
:
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2017-06-07 04:49 EDT by Andrew Dahms
Modified: 2017-06-08 07:05 EDT (History)
0 users

See Also:
Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of:
Environment:
Last Closed: 2017-06-08 07:05:24 EDT
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---


Attachments (Terms of Use)

  None (edit)
Description Andrew Dahms 2017-06-07 04:49:48 EDT
This bug is a tracker to review the terminology and links in the API Guide. The following items must be checked:

* Change all instances of   to {nbsp}
* Change all instances of 'Composite Views' to 'Composite Content Views'
* Check that all instances of 'Puppet', 'Puppet Forge', and 'Facter' are
  capitalized.
* Check that URLs are not broken
* Remove instances of 'easily' and 'simply'
* Check multi-line commands (not code blocks and code examples) to ensure
  each line ends with a '\' except on the last line.

Also, check that the key terms in the Red Hat Satellite 6 section of the Glossary of Terms and Conventions for Product Documentation are used.
Comment 2 Andrew Dahms 2017-06-07 04:52:21 EDT
Assigning to Sergei for review.
Comment 6 Sergei Petrosian 2017-06-08 07:05:24 EDT
Hello,

These changes are now live on the Custom Portal.

Thank you

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