Red Hat Satellite engineering is moving the tracking of its product development work on Satellite to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "Satellite project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs will be migrated starting at the end of May. If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "Satellite project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/SAT-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1459734 - Review the Content Management Guide
Summary: Review the Content Management Guide
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Docs Content Management Guide
Version: 6.2.9
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: Unspecified
Assignee: Sergei Petrosian
QA Contact: Lucie Jirakova
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-06-08 02:18 UTC by Andrew Dahms
Modified: 2019-09-26 14:44 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-06-15 16:34:00 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Andrew Dahms 2017-06-08 02:18:06 UTC
This bug is a tracker to review the terminology and links in the Content Management 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 3 Andrew Dahms 2017-06-08 02:22:44 UTC
An additional item for the Content Management Guide from the action plan -

* Change command block delimiters from ```` to ----

Comment 4 Andrew Dahms 2017-06-08 02:23:14 UTC
Assigning to Sergei for review.

Comment 10 Andrew Dahms 2017-06-13 04:14:13 UTC
Hi Lucie,

Thank you for the needinfo request.

Unless the command is particularly long or difficult to read, I think it is ok to have all of the parameters on the same line.

A good example of when it would be good to break things out into separate lines would be commands to enable a long list of channels, set firewall ports, etc.

Long story short, I think it is ok to have these commands as a single line.

Does that sound alright to you?

Kind regards,

Andrew

Comment 18 Sergei Petrosian 2017-06-15 16:54:50 UTC
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.