summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHieu LE <hieulq@vn.fujitsu.com>2017-07-25 09:32:09 +0700
committerHieu LE <hieulq@vn.fujitsu.com>2017-07-25 09:35:15 +0700
commit66c873a67d7d5dc3b6a481051c5a76bb90e78d31 (patch)
tree8c200d7ddd6fdeb73cad7c1e3d505fb1d22656f4
parent3f1fe07d06bc3b7b26c404f53eb347093ca3f44f (diff)
downloaddesignate-66c873a67d7d5dc3b6a481051c5a76bb90e78d31.tar.gz
doc: Populate the 'install' section
Per the spec [1]: install/ – anything having to do with installation of the project The current install guide need to move to this category. Change-Id: Ib2005a7ed7c3d476b3e4e2a3603736203af8b415 Implements: blueprint designate-doc-migration Closes-Bug: #1706173
-rw-r--r--doc/source/index.rst3
-rw-r--r--doc/source/install/common_prerequisites.rst (renamed from install-guide/source/common_prerequisites.rst)0
-rw-r--r--doc/source/install/create-zone.rst (renamed from install-guide/source/create-zone.rst)0
-rw-r--r--doc/source/install/get_started.rst (renamed from install-guide/source/get_started.rst)0
-rw-r--r--doc/source/install/index.rst16
-rw-r--r--doc/source/install/install-obs.rst (renamed from install-guide/source/install-obs.rst)2
-rw-r--r--doc/source/install/install-rdo.rst (renamed from install-guide/source/install-rdo.rst)0
-rw-r--r--doc/source/install/install-ubuntu.rst (renamed from install-guide/source/install-ubuntu.rst)0
-rw-r--r--doc/source/install/install.rst (renamed from install-guide/source/install.rst)0
-rw-r--r--doc/source/install/next-steps.rst (renamed from install-guide/source/next-steps.rst)0
-rw-r--r--doc/source/install/verify.rst (renamed from install-guide/source/verify.rst)0
-rw-r--r--install-guide/source/conf.py302
-rw-r--r--install-guide/source/index.rst16
13 files changed, 19 insertions, 320 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 007500ac..ddf81461 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -8,7 +8,7 @@ auto-generate records based on Nova and Neutron actions. Designate supports
a variety of DNS servers including Bind9 and PowerDNS.
For information on how to install Designate, see the
-`Install Guide <https://docs.openstack.org/project-install-guide/dns/ocata/>`_.
+`Install Guide <https://docs.openstack.org/dns/latest/install/>`_.
For information on the Designate API, see the
`API Reference <https://developer.openstack.org/api-ref/dns/>`_.
@@ -19,6 +19,7 @@ Contents
.. toctree::
:maxdepth: 1
+ install/index
contributor/index
user/index
admin/index
diff --git a/install-guide/source/common_prerequisites.rst b/doc/source/install/common_prerequisites.rst
index af2705a7..af2705a7 100644
--- a/install-guide/source/common_prerequisites.rst
+++ b/doc/source/install/common_prerequisites.rst
diff --git a/install-guide/source/create-zone.rst b/doc/source/install/create-zone.rst
index 548141fe..548141fe 100644
--- a/install-guide/source/create-zone.rst
+++ b/doc/source/install/create-zone.rst
diff --git a/install-guide/source/get_started.rst b/doc/source/install/get_started.rst
index 8d59b756..8d59b756 100644
--- a/install-guide/source/get_started.rst
+++ b/doc/source/install/get_started.rst
diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst
new file mode 100644
index 00000000..edadcd81
--- /dev/null
+++ b/doc/source/install/index.rst
@@ -0,0 +1,16 @@
+=====================================
+Installing OpenStack DNS as a Service
+=====================================
+
+.. toctree::
+ :maxdepth: 2
+
+ get_started
+ install
+ verify
+ create-zone
+ next-steps
+
+This chapter assumes a working setup of OpenStack following the
+`OpenStack Installation Tutorial <https://docs.openstack.org/install/>`_.
+
diff --git a/install-guide/source/install-obs.rst b/doc/source/install/install-obs.rst
index 1d68f8c6..954e34cd 100644
--- a/install-guide/source/install-obs.rst
+++ b/doc/source/install/install-obs.rst
@@ -1,4 +1,4 @@
-.. _install-rdo:
+.. _install-obs:
Install and configure for openSUSE and SUSE Linux Enterprise
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/install-guide/source/install-rdo.rst b/doc/source/install/install-rdo.rst
index 6a34838a..6a34838a 100644
--- a/install-guide/source/install-rdo.rst
+++ b/doc/source/install/install-rdo.rst
diff --git a/install-guide/source/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst
index d13f92df..d13f92df 100644
--- a/install-guide/source/install-ubuntu.rst
+++ b/doc/source/install/install-ubuntu.rst
diff --git a/install-guide/source/install.rst b/doc/source/install/install.rst
index 63c1586c..63c1586c 100644
--- a/install-guide/source/install.rst
+++ b/doc/source/install/install.rst
diff --git a/install-guide/source/next-steps.rst b/doc/source/install/next-steps.rst
index d6987994..d6987994 100644
--- a/install-guide/source/next-steps.rst
+++ b/doc/source/install/next-steps.rst
diff --git a/install-guide/source/verify.rst b/doc/source/install/verify.rst
index 4be90609..4be90609 100644
--- a/install-guide/source/verify.rst
+++ b/doc/source/install/verify.rst
diff --git a/install-guide/source/conf.py b/install-guide/source/conf.py
deleted file mode 100644
index 4f77a5b8..00000000
--- a/install-guide/source/conf.py
+++ /dev/null
@@ -1,302 +0,0 @@
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-# implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import os
-# import sys
-
-
-import openstackdocstheme
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-# sys.path.insert(0, os.path.abspath('.'))
-
-# -- General configuration ------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-# needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder'
-# extensions =
-
-# Add any paths that contain templates here, relative to this directory.
-# templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-# source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'Installation Guide for DNS Service'
-bug_tag = u'install-guide'
-copyright = u'2016, OpenStack contributors'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '0.1'
-# The full version, including alpha/beta/rc tags.
-release = '0.1'
-
-# A few variables have to be set for the log-a-bug feature.
-# giturl: The location of conf.py on Git. Must be set manually.
-# gitsha: The SHA checksum of the bug description. Automatically extracted
-# from git log.
-# bug_tag: Tag for categorizing the bug. Must be set manually.
-# These variables are passed to the logabug code via html_context.
-giturl = u'http://git.openstack.org/cgit/openstack/designate/tree/'\
- u'install-guide/source'
-git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
-gitsha = os.popen(git_cmd).read().strip('\n')
-html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
- "giturl": giturl,
- "bug_project": "designate"}
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-# language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-# today = ''
-# Else, today_fmt is used as the format for a strftime call.
-# today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ["common_prerequisites.rst", "common_configure.rst"]
-
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-# default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-# add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-# add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-# show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-# modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-# keep_warnings = False
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-html_theme = 'openstackdocs'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-# html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [openstackdocstheme.get_html_theme_path()]
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-# html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-# html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-# html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-# html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = []
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-# html_extra_path = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# So that we can enable "log-a-bug" links from each output HTML page, this
-# variable must be set to a format that includes year, month, day, hours and
-# minutes.
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
-
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-# html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-# html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-# html_additional_pages = {}
-
-# If false, no module index is generated.
-# html_domain_indices = True
-
-# If false, no index is generated.
-html_use_index = False
-
-# If true, the index is split into individual pages for each letter.
-# html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-html_show_sourcelink = False
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-# html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-# html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-# html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-# html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'install-guide'
-
-# If true, publish source files
-html_copy_source = False
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
- # The paper size ('letterpaper' or 'a4paper').
- # 'papersize': 'letterpaper',
-
- # The font size ('10pt', '11pt' or '12pt').
- # 'pointsize': '10pt',
-
- # Additional stuff for the LaTeX preamble.
- # 'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- ('index', 'InstallGuide.tex', u'Install Guide',
- u'OpenStack contributors', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-# latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-# latex_use_parts = False
-
-# If true, show page references after internal links.
-# latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-# latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-# latex_appendices = []
-
-# If false, no module index is generated.
-# latex_domain_indices = True
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- ('index', 'installguide', u'Install Guide',
- [u'OpenStack contributors'], 1)
-]
-
-# If true, show URL addresses after external links.
-# man_show_urls = False
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- ('index', 'InstallGuide', u'Install Guide',
- u'OpenStack contributors', 'InstallGuide',
- 'This guide shows OpenStack end users how to install '
- 'an OpenStack cloud.', 'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-# texinfo_appendices = []
-
-# If false, no module index is generated.
-# texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-# texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-# texinfo_no_detailmenu = False
-
-# -- Options for Internationalization output ------------------------------
-locale_dirs = ['locale/']
-
-# -- Options for PDF output --------------------------------------------------
-
-pdf_documents = [
- ('index', u'InstallGuide', u'Install Guide',
- u'OpenStack contributors')
-]
diff --git a/install-guide/source/index.rst b/install-guide/source/index.rst
deleted file mode 100644
index 8965541c..00000000
--- a/install-guide/source/index.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-===========
-DNS service
-===========
-
-.. toctree::
- :maxdepth: 2
-
- get_started
- install
- verify
- create-zone
- next-steps
-
-This chapter assumes a working setup of OpenStack following the
-`OpenStack Installation Tutorial <http://docs.openstack.org/#install-guides>`_.
-