Rackspace Cloud DNS API documentation

Purpose

This GitHub repository contains the source files for the following Rackspace Cloud DNS API documentation:

Cloud DNS Developer Guide

Contributing

Contributions are welcome!

To suggest changes or report a problem, submit an issue.
To make changes to a project, create your own fork of the repository. Then, submit a pull request to have your changes reviewed and merged into the master branch as appropriate.

To contribute content, all you need is an editor and a basic understanding of the project layout and reStructuredText syntax.

You can use the GitHub editor or any text editor to work with documentation source files. For quick syntax checking, try the Online restructuredText editor.

Note: If you want to build the project, you need to install the Sphinx documentation generator.

Source format

The Rackspace developer documentation is developed and built using the Python Sphinx documentation generator. Content is written in reStructuredText, the markup syntax and parser component of Python Docutils.

The repository includes the documentation source files, Sphinx configuration and build files, as well any required Sphinx extensions and build tools.

Structure

Source files for the Sphinx documentation project are in the api-docs directory. Here are the key files that define the Sphinx project and content architecture for the documentation:

Content	File
Sphinx documentation configuration file	conf.py (Typically, this file does not require changes.)
Index page for the main content structure	index.rst
About the API index	overview/index.rst
Getting Started introduction	getting-started.rst
Getting Started index	getting-started/index.rst
Developer Guide introduction	developer-guide.rst
Concepts section	concepts.rst
General API information index	general-api-info/index.rst
API Reference introduction	api-reference.rst
API Reference index	api-operations/index.rst
API operations methods, including code samples	api-operations/methods
Release notes	release-notes.rst
make.bat	Windows build script
Makefile	Linux and OS X build

Support and feedback

If you find a problem, open a GitHub issue.