From 5ae85fca7999c49c87a24659a51e4898b8a175c0 Mon Sep 17 00:00:00 2001 From: Vinod Mangalpally Date: Mon, 16 Feb 2015 09:12:07 -0600 Subject: [PATCH] Fix up links in Ubuntu Dev Environment Some of the links referred to documents. Since the location of this file changed, the references needed to be updated. Changed them to ref rather than doc, so that in future moving around documents should not cause a problem. Change-Id: I824268066162884d22ba95d740468f49ce90f4ac --- doc/source/architecture.rst | 2 ++ doc/source/glossary.rst | 3 --- doc/source/install/ubuntu-dev.rst | 16 ++++++++++------ doc/source/rest.rst | 2 ++ 4 files changed, 14 insertions(+), 9 deletions(-) diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst index 81db6e642..1680ee65f 100644 --- a/doc/source/architecture.rst +++ b/doc/source/architecture.rst @@ -13,6 +13,8 @@ License for the specific language governing permissions and limitations under the License. +.. _architecture: + ============ Architecture ============ diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst index e4ea63c19..988b55f05 100644 --- a/doc/source/glossary.rst +++ b/doc/source/glossary.rst @@ -13,9 +13,6 @@ License for the specific language governing permissions and limitations under the License. -.. _architecture: - - ============ Glossary ============ diff --git a/doc/source/install/ubuntu-dev.rst b/doc/source/install/ubuntu-dev.rst index b6376a7fa..4db59cebc 100644 --- a/doc/source/install/ubuntu-dev.rst +++ b/doc/source/install/ubuntu-dev.rst @@ -17,7 +17,9 @@ Development Environment on Ubuntu ********************************* -Designate is comprised of four main components :ref:`designate-api`, :ref:`designate-central`, :ref:`designate-mdns`, and :ref:`designate-pool-manager`, supported by a few standard open source components. For more information see :doc:`architecture`. +Designate is comprised of four main components :ref:`designate-api`, :ref:`designate-central`, +:ref:`designate-mdns`, and :ref:`designate-pool-manager`, supported by a few +standard open source components. For more information see :ref:`architecture`. There are many different options for customizing Designate, and two of these options have a major impact on the installation process: @@ -27,7 +29,7 @@ have a major impact on the installation process: This guide will walk you through setting up a typical development environment for Designate, using BIND9 as the DNS backend and MySQL as the storage backend. For a more complete discussion on -installation & configuration options, please see :doc:`architecture` and :doc:`production-architecture`. +installation & configuration options, please see :ref:`architecture` and :ref:`production-architecture`. For this guide you will need access to an Ubuntu Server (14.04). @@ -118,7 +120,7 @@ Open the designate.conf file for editing Copy or mirror the configuration from this sample file here: -.. literalinclude:: examples/basic-config-sample.conf +.. literalinclude:: ../examples/basic-config-sample.conf :language: ini @@ -315,11 +317,13 @@ Exercising the API .. note:: If you have a firewall enabled, make sure to open port 53, as well as Designate's default port (9001). -Using a web browser, curl statement, or a REST client, calls can be made to the Designate API using the following format where “command” is any of the commands listed in the :doc:`rest` +Using a web browser, curl statement, or a REST client, calls can be made to the +Designate API using the following format where "api_version" is either v1 or v2 +and "command" is any of the commands listed under the corresponding version at :ref:`rest` -.. _Designate REST Documentation: +:: -http://IP.Address:9001/v2/command + http://IP.Address:9001/api_version/command You can find the IP Address of your server by running diff --git a/doc/source/rest.rst b/doc/source/rest.rst index 1e9781634..4dae62a2d 100644 --- a/doc/source/rest.rst +++ b/doc/source/rest.rst @@ -1,3 +1,5 @@ +.. _rest: + REST API Documentation ======================