Add Release Notes Doc Framework
[bottlenecks.git] / docs / releasenotes / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) Huawei Technologies Co.,Ltd and others.
4
5
6 ============================================
7 OPNFV Colorado Release Notes for Bottlenecks
8 ============================================
9
10 .. _Bottlenecks: https://wiki.opnfv.org/display/bottlenecks
11
12
13 Abstract
14 ========
15
16 This document describes the release notes of Bottlenecks project.
17
18
19 License
20 =======
21
22 OPNFV Colorado release notes for Bottlenecks Docs
23 are licensed under a Creative Commons Attribution 4.0 International License.
24 You should have received a copy of the license along with this.
25 If not, see <http://creativecommons.org/licenses/by/4.0/>.
26
27 The *Bottlenecks software* is opensource software, licensed under the terms of the
28 Apache License, Version 2.0.
29
30
31 Version History
32 ===============
33
34 +----------------+--------------------+---------------------------------+
35 | *Date*         | *Version*          | *Comment*                       |
36 |                |                    |                                 |
37 +----------------+--------------------+---------------------------------+
38 | Sept 22nd, 2016|  1.0               | Bottlenecks for Colorado release|
39 |                |                    |                                 |
40 +----------------+--------------------+---------------------------------+
41
42
43 Summary
44 =======
45
46 * Documentation generated with Sphinx
47
48   * User guide
49
50   * Installation Procedure
51
52   * Release Notes (this document)
53
54   * Platform Overview
55
56   * Configuration Guide
57
58 * Bottlenecks test suite
59
60   * Jenkins Jobs for OPNFV community labs
61
62 * Bottlenecks framework
63
64 * Bottlenecks test cases
65
66 The *Bottlenecks software* is developed in the OPNFV community, by the
67 Bottlenecks_ team.
68
69 Release Data
70 ============
71
72 +--------------------------------------+--------------------------------------+
73 | **Project**                          | Bottlenecks                          |
74 |                                      |                                      |
75 +--------------------------------------+--------------------------------------+
76 | **Repo/tag**                         | Bottlenecks/colorado.1.0             |
77 |                                      |                                      |
78 +--------------------------------------+--------------------------------------+
79 | **Bottlenecks Docker image tag**     | colorado.1.0                         |
80 |                                      |                                      |
81 +--------------------------------------+--------------------------------------+
82 | **Release designation**              | Colorado base release                |
83 |                                      |                                      |
84 +--------------------------------------+--------------------------------------+
85 | **Release date**                     | September 22 2016                    |
86 |                                      |                                      |
87 +--------------------------------------+--------------------------------------+
88 | **Purpose of the delivery**          | Colorado base release                |
89 |                                      |                                      |
90 +--------------------------------------+--------------------------------------+
91
92
93 Deliverables
94 ============
95
96 Software Deliverables
97 ---------------------
98
99 **Bottlenecks source code <colorado.1.0>**
100
101 * TODO
102
103 Documentatiion Deliverables
104 ---------------------------
105
106 **Bottlenecks documentation <colorado.1.0>**
107
108 * TODO
109
110 Reason for Version
111 ==================
112
113 * TODO
114
115
116 Colorado known restrictions/issues
117 ==================================
118
119 * TODO
120
121
122 Test results
123 ============
124
125 Test results are available in:
126
127  - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
128
129
130 Open JIRA tickets
131 =================
132
133 +------------------+-----------------------------------------------+
134 |   JIRA           |         Description                           |
135 +==================+===============================================+
136 +------------------+-----------------------------------------------+
137 +------------------+-----------------------------------------------+
138 +------------------+-----------------------------------------------+
139 +------------------+-----------------------------------------------+
140 +------------------+-----------------------------------------------+
141
142
143 Useful links
144 ============
145
146  - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
147
148  - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
149
150  - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
151
152  - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
153
154  - Bottlenecks IRC chanel: #opnfv-bottlenecks
155
156