Add docs structure

Added docs templates according to
https://wiki.akraino.org/display/AK/Documentation+Sub-committee
Added tox config so we can build the docs.

To buil them locally:
iec$ tox -edocs

You can then visualize the result in a web browser:
docs/_build/html/index.html

Change-Id: I74ee9a14089ecce3174da6f28dd316d9d7afabe2
Signed-off-by: Cristina Pauna <cristina.pauna@enea.com>

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..4ac7272
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,8 @@
+##############################################################################
+# Copyright (c) 2019 Linux Foundation and others.
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+from docs_conf.conf import *  # noqa: F401,F403

diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..a1eea1f
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,10 @@
+##############################################################################
+# Copyright (c) 2019 Linux Foundation and others.
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+---
+project_cfg: akraino
+project: iec

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..1086714
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,16 @@
+.. _iec:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Akraino Project, Inc. and its contributors
+
+=====================
+Integrated Edge Cloud
+=====================
+                                                                                                          1,1           Top
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   release/release-notes/index
+   release/installation/index

diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst
new file mode 100644 (file)
index 0000000..e03ed22
--- /dev/null
+++ b/docs/release/installation/index.rst
@@ -0,0 +1,11 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Akraino Project, Inc. and its contributors
+
+.. _iec-installation:
+
+.. toctree::
+   :maxdepth: 2
+
+   installation.instruction.rst
+

diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst
new file mode 100644 (file)
index 0000000..01341e9
--- /dev/null
+++ b/docs/release/installation/installation.instruction.rst
@@ -0,0 +1,161 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Akraino Project, Inc. and its contributors
+
+************************************
+Akraino IEC Installation Instruction
+************************************
+
+
+Introduction
+============
+
+License
+=======
+
+How to use this document
+========================
+
+Deployment Architecture
+=======================
+
+Pre-Installation Requirements
+=============================
+
+Hardware Requirements
+---------------------
+
+Minimum Hardware Requirements
+`````````````````````````````
+
+Recommended Hardware Requirements
+`````````````````````````````````
+
+Software Prerequisites
+----------------------
+
+Database Prerequisites
+----------------------
+
+Schema scripts
+``````````````
+
+Other Installation Requirements
+-------------------------------
+
+Jump Host Requirements
+``````````````````````
+
+Network Requirements
+````````````````````
+
+Bare Metal Node Requirements
+````````````````````````````
+
+Execution Requirements (Bare Metal Only)
+````````````````````````````````````````
+
+Installation High-Level Overview
+================================
+
+Bare Metal Deployment Guide
+---------------------------
+
+Install Bare Metal Jump Host
+````````````````````````````
+
+Creating a Node Inventory File
+``````````````````````````````
+
+Creating the Settings Files
+```````````````````````````
+
+Running
+```````
+
+Virtual Deployment Guide
+------------------------
+
+Standard Deployment Overview
+````````````````````````````
+
+Snapshot Deployment Overview
+````````````````````````````
+
+Special Requirements for Virtual Deployments
+````````````````````````````````````````````
+
+Install Jump Host
+'''''''''''''''''
+
+Verifying the Setup - VMs
+'''''''''''''''''''''''''
+
+Upstream Deployment Guide
+-------------------------
+
+Upstream Deployment Key Features
+````````````````````````````````
+
+Special Requirements for Upstream Deployments
+`````````````````````````````````````````````
+
+Scenarios and Deploy Settings for Upstream Deployments
+``````````````````````````````````````````````````````
+
+Including Upstream Patches with Deployment
+``````````````````````````````````````````
+
+Running
+```````
+
+Interacting with Containerized Overcloud
+````````````````````````````````````````
+
+Verifying the Setup
+===================
+
+OpenStack Verification
+======================
+
+Developer Guide and Troubleshooting
+===================================
+
+Utilization of Images
+---------------------
+
+Post-deployment Configuration
+-----------------------------
+
+OpenDaylight Integration
+------------------------
+
+Debugging Failures
+------------------
+
+Reporting a Bug
+---------------
+
+Uninstall Guide
+===============
+
+Troubleshooting
+===============
+
+Error Message Guide
+-------------------
+
+Maintenance
+===========
+
+Frequently Asked Questions
+==========================
+
+License
+=======
+
+References
+==========
+
+Definitions, acronyms and abbreviations
+=======================================

diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
new file mode 100644 (file)
index 0000000..304a634
--- /dev/null
+++ b/docs/release/release-notes/index.rst
@@ -0,0 +1,10 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Akraino Project, Inc. and its contributors
+
+.. _iec-releasenotes:
+
+.. toctree::
+   :maxdepth: 2
+
+   release-notes.rst

diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
new file mode 100644 (file)
index 0000000..d30b06d
--- /dev/null
+++ b/docs/release/release-notes/release-notes.rst
@@ -0,0 +1,49 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Akraino Project, Inc. and its contributors
+
+********************************************
+Akraino Release Notes for the IEC Blue Print
+********************************************
+
+Summary
+=======
+
+Release Data
+============
+
+Version change
+--------------
+
+Module version changes
+``````````````````````
+
+Document Version Changes
+````````````````````````
+
+Deliverable
+-----------
+
+Software Deliverable
+````````````````````
+
+Documentation Deliverable
+`````````````````````````
+
+Fixed Issues and Bugs
+`````````````````````
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+------------------
+
+Known Issues
+------------
+
+Workarounds
+-----------
+
+References
+==========

diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644 (file)
index 0000000..2945246
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,11 @@
+##############################################################################
+# Copyright (c) 2019 Linux Foundation and others.
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+lfdocs-conf
+# Uncomment the following line if your project uses Sphinx to document
+# HTTP APIs
+# sphinxcontrib-httpdomain

diff --git a/tox.ini b/tox.ini
new file mode 100644 (file)
index 0000000..f2f331f
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,24 @@
+##############################################################################
+# Copyright (c) 2019 Linux Foundation and others.
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+[tox]
+minversion = 1.6
+envlist =
+    docs,
+    docs-linkcheck
+skipsdist = true
+
+[testenv:docs]
+deps = -rdocs/requirements.txt
+commands =
+    sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+    echo "Generated docs available in {toxinidir}/docs/_build/html"
+whitelist_externals = echo
+
+[testenv:docs-linkcheck]
+deps = -rdocs/requirements.txt
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck