openstack/designate
Code Issues Proposed changes

Fix up links in Ubuntu Dev Environment

Browse Source 
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
This commit is contained in:
Vinod Mangalpally 2015-02-16 09:12:07 -06:00
parent 6300569afc
commit 5ae85fca79
4 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/architecture.rst
View File

@ -13,6 +13,8 @@
License for the specific language governing permissions and limitations
under the License.
.. _architecture:
============
Architecture
============

3
doc/source/glossary.rst
View File

@ -13,9 +13,6 @@
License for the specific language governing permissions and limitations
under the License.
.. _architecture:
============
Glossary
============

16
doc/source/install/ubuntu-dev.rst
View File

@ -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

2
doc/source/rest.rst
View File

@ -1,3 +1,5 @@
.. _rest:
REST API Documentation
======================