Bug 1656022
| Summary: | [RFE] Review the API Guide for grammar and style | ||
|---|---|---|---|
| Product: | Red Hat Satellite | Reporter: | Andrew Dahms <adahms> |
| Component: | Documentation | Assignee: | Sergei Petrosian <spetrosi> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | satellite-doc-list |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 6.4 | CC: | dvoss, spetrosi |
| Target Milestone: | Released | Keywords: | FutureFeature |
| 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: | 2019-02-04 10:42:10 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: | |||
| Bug Depends On: | 1654766, 1655506, 1656853, 1660731, 1661093, 1661096 | ||
| Bug Blocks: | |||
|
Description
Andrew Dahms
2018-12-04 13:32:06 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 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 |