Initial OSH-docs commit

This patch set establishes an initial commit to the OpenStack-Helm
documentation repository.

Change-Id: Iee1cf5f5c9e424fcb114be57c6143b86673577ec
Signed-off-by: Tin Lam <tin@irrational.io>

.gitignore

@@ -0,0 +1,18 @@
+# General
+AUTHORS
+Authors
+ChangeLog
+*.log
+dist/*
+
+# Python
+*.py[cod]
+.venv
+.tox
+*.egg-info/
+
+# Documentation
+doc*/build/*
+
+# MacOS
+*.DS_Store

CONTRIBUTING.rst

@@ -0,0 +1,16 @@
+If you would like to contribute to the development of OpenStack,
+you must follow the steps in this page:
+
+https://docs.openstack.org/infra/manual/developers.html
+
+Once those steps have been completed, changes to OpenStack
+should be submitted for review via the Gerrit tool, following
+the workflow documented at:
+
+https://docs.openstack.org/infra/manual/developers.html#development-workflow
+
+Pull requests submitted through GitHub will be ignored.
+
+Bugs should be filed as stories in Storyboard, not GitHub:
+
+https://storyboard.openstack.org/#!/project/886

LICENSE

@@ -0,0 +1,3 @@
+This work is licensed under a Creative Commons Attribution 3.0 Unported License.
+
+http://creativecommons.org/licenses/by/3.0/legalcode

README.rst

@@ -0,0 +1,10 @@
+===================
+OpenStack-Helm-Docs
+===================
+
+This repository hosts the documentation for the
+`OpenStack-Helm project <https://github.com/openstack/openstack-helm>`_.
+
+Contributors are encouraged to join IRC: ``#openstack-helm`` on freenode.
+
+For information on contributing to OpenStack-Helm, see ``CONTRIBUTING.rst``.

doc-ko_KR/source/_static

@@ -0,0 +1 @@
+../../doc/source/_static

doc-ko_KR/source/_templates

@@ -0,0 +1 @@
+../../doc/source/_templates

doc-ko_KR/source/conf.py

@@ -0,0 +1 @@
+../../doc/source/conf.py

doc-ko_KR/source/index.rst

@@ -0,0 +1,20 @@
+.. OpenStack-Helm documentation master file, created by
+   sphinx-quickstart on Wed Oct 31 02:39:39 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to OpenStack-Helm's documentation!
+==========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/source/conf.py

@@ -0,0 +1,200 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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.
+#
+import os
+import sys
+
+import pbr.version
+
+sys.path.insert(0, os.path.abspath('../..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'OpenStack-Helm'
+copyright = '2018, OpenStack-Helm Authors'
+author = 'OpenStack-Helm Authors'
+
+version_info = pbr.version.VersionInfo('openstack-helm-docs')
+
+# The short X.Y version
+version = version_info.canonical_version_string()
+# The full version, including alpha/beta/rc tags
+release = version_info.version_string_with_vcs()
+
+
+# -- General configuration ---------------------------------------------------
+
+# OpenStackDocsTheme options
+repository_name = 'openstack/openstack-helm-docs'
+bug_project = '64'
+bug_tag = ''
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
+use_storyboard = True
+
+# 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.
+extensions = [
+    'openstackdocstheme',
+    'oslosphinx',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- 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 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 = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OpenStack-Helmdoc'
+
+
+# -- 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': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# 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 = [
+    (master_doc, 'OpenStack-Helm.tex', 'OpenStack-Helm Documentation',
+     'OpenStack-Helm Authors', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'openstack-helm', 'OpenStack-Helm Documentation',
+     [author], 1)
+]
+
+
+# -- 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 = [
+    (master_doc, 'OpenStack-Helm', 'OpenStack-Helm Documentation',
+     author, 'OpenStack-Helm', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True

doc/source/index.rst

@@ -0,0 +1,20 @@
+.. OpenStack-Helm documentation master file, created by
+   sphinx-quickstart on Wed Oct 31 02:39:39 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to OpenStack-Helm's documentation!
+==========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

requirements.txt

@@ -0,0 +1,8 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+
+pbr>=2.0.0
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
+oslosphinx>=4.7.0 # Apache-2.0
+openstackdocstheme>=1.19.0 # Apache-2.0

setup.cfg

@@ -0,0 +1,21 @@
+[metadata]
+name = openstack-helm-docs
+summary = Documentation Repository for OpenStack-Helm
+description-file =
+    README.rst
+author = OpenStack
+author-email = openstack-dev@lists.openstack.org
+home-page = https://docs.openstack.org/openstack-helm/latest/
+classifier =
+    Intended Audience :: Developers
+    License :: OSI Approved :: Apache Software License
+    Operating System :: POSIX :: Linux
+
+[build_sphinx]
+all_files = 1
+build-dir = doc/build
+source-dir = doc/source
+warning-is-error = True
+
+[wheel]
+universal = 1

setup.py

@@ -0,0 +1,19 @@
+# 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
+
+setuptools.setup(
+    setup_requires=['pbr'],
+    pbr=True)

tools/build-docs.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+set -e
+
+# Builds all the documents in localization folders
+docs_dir="doc*"
+for d in ${docs_dir} ; do
+  rm -rf $d/build
+  sphinx-build -W -b html $d/source $d/build/html
+done
+
+# Copy this back to the main folder
+docs_dir="doc-*"
+for d in ${docs_dir} ; do
+  cp -r $d/build/html doc/build/html/${d#*-}
+done

tox.ini

@@ -0,0 +1,27 @@
+[tox]
+minversion = 2.3.1
+envlist = docs
+skipsdist = True
+
+[testenv]
+usedevelop = True
+install_command = pip install -U {opts} {packages}
+setenv =
+  VIRTUAL_ENV={envdir}
+deps =
+  -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
+  -r{toxinidir}/requirements.txt
+whitelist_externals =
+  bash
+  rm
+
+[testenv:venv]
+basepython = python3
+commands = {posargs}
+
+[testenv:docs]
+basepython = python3
+description =
+  Build main documentation.
+commands =
+  bash -c "./tools/build-docs.sh"

zuul.d/project.yaml

@@ -0,0 +1,16 @@
+---
+# 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.
+
+- project:
+    templates:
+      - publish-openstack-docs-pti