Bug 1660731 - [API Guide Review] Review the second part of the "Getting Started with the Red Hat Satellite API" chapter
Summary: [API Guide Review] Review the second part of the "Getting Started with the Re...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Documentation
Version: 6.4
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: Unspecified
Assignee: Sergei Petrosian
QA Contact: Melanie Corr
URL:
Whiteboard:
Depends On:
Blocks: 1656022 1661096
TreeView+ depends on / blocked
 
Reported: 2018-12-19 05:31 UTC by Sergei Petrosian
Modified: 2019-09-26 14:59 UTC (History)
0 users

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-12-21 04:31:54 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)

Description Sergei Petrosian 2018-12-19 05:31:00 UTC 
Document URL: 
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.4/html/api_guide/chap-red_hat_satellite-api_guide-using_the_red_hat_satellite_api

Section Number and Name: 
4.2. API Examples Using Ruby - 4.8. Working with Life Cycle Environments

Describe the issue: 
The style of the guide is not consistent.

Suggestions for improvement: 
Review and clean up the guide
Split code blocks to Example request, Example response
Change commands options to full form
Add structure
Remove passive
Improve headings
Comment 5 Sergei Petrosian 2018-12-21 04:31:54 UTC 
These changes are now live on the customer portal:
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.4/html/api_guide/chap-red_hat_satellite-api_guide-using_the_red_hat_satellite_api

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