Merge "Move User Guides into separate directories"

This commit is contained in:
Jenkins 2015-05-13 17:24:32 +00:00 committed by Gerrit Code Review
commit 282be5d7bd
127 changed files with 33426 additions and 100 deletions

View File

@ -9,7 +9,10 @@ declare -A DIRECTORIES=(
# books to be built
declare -A BOOKS=(
["fr"]="image-guide"
["ja"]="image-guide install-guide user-guides"
# TODO(ajaeger) Temporary disabled user-guide and user-guide-admin.
# This needs openstack-doc-tools 0.28 release first.
# ["ja"]="image-guide install-guide user-guide user-guide-admin"
["ja"]="image-guide install-guide"
["pt_BR"]="install-guide"
["zh_CN"]="arch-design image-guide install-guide"
)
@ -17,7 +20,10 @@ declare -A BOOKS=(
# draft books
declare -A DRAFTS=(
["fr"]="image-guide"
["ja"]="install-guide user-guides"
# TODO(ajaeger) Temporary disabled user-guide and user-guide-admin.
# This needs openstack-doc-tools 0.28 release first.
# ["ja"]="install-guide user-guide user-guide-admin"
["ja"]="install-guide"
["pt_BR"]="install-guide"
["zh_CN"]="install-guide"
)
@ -32,6 +38,9 @@ DOC_DIR="doc/"
# Books with special handling
# Values need to match content in project-config/jenkins/scripts/common_translation_update.sh
declare -A SPECIAL_BOOKS=(
["user-guides"]="RST"
# TODO(ajaeger) Temporary disabled user-guide and user-guide-admin.
# This needs openstack-doc-tools 0.28 release first.
["user-guide"]="skip"
["user-guide-admin"]="skip"
["networking-guide"]="RST"
)

View File

@ -0,0 +1,36 @@
[metadata]
name = openstackuserguideadmin
summary = OpenStack Admin User Guide
author = OpenStack
author-email = openstack-docs@lists.openstack.org
home-page = http://docs.openstack.org/
classifier =
Environment :: OpenStack
Intended Audience :: Information Technology
Intended Audience :: System Administrators
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
Programming Language :: Python
Programming Language :: Python :: 2
Programming Language :: Python :: 2.6
Programming Language :: Python :: 2.7
Programming Language :: Python :: 3
Programming Language :: Python :: 3.3
Topic :: Documentation
[global]
setup-hooks =
pbr.hooks.setup_hook
[files]
[build_sphinx]
all_files = 1
build-dir = build
source-dir = source
[wheel]
universal = 1
[pbr]
warnerrors = True

View File

@ -12,12 +12,12 @@ OpenStack command-line clients
common/cli_install_openstack_command_line_clients.rst
common/cli_discover_version_number_for_a_client.rst
common/cli_set_environment_variables_using_openstack_rc.rst
adminuser/manage_projects_users_and_roles.rst
adminuser/nova_cli_manage_projects_security.rst
adminuser/cli_manage_services.rst
manage_projects_users_and_roles.rst
nova_cli_manage_projects_security.rst
cli_manage_services.rst
common/cli_manage_images.rst
common/cli_manage_volumes.rst
adminuser/cli_manage_flavors.rst
adminuser/cli_admin_manage_environment.rst
adminuser/cli_set_quotas.rst
adminuser/analyzing-log-files-with-swift-cli.rst
cli_manage_flavors.rst
cli_admin_manage_environment.rst
cli_set_quotas.rst
analyzing-log-files-with-swift-cli.rst

View File

@ -0,0 +1,306 @@
# 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('.'))
# Defines conditions for end user guide and admin user guide
# When a piece of content has an "admin" indicator, it will be
# output with the admin guide. Otherwise it's output for both
# the end user guide and the admin user guide.
# This is the path where you find the scope.py file that does conditional TOCs.
sys.path.append(os.path.abspath('../sphinx-ext/'))
# -- 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 = ['os_doc_tools.sphinx.hotref', 'scope']
# 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'Admin User Guide'
copyright = u'2015, 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 = '1.0.0'
# The full version, including alpha/beta/rc tags.
release = '1.0.0'
# We ask git for the SHA checksum
# The git SHA checksum is used by "log-a-bug"
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
# source tree
pwd = os.popen("pwd").read().strip('\n')
# html_context allows us to pass arbitrary values into the html template
html_context = {"pwd": pwd, "gitsha": gitsha}
# 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 = []
# 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.
# This one is needed for "Report a bug".
# html_show_sourcelink = True
# 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 = 'user-guide-admin'
# If true, publish source files
# html_copy_source = True
# -- 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', 'UserGuide.tex', u'User 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', 'userguide', u'User 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', 'UserGuide', u'User Guide',
u'OpenStack contributors', 'UserGuide',
'This guide shows OpenStack end users how to create and manage resources '
'in an OpenStack cloud with the OpenStack dashboard and OpenStack client '
'commands.', '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-admin', u'AdminUserGuide', u'Admin User Guide',
u'OpenStack contributors')
]

View File

@ -16,12 +16,12 @@ OpenStack dashboard
common/log_in_dashboard.rst
adminuser/dashboard_manage_images.rst
adminuser/dashboard_admin_manage_roles.rst
adminuser/dashboard_manage_instances.rst
adminuser/dashboard_manage_flavors.rst
adminuser/dashboard_manage_volumes.rst
adminuser/dashboard_set_quotas
adminuser/dashboard_manage_resources.rst
adminuser/dashboard_manage_host_aggregates.rst
adminuser/dashboard_admin_manage_stacks.rst
dashboard_manage_images.rst
dashboard_admin_manage_roles.rst
dashboard_manage_instances.rst
dashboard_manage_flavors.rst
dashboard_manage_volumes.rst
dashboard_set_quotas
dashboard_manage_resources.rst
dashboard_manage_host_aggregates.rst
dashboard_admin_manage_stacks.rst

View File

@ -52,7 +52,7 @@ Control the state of an instance
pause, un-pause, suspend, resume, soft or hard reboot, or terminate
an instance (items in red are disabled).
.. figure:: ../figures/change_instance_state.png
.. figure:: figures/change_instance_state.png
**Figure Dashboard—Instance Actions**

View File

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

View File

@ -22,9 +22,9 @@ Contents
.. toctree::
:maxdepth: 2
adminuser/intro-admin.rst
dashboard-admin.rst
cli-admin.rst
intro-admin.rst
dashboard.rst
cli.rst
common/app_support.rst

View File

@ -0,0 +1 @@
../user-guide/sphinx-ext

View File

@ -1,8 +1,8 @@
[metadata]
name = openstackuserguide
summary = OpenStack User Guide
summary = OpenStack End User Guide
author = OpenStack
author-email = openstack-dev@lists.openstack.org
author-email = openstack-doc@lists.openstack.org
home-page = http://docs.openstack.org/
classifier =
Environment :: OpenStack

30
doc/user-guide/setup.py Normal file
View File

@ -0,0 +1,30 @@
#!/usr/bin/env python
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
#
# 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 MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
import setuptools
# In python < 2.7.4, a lazy loading of package `pbr` will break
# setuptools if some other modules registered functions in `atexit`.
# solution from: http://bugs.python.org/issue15881#msg170215
try:
import multiprocessing # noqa
except ImportError:
pass
setuptools.setup(
setup_requires=['pbr'],
pbr=True)

View File

@ -0,0 +1,27 @@
.. meta::
:scope: user_only
==============================
OpenStack command-line clients
==============================
.. toctree::
:maxdepth: 2
common/cli_overview.rst
common/cli_install_openstack_command_line_clients.rst
common/cli_discover_version_number_for_a_client.rst
common/cli_set_environment_variables_using_openstack_rc.rst
common/cli_manage_images.rst
common/cli_manage_volumes.rst
cli_nova_configure_access_security_for_instances.rst
cli_launch_instances.rst
cli_manage_instances_hosts.rst
cli_provide_user_data_to_instances.rst
cli_use_snapshots_to_migrate_instances.rst
cli_config_drive.rst
cli_create_and_manage_networks.rst
managing-openstack-object-storage-with-swift-cli.rst
cli_create_and_manage_stacks.rst
cli_ceilometer.rst
trove-manage-db.rst

View File

@ -0,0 +1 @@
../../common-rst

View File

@ -59,16 +59,9 @@ source_suffix = '.rst'
# source_encoding = 'utf-8-sig'
# The master toctree document.
# We need to use noqa here since tags is defined externally.
if tags.has('admin_only'): # noqa
master_doc = 'index-admin'
else:
master_doc = 'index'
# General information about the project.
if tags.has('admin_only'): # noqa
project = u'Admin User Guide'
else:
project = u'End User Guide'
copyright = u'2015, OpenStack contributors'
@ -307,12 +300,6 @@ locale_dirs = ['locale/']
# -- Options for PDF output --------------------------------------------------
if tags.has('admin_only'): # noqa
pdf_documents = [
('index-admin', u'AdminUserGuide', u'Admin User Guide',
u'OpenStack contributors')
]
else:
pdf_documents = [
('index', u'UserGuides', u'End User Guide', u'OpenStack contributors')
]

View File

@ -15,12 +15,12 @@ OpenStack dashboard
:maxdepth: 2
common/log_in_dashboard.rst
enduser/dashboard_manage_images.rst
enduser/configure_access_and_security_for_instances.rst
enduser/dashboard_launch_instances.rst
enduser/dashboard_create_networks.rst
enduser/dashboard_manage_containers.rst
enduser/dashboard_manage_volumes.rst
enduser/dashboard_stacks.rst
enduser/dashboard_databases.rst
dashboard_manage_images.rst
configure_access_and_security_for_instances.rst
dashboard_launch_instances.rst
dashboard_create_networks.rst
dashboard_manage_containers.rst
dashboard_manage_volumes.rst
dashboard_stacks.rst
dashboard_databases.rst

Some files were not shown because too many files have changed in this diff Show More