Bug 1459734
| Summary: | Review the Content Management Guide | ||
|---|---|---|---|
| Product: | Red Hat Satellite | Reporter: | Andrew Dahms <adahms> |
| Component: | Docs Content Management Guide | Assignee: | Sergei Petrosian <spetrosi> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Lucie Jirakova <ljirakov> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 6.2.9 | CC: | adahms |
| Target Milestone: | Unspecified | ||
| 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: | 2017-06-15 16:34:00 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: | |||
An additional item for the Content Management Guide from the action plan - * Change command block delimiters from ```` to ---- Assigning to Sergei for review. 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 These changes are now live on the Custom Portal Thank you |
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.