From 600d86745599e0e1893d8966879f93f60b954f74 Mon Sep 17 00:00:00 2001
From: Matjaz Pancur <matjaz.pancur@fri.uni-lj.si>
Date: Fri, 11 Sep 2015 14:25:50 +0200
Subject: [PATCH] [Upstream training] new landing page
Adds a new openstackdocs themed landing page for Upstream training. Renames
old landing page to slide-index.html (so users that prefer slide-only landing
page can still use it).
Change-Id: I8575af8e5b70940e5252c86e8c584261e0e29ab4
Closes-Bug: #1494724
---
doc/upstream-training/conf.py | 280 ++++++++++++++++++
doc/upstream-training/index.rst | 53 ++++
doc/upstream-training/source/conf.py | 2 +-
.../source/{index.rst => slide-index.rst} | 0
test-requirements.txt | 7 +-
tox.ini | 6 +
6 files changed, 344 insertions(+), 4 deletions(-)
create mode 100644 doc/upstream-training/conf.py
create mode 100644 doc/upstream-training/index.rst
rename doc/upstream-training/source/{index.rst => slide-index.rst} (100%)
diff --git a/doc/upstream-training/conf.py b/doc/upstream-training/conf.py
new file mode 100644
index 00000000..cf7ad5d7
--- /dev/null
+++ b/doc/upstream-training/conf.py
@@ -0,0 +1,280 @@
+# 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 openstackdocstheme
+
+# -- 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.
+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'Upstream Training Guide'
+bug_tag = u'upstream'
+copyright = u'2014-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 = '0.0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.0.1'
+
+# 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, "bug_tag": bug_tag}
+
+# 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 = ['source', 'build']
+
+# 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 = 'upstream-training'
+
+
+# -- 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', 'UpstreamTrainingGuide.tex', u'Upstream Training 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', 'upstream-training-guide', u'Upstream Training 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', 'UpstreamTrainingGuide', u'Upstream Training Guide',
+ u'OpenStack contributors', 'UpstreamTrainingGuide',
+ 'This guide shows how to work with the OpenStack upstream.',
+ '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/']
\ No newline at end of file
diff --git a/doc/upstream-training/index.rst b/doc/upstream-training/index.rst
new file mode 100644
index 00000000..96c3cd47
--- /dev/null
+++ b/doc/upstream-training/index.rst
@@ -0,0 +1,53 @@
+===========================
+OpenStack Upstream Training
+===========================
+
+Abstract
+========
+
+With over 2000 developers from 80 different companies worldwide, OpenStack is
+one of the largest collaborative software-development projects. Because of its
+size, it is characterized by a huge diversity in social norms and technical
+conventions. These can significantly slow down the speed at which newcomers
+are successful at integrating their own roadmap into that of the OpenStack
+project.
+
+We've designed a training program to help professional developers negotiate
+this hurdle. It shows them how to ensure their bug fix or feature is accepted
+in the OpenStack project in a minimum amount of time. The educational program
+requires students to work on real-life bug fixes or new features during two
+days of real-life classes and online mentoring, until the work is accepted by
+OpenStack. The live two-day class teaches them to navigate the intricacies of
+the project's technical tools and social interactions. In a followup session,
+the students benefit from individual online sessions to help them resolve any
+remaining problems they might have.
+
+Outline and online slides
+=========================
+
+How OpenStack is made
+---------------------
+
+* `Relevant actors <02-relevant-actors.html>`_
+* `OpenStack Governance <03-technical-committee.html>`_
+* `OpenStack "Big Tent" and tags <04-program-ecosystem.html>`_
+* `OpenStack Design Summit <05-design-summit.html>`_
+* `IRC meetings <06-irc-meetings.html>`_
+
+Workflow of an OpenStack contribution and tools
+-----------------------------------------------
+
+* `devstack.org <11-devstack.html>`_
+* `How to contribute <12-howtocontribute.html>`_
+* `launchpad.net <13-launchpad.html>`_
+* `review.openstack.org <14-gerrit.html>`_
+* `Branching model <15-branching-model.html>`_
+* `Reviewing <16-reviewing.html>`_
+* `Commit messages <17-commit-message.html>`_
+* `Jenkins <18-jenkins.html>`_
+
+The Contribution Process
+------------------------
+
+* `Overview of the contribution process <19-training-contribution-process.html>`_
+* `Lego applied to Free Software contributions <20-training-agile-for-contributors.html>`_
diff --git a/doc/upstream-training/source/conf.py b/doc/upstream-training/source/conf.py
index 7ea8b16a..57f4e850 100644
--- a/doc/upstream-training/source/conf.py
+++ b/doc/upstream-training/source/conf.py
@@ -54,7 +54,7 @@ source_suffix = '.rst'
#source_encoding = 'utf-8-sig'
# The master toctree document.
-master_doc = 'index'
+master_doc = 'slide-index'
# General information about the project.
project = u'Upstream Training Guide'
diff --git a/doc/upstream-training/source/index.rst b/doc/upstream-training/source/slide-index.rst
similarity index 100%
rename from doc/upstream-training/source/index.rst
rename to doc/upstream-training/source/slide-index.rst
diff --git a/test-requirements.txt b/test-requirements.txt
index 954a0f91..710d7696 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -1,10 +1,11 @@
# 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.
-openstack-doc-tools>=0.23
doc8 # Apache-2.0
pbr>=0.6,<1.0
oslosphinx
-sphinx>=1.1.2,<1.2
+openstack-doc-tools>=0.30
+sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
+openstackdocstheme>=1.0.7
hieroglyph>=0.7.1
-bashate # pep8 equivalent for bash scripts
+bashate # pep8 equivalent for bash scripts
\ No newline at end of file
diff --git a/tox.ini b/tox.ini
index 3ea2bf96..1b6bc526 100644
--- a/tox.ini
+++ b/tox.ini
@@ -62,7 +62,11 @@ commands =
doc8 doc/training-guides
# Build upstream-training slides
sphinx-build -b slides doc/upstream-training/source/ doc/upstream-training/build/slides
+ # Build upstream landing page index.html
+ sphinx-build -b html doc/upstream-training doc/upstream-training/build/slides doc/upstream-training/index.rst
+ # Build training-guides slides
sphinx-build -b slides doc/training-guides/associate-guide/ doc/training-guides/associate-guide/build/slides
+ # Publish as draft
mkdir -p publish-docs/draft/upstream-training
mkdir -p publish-docs/draft/training-guides
rsync -av doc/upstream-training/build/slides/ publish-docs/draft/upstream-training/
@@ -81,6 +85,8 @@ commands =
doc8 doc/upstream-training
# Build upstream-training slides
sphinx-build -b slides doc/upstream-training/source/ doc/upstream-training/build/slides
+ #build upstream landing page index.html
+ sphinx-build -b html doc/upstream-training doc/upstream-training/build/slides doc/upstream-training/index.rst
[testenv:training-slides]
commands =