Bug 1654766 - [API Guide Review] Review Introduction and API Reference chapters
Summary: [API Guide Review] Review Introduction and API Reference chapters
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
TreeView+ depends on / blocked
 
Reported: 2018-11-29 16:04 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-04 13:13:25 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Sergei Petrosian 2018-11-29 16:04:52 UTC
Document URL: 
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.4/html-single/api_guide/

Section Number and Name: 
1. Introduction
2. API Reference

Describe the issue: 
Review and clean up the guide.

Suggestions for improvement: 
Add $ to commands, remove %. $ because API can be used by any user.

Use present simple tense

Remove unuseful outputs.

Add periods at the end of sentences where it is omitted.

Comment 1 Melanie Corr 2018-11-29 16:07:36 UTC
(In reply to Sergei Petrosian from comment #0)

> Remove unuseful outputs.
> 

Hi Sergei, 

Just be careful when reviewing outputs here. API users need to see output examples so they know how to handle the data output with their tools. It is a feature request from customers that I've been talking with to add even more output examples.

Comment 8 Sergei Petrosian 2018-12-04 13:13:25 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/

Thank you


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