Merge pull request #286 from xiangrumei/master

build an integration page which can show all of OpenSDS's documents.

docs/readthedocs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = OpenSDS
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/readthedocs/conf.py

@@ -0,0 +1,157 @@
+# -*- 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/stable/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
+# sys.path.insert(0, os.path.abspath('.'))
+from recommonmark.parser import CommonMarkParser
+source_parsers = { '.md': CommonMarkParser, }
+
+# -- Project information -----------------------------------------------------
+
+project = u'OpenSDS'
+copyright = u'2018, OpenSDS'
+author = u'OpenSDS'
+
+# The short X.Y version
+version = u''
+# The full version, including alpha/beta/rc tags
+release = u''
+
+
+# -- 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(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 = [u'_build', 'Thumbs.db', '.DS_Store']
+
+# 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 = 'sphinx_rtd_theme'
+
+# 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 = {}
+html_favicon = 'favicon.ico'
+
+# 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 = 'OpenSDSdoc'
+
+
+# -- 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, 'OpenSDS.tex', u'OpenSDS Documentation',
+     u'OpenSDS', '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, 'opensds', u'OpenSDS 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, 'OpenSDS', u'OpenSDS Documentation',
+     author, 'OpenSDS', 'One line description of project.',
+     'Miscellaneous'),
+]

docs/readthedocs/design-specs.md

@@ -0,0 +1,30 @@
+# Design Specs
+OpenSDS design proposals repo.
+
+## OpenSDS Architecture
+
+[OpenSDS Architecture](https://docs.google.com/presentation/d/1-XZJ8lUSGzSXNs23P2MBSUjuyaIumWhSU85hKUbqauM/edit#)
+
+## OpenSDS Roadmap
+
+[OpenSDS Roadmap](https://docs.google.com/presentation/d/1wDhKmdBFOnWraDL98lSWvVoqbuw-xOTA549O04_de_U/edit#)
+
+## Design Proposal Links
+
+Design proposals are drafted here:
+
+[OpenSDS Groups Design](https://docs.google.com/document/d/1bjDaeEQd1Zf9av8Vd4Yn7jfp1Eiv-bBBxafAAsAACrU/edit#)
+
+[OpenSDS Group Snapshots Design](https://docs.google.com/document/d/1mlnuVfRFhu_bczp8EWMdE2XR9xyNImOvVokLGgM6kCc/edit#)
+
+[OpenSDS Replication Design](https://docs.google.com/document/d/1ymjJdBjFntaVcnR-m--VdSILkzOOj3CM4mZA1Sg5Mk0/edit#)
+
+[OpenSDS Profiles Design](https://docs.google.com/document/d/1irNnz019j0XuW6SZNigs6QuYFOCC3uL44EkRYJiHyq8/edit#)
+
+[OpenSDS Enumeration Design](https://docs.google.com/document/d/1f-ta2CbORuXPTdEZybl48hqbBpq2wnsy1puxbzlvLik/edit#)
+
+[OpenSDS Minimum Requirements](https://docs.google.com/document/d/1lOntboT99pN-5iS4Z6_gz1Dzwlx7y1Q2weo1VxC_Knk/edit#)
+
+[OpenSDS and OpenStack Integration](https://docs.google.com/document/d/1xZWMlVSd1ove-N-xWv3ZmRbiauzBmdgiQu2C6HRSJKI/edit#)
+
+[Enhance Cinder with OpenSDS](https://docs.google.com/presentation/d/1Vn5dBLyUXlcTyNCdw-hgTqX5bMd4VDpCQNk7SgfipXA/edit#)

docs/readthedocs/index.rst

@@ -0,0 +1,44 @@
+.. OpenSDS documentation master file, created by
+   sphinx-quickstart on Thu Mar  1 10:50:05 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to OpenSDS's documentation!
+===================================
+
+.. figure:: https://www.opensds.io/wp-content/uploads/sites/18/2016/11/logo_opensds.png
+      :width: 150px
+      :align: right
+
+OpenSDS is a software defined storage controller that provides unified block, file, object storage services. Mainly includes two projects of OpenSDS and NBP.
+
+
+
+.. toctree::
+   :maxdepth: 3
+   :caption: OpenSDS
+
+   opensds   
+
+.. toctree::
+   :maxdepth: 3
+   :caption: NBP
+
+   nbp   
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Design-specs
+
+   design-specs
+
+.. toctree::
+   :maxdepth: 3
+   :caption: tsc
+
+   tsc
+
+
+
+
+

docs/readthedocs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=OpenSDS
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/readthedocs/nbp.md

@@ -0,0 +1,29 @@
+# OpenSDS Northbound Plugin Project
+
+## Introduction
+
+The SUSHI Project is an umbrella project for all the [OpenSDS Project](https://opensds.io/)
+NorthBound Plugins, for OpenStack, Kubernetes, Mesos, VMware and more.
+The plugins themselves could have multiple hosting location,
+however the OpenSDS Sushi Project repo should always have the most up-to-date version.
+
+Sushi will also seek to collaborate with other upstream open source communities
+such as Cloud Native Computing Foundation, Docker, OpenStack, and Open Container Initiative.
+
+## Community
+
+The OpenSDS community welcomes anyone who is interested in software defined
+storage and shaping the future of cloud-era storage. If you are a company,
+you should consider joining the [OpenSDS Project](https://opensds.io/).
+If you are a developer want to be part of the code development that is happening
+now, please refer to the Contributing sections below.
+
+
+## Contact
+
+* Mailing list: [opensds-dev](https://groups.google.com/forum/?hl=en#!forum/opensds-dev)
+* slack: #[opensds](https://opensds.slack.com)
+* Ideas/Bugs: [issues](https://github.com/opensds/nbp/issues)
+
+## Installation and Testing
+See [Installation](https://github.com/opensds/nbp/wiki) for details.

docs/readthedocs/opensds.md

@@ -0,0 +1,46 @@
+# OpenSDS
+
+## Introduction
+
+The [OpenSDS Project](https://opensds.io/) is a collaborative project under Linux
+Foundation supported by storage users and vendors, including
+Dell EMC, Intel, Huawei, Fujitsu, Western Digital, Vodafone, NTT and Oregon State University. The project
+will also seek to collaborate with other upstream open source communities
+such as Cloud Native Computing Foundation, Docker, OpenStack, and Open
+Container Initiative. 
+
+It is a software defined storage controller that provides 
+unified block, file, object storage services and focuses on:
+
+* *Simple*: well-defined API that follows the [OpenAPI](https://github.com/OAI/OpenAPI-Specification) specification.
+* *Lightweight*: no external dependencies, deployed once in binary file or container.
+* *Extensible*: pluggable framework available for different storage systems, identity services, capability filters, etc.
+
+## Community
+
+The OpenSDS community welcomes anyone who is interested in software defined
+storage and shaping the future of cloud-era storage. If you are a company,
+you should consider joining the [OpenSDS Project](https://opensds.io/). 
+If you are a developer want to be part of the code development that is happening
+now, please refer to the Contributing sections below.
+
+## Collaborative Testing
+
+* [CNCF Cluster](https://github.com/cncf/cluster/issues/30)
+
+## Contact
+
+* Mailing list: [opensds-dev](https://groups.google.com/forum/?hl=en#!forum/opensds-dev)
+* slack: #[opensds](https://opensds.slack.com)
+* Ideas/Bugs: [issues](https://github.com/opensds/opensds/issues)
+
+## Installation
+
+Please refer to [INSTALL](https://github.com/opensds/opensds/wiki) for any requirements when you want to perform code
+development for opensds.
+
+## REST API
+
+### OpenAPI
+
+* [OpenAPI](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/opensds/opensds/v0.1.0/openapi-spec/swagger.yaml)