Skip to content
This repository has been archived by the owner on Sep 13, 2024. It is now read-only.

QE Load balancer v1 refactored API documentation #161

Closed
8 tasks done
meker12 opened this issue Jul 26, 2016 · 3 comments
Closed
8 tasks done

QE Load balancer v1 refactored API documentation #161

meker12 opened this issue Jul 26, 2016 · 3 comments

Comments

@meker12
Copy link
Contributor

meker12 commented Jul 26, 2016

Refactor API Guide: QE checklist for v1

Use the following checklist to verify the API guide refactoring for Load Balancers, v1. If you have questions, open a docs-common issue.

When you build the refactored Sphinx project, use the make clean html command to build chunked content.

  • Review the Strider build log for errors. Notify author about any issues.
  • Check for broken links.
  • Verify that navigation matches the API Guide template.
  • Check the API reference section to verify that the methods for each resource are in a single topic.
  • Check the General API information topics to make sure they match the common content where possible.
  • Check the Authentication topic in the Getting started section to make sure it matches the common template.
  • Check conf.py to make sure it has the updates from the
    template.
  • Verify that you can build locally from source.
@cyrichardson
Copy link
Contributor

cyrichardson commented Jul 26, 2016

@meker12 I did not create a PR for any of the conf.py differences.

Comparing conf.py in meker12/master and docs-common repos using Text Wrangler differences, differences are product specific except for the following:

  • CLB shows html_use_smartyparts=True commented out
  • CLB shows html_add_permlinks='#' commented out
  • CLB shows 'API Developer Guide' rather than 'Rackspace Cloud Load Balancers API documentation in man_pages
  • CLB shows 'Rackspace Cloud Load Balancers API Developer Guide' rather than 'Rackspace Cloud Load Balancers API Documentation' in texinfo_documents

@cyrichardson
Copy link
Contributor

cyrichardson commented Jul 26, 2016

Moved to create PR against the meker12 repo after this... to include the changes below and any other for this file.

Comparing authentication section files, these differences exist:

In authenticate_using_curl:

  • Line 6 - need "an" before authentication
  • Line 17 - need "," after
  • Lines 31 through 33 - start with capital letter
  • Line 38 - "request and response" on same line in link
  • After Line 53 in template file, missing code 400 and 401 info
  • Line 97 - change "prior to" to "before"
  • Line 99 - change "tokens and token expiration" to "authentication tokens"
  • Line 105 - "Services" to "services"

@cyrichardson
Copy link
Contributor

@meker12 All done with QE checklist. Made PRs for all fill differentces except for the conf.py one... wasn't sure how smartypants and permalinks should be set.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants