Refactor API Guide: publish and deploy updates

[cyrichardson]

Update the content URL for refactored API documentation

• [x] Fork and clone the nexus-control to your local system.

• [x] Remove developer-guide from the route configured for the content.

  • [x] Update the nexus-control configuration file as shown in the following example:

    Original: "/docs/cloud-load-balancers/v1/": "https://github.com/rackerlabs/docs-cloud-load-balancers/v1/developer-guide",

    Updated:``"/docs/cloud-load-balancers/v1/": "https://github.com/rackerlabs/docs-cloud-load-balancers/v1/",

    Notes:

    The value on the left is the path to deploy content. The value to the right of the : is the unique content ID for the Sphinx project. The content ID must match the "contentIDBase" value in the _deconst.json file in the documentation source directory. See Configure development and production builds for Sphinx projects.

• [x] Update the deploy URL in the route configuration file to match the one in the nexus-control configuration file.

• [x] Create a redirect rule for the original URL.

  • [x] Edit the rewrites file to add a redirect rule for the original URL as shown in the following example:

    {
       "description": "Redirect load balancers developer-guide URL",
       "from": "^\\/docs\\/cloud-load-balancers\\/v1\\/developer-guide\\/(.*?)",
       "to": "/docs/cloud-load-balancers/v1/$1",
       "rewrite": false,
       "status": 301
   },

  • [x] Use a json linter to verify that the JSON syntax is correct.
• [x] Commit the changes, and push to your fork.
• [x] Submit your updates as a PR against the upstream repository. Include a link to the PR containing the refactored documentation source.
• [ ] After the PR is merged, verify that the content is deployed to the new URL, for example https:\\developer.rackspace.com\docs\<updated-path>
• [x] Verify that the redirect rule is working by clicking the Developer Guide link on the DRC docs landing page.

Note: Nexus-control changes take longer to deploy than content changes. You can check the nexus-control version information to determine whether the commit has been deployed.

Update the documentation landing page

Update the menu so that it matches the Load Balancers v1 example shown in the following figure:

Important: Don't commit the landing page updates until you have verified that the content has been deployed to the new URL.

Some menus might be slightly different if the product doesn't have an SDK Quickstart, or if it has additional documentation. If you have questions about the menu content or order, open an issue.

• [x] Fork and clone the docs-quickstart repo to your local system.
• [x] Find the menu for the API documentation you are updating.
• [x] Update the title list and href link targets with the information for your documentation.
• [x] Save the file.
• [x] Commit the changes and push to your fork.
• [x] Submit your updates as a PR against the upstream repository. Include a link to the PR containing the refactored documentation source.
  • [x] Check the PR builder preview to make sure the landing page renders correctly with your updates.
  • [x] Request someone to review and merge the PR.