summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authoryuyang <Gabriel.yuyang@huawei.com>2016-09-22 05:34:28 +0800
committeryuyang <Gabriel.yuyang@huawei.com>2016-09-22 05:48:06 +0800
commit3ac496ac711f40f2a4c4fb0837758b4fbade43e4 (patch)
treeca0b7cea1cb042cfbc24e49792cf6ca634b3a690 /docs
parentd14f4c272cd900339c198a177ad9042fb03fab2d (diff)
Add Release Notes Doc Framework
JIRA: BOTTLENECK-88 Required by release meeting to add RN for Colorado 1.0. A framework of RN is updated and more details will be filled in Colorado 2.0. Change-Id: I386240d9b8c6d9cf30e68a12e3e84f1e09833d2a Signed-off-by: yuyang <Gabriel.yuyang@huawei.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/releasenotes/index.rst13
-rw-r--r--docs/releasenotes/release-notes.rst156
2 files changed, 169 insertions, 0 deletions
diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst
new file mode 100644
index 00000000..455cc95b
--- /dev/null
+++ b/docs/releasenotes/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Huawei Technologies Co.,Ltd and others.
+
+=========================
+Bottlenecks Release Notes
+=========================
+
+.. toctree::
+ :maxdepth: 2
+
+ release-notes
+
diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst
new file mode 100644
index 00000000..17238801
--- /dev/null
+++ b/docs/releasenotes/release-notes.rst
@@ -0,0 +1,156 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Huawei Technologies Co.,Ltd and others.
+
+
+============================================
+OPNFV Colorado Release Notes for Bottlenecks
+============================================
+
+.. _Bottlenecks: https://wiki.opnfv.org/display/bottlenecks
+
+
+Abstract
+========
+
+This document describes the release notes of Bottlenecks project.
+
+
+License
+=======
+
+OPNFV Colorado release notes for Bottlenecks Docs
+are licensed under a Creative Commons Attribution 4.0 International License.
+You should have received a copy of the license along with this.
+If not, see <http://creativecommons.org/licenses/by/4.0/>.
+
+The *Bottlenecks software* is opensource software, licensed under the terms of the
+Apache License, Version 2.0.
+
+
+Version History
+===============
+
++----------------+--------------------+---------------------------------+
+| *Date* | *Version* | *Comment* |
+| | | |
++----------------+--------------------+---------------------------------+
+| Sept 22nd, 2016| 1.0 | Bottlenecks for Colorado release|
+| | | |
++----------------+--------------------+---------------------------------+
+
+
+Summary
+=======
+
+* Documentation generated with Sphinx
+
+ * User guide
+
+ * Installation Procedure
+
+ * Release Notes (this document)
+
+ * Platform Overview
+
+ * Configuration Guide
+
+* Bottlenecks test suite
+
+ * Jenkins Jobs for OPNFV community labs
+
+* Bottlenecks framework
+
+* Bottlenecks test cases
+
+The *Bottlenecks software* is developed in the OPNFV community, by the
+Bottlenecks_ team.
+
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project** | Bottlenecks |
+| | |
++--------------------------------------+--------------------------------------+
+| **Repo/tag** | Bottlenecks/colorado.1.0 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Bottlenecks Docker image tag** | colorado.1.0 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release designation** | Colorado base release |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release date** | September 22 2016 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery** | Colorado base release |
+| | |
++--------------------------------------+--------------------------------------+
+
+
+Deliverables
+============
+
+Software Deliverables
+---------------------
+
+**Bottlenecks source code <colorado.1.0>**
+
+* TODO
+
+Documentatiion Deliverables
+---------------------------
+
+**Bottlenecks documentation <colorado.1.0>**
+
+* TODO
+
+Reason for Version
+==================
+
+* TODO
+
+
+Colorado known restrictions/issues
+==================================
+
+* TODO
+
+
+Test results
+============
+
+Test results are available in:
+
+ - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
+
+
+Open JIRA tickets
+=================
+
++------------------+-----------------------------------------------+
+| JIRA | Description |
++==================+===============================================+
++------------------+-----------------------------------------------+
++------------------+-----------------------------------------------+
++------------------+-----------------------------------------------+
++------------------+-----------------------------------------------+
++------------------+-----------------------------------------------+
+
+
+Useful links
+============
+
+ - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
+
+ - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
+
+ - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
+
+ - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
+
+ - Bottlenecks IRC chanel: #opnfv-bottlenecks
+
+