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 1656022 - [RFE] Review the API Guide for grammar and style
Summary: [RFE] Review the API Guide for grammar and style
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Documentation
Version: 6.4
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: Released
Assignee: Sergei Petrosian
QA Contact: satellite-doc-list
URL:
Whiteboard:
Depends On: 1654766 1655506 1656853 1660731 1661093 1661096
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-12-04 13:32 UTC by Andrew Dahms
Modified: 2019-10-07 16:45 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-02-04 10:42:10 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Andrew Dahms 2018-12-04 13:32:06 UTC
This bug is a tracker for reviewing each chapter and section of the API Guide for grammar and style concerns.

Comment 2 dvoss 2019-02-01 18:54:38 UTC
Sergei,
In looking at the related items, this work looks completed. Can you confirm that all the dependent chapters have been reviewed?


Thanks in advance,

David

Comment 3 Sergei Petrosian 2019-02-04 10:42:10 UTC
HI David,

Yes, the work with the API guide is complete. This what was done to improve it within these bugs:

Make it consistent, well-structured, easy to read
Prepare it for adding target customer scenarios
Remove repeated staff
Remove passive voice
Split command blocks into Example request and Example response
Add more examples
Clear formatting

I am closing this bug.

Thank you


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