Browse Source

Merge "Reorganize docs to fit openstackdocstheme"

Zuul 1 year ago
parent
commit
d06a992d18

+ 1
- 1
doc/source/conf.py View File

@@ -63,7 +63,7 @@ source_suffix = '.rst'
63 63
 master_doc = 'index'
64 64
 
65 65
 # General information about the project.
66
-project = u'Neutron Specs'
66
+project = u'Neutron Specifications'
67 67
 copyright = u'%s, OpenStack Neutron Team' % datetime.date.today().year
68 68
 
69 69
 # The language for content autogenerated by Sphinx. Refer to documentation

+ 21
- 128
doc/source/index.rst View File

@@ -4,147 +4,40 @@
4 4
 Neutron Project Specifications
5 5
 ==============================
6 6
 
7
-Rocky
8
-=====
7
+Specifications and RFEs
8
+=======================
9 9
 
10 10
 .. toctree::
11
-   :glob:
12
-   :maxdepth: 1
13
-
14
-   specs/rocky/*
15
-
16
-Queens
17
-======
18
-
19
-.. toctree::
20
-   :glob:
21
-   :maxdepth: 1
22
-
23
-   specs/queens/*
24
-
25
-Pike
26
-====
27
-
28
-.. toctree::
29
-   :glob:
30
-   :maxdepth: 1
31
-
32
-   specs/pike/*
33
-
34
-Ocata
35
-=====
36
-
37
-.. toctree::
38
-   :maxdepth: 1
39
-
40
-   Postmortem documentation <specs/ocata/postmortem/postmortem>
41
-
42
-.. toctree::
43
-   :glob:
44
-   :maxdepth: 1
45
-
46
-Newton
47
-======
48
-
49
-.. toctree::
50
-   :maxdepth: 1
51
-
52
-   Postmortem documentation <specs/newton/postmortem/postmortem>
53
-
54
-.. toctree::
55
-   :glob:
56
-   :maxdepth: 1
57
-
58
-   specs/newton/*
59
-
60
-Mitaka
61
-======
62
-
63
-.. toctree::
64
-   :maxdepth: 1
65
-
66
-   Postmortem documentation <specs/mitaka/postmortem/postmortem>
67
-
68
-.. toctree::
69
-   :glob:
70
-   :maxdepth: 1
71
-
72
-   specs/mitaka/*
73
-
74
-Liberty
75
-=======
76
-
77
-.. toctree::
78
-   :glob:
79
-   :maxdepth: 1
80
-
81
-   specs/liberty/*
82
-
83
-Kilo
84
-====
85
-
86
-.. toctree::
87
-   :glob:
88
-   :maxdepth: 1
89
-
90
-   specs/kilo/*
91
-
92
-Juno
93
-====
94
-
95
-.. toctree::
96
-   :glob:
97
-   :maxdepth: 1
98
-
99
-   specs/juno/*
100
-
101
-Backlog
102
-=======
103
-
104
-.. toctree::
105
-   :glob:
106
-   :maxdepth: 1
107
-
108
-   specs/backlog/**
109
-
110
-Stadium
111
-=======
112
-
113
-.. toctree::
114
-   :glob:
115
-   :maxdepth: 1
116
-
117
-   specs/stadium/*
118
-
119
-Queens
120
-------
121
-
122
-.. toctree::
123
-   :glob:
124
-   :maxdepth: 1
11
+   :maxdepth: 2
125 12
 
126
-   specs/stadium/queens/*
13
+   specs/rocky/index
14
+   specs/queens/index
15
+   specs/pike/index
16
+   specs/ocata/index
17
+   specs/newton/index
18
+   specs/mitaka/index
19
+   specs/liberty/index
20
+   specs/kilo/index
21
+   specs/juno/index
127 22
 
128
-Pike
129
-----
23
+Backlogs
24
+========
130 25
 
131 26
 .. toctree::
132 27
    :glob:
133
-   :maxdepth: 1
28
+   :maxdepth: 2
134 29
 
135
-   specs/stadium/pike/*
30
+   specs/backlog/index
136 31
 
137
-Ocata
138
------
32
+Stadium Health
33
+==============
139 34
 
140 35
 .. toctree::
141 36
    :glob:
142
-   :maxdepth: 1
37
+   :maxdepth: 2
143 38
 
144
-   specs/stadium/ocata/*
39
+   specs/stadium/index
145 40
 
146
-==================
147
-Indices and tables
148
-==================
41
+.. rubric:: Indices and tables
149 42
 
150 43
 * :ref:`search`

+ 9
- 0
specs/backlog/index.rst View File

@@ -0,0 +1,9 @@
1
+=======
2
+Backlog
3
+=======
4
+
5
+.. toctree::
6
+   :glob:
7
+   :maxdepth: 1
8
+
9
+   **

+ 9
- 0
specs/juno/index.rst View File

@@ -0,0 +1,9 @@
1
+====
2
+Juno
3
+====
4
+
5
+.. toctree::
6
+   :glob:
7
+   :maxdepth: 1
8
+
9
+   *

+ 9
- 0
specs/kilo/index.rst View File

@@ -0,0 +1,9 @@
1
+====
2
+Kilo
3
+====
4
+
5
+.. toctree::
6
+   :glob:
7
+   :maxdepth: 1
8
+
9
+   *

+ 9
- 0
specs/liberty/index.rst View File

@@ -0,0 +1,9 @@
1
+=======
2
+Liberty
3
+=======
4
+
5
+.. toctree::
6
+   :glob:
7
+   :maxdepth: 1
8
+
9
+   *

+ 14
- 0
specs/mitaka/index.rst View File

@@ -0,0 +1,14 @@
1
+======
2
+Mitaka
3
+======
4
+
5
+.. toctree::
6
+   :maxdepth: 1
7
+
8
+   [Postmortem] <postmortem/postmortem>
9
+
10
+.. toctree::
11
+   :glob:
12
+   :maxdepth: 1
13
+
14
+   *

+ 2
- 2
specs/mitaka/postmortem/postmortem.rst View File

@@ -4,8 +4,8 @@
4 4
 
5 5
  http://creativecommons.org/licenses/by/3.0/legalcode
6 6
 
7
-Postmortem documentation
8
-========================
7
+Mitaka Postmortem documentation
8
+===============================
9 9
 
10 10
 .. contents::
11 11
 

+ 14
- 0
specs/newton/index.rst View File

@@ -0,0 +1,14 @@
1
+======
2
+Newton
3
+======
4
+
5
+.. toctree::
6
+   :maxdepth: 1
7
+
8
+   [Postmortem] <postmortem/postmortem>
9
+
10
+.. toctree::
11
+   :glob:
12
+   :maxdepth: 1
13
+
14
+   *

+ 2
- 2
specs/newton/postmortem/postmortem.rst View File

@@ -4,8 +4,8 @@
4 4
 
5 5
  http://creativecommons.org/licenses/by/3.0/legalcode
6 6
 
7
-Postmortem documentation
8
-========================
7
+Newton Postmortem documentation
8
+===============================
9 9
 
10 10
 .. contents::
11 11
 

+ 8
- 0
specs/ocata/index.rst View File

@@ -0,0 +1,8 @@
1
+=====
2
+Ocata
3
+=====
4
+
5
+.. toctree::
6
+   :maxdepth: 1
7
+
8
+   [Postmortem] <postmortem/postmortem>

+ 2
- 2
specs/ocata/postmortem/postmortem.rst View File

@@ -4,8 +4,8 @@
4 4
 
5 5
  http://creativecommons.org/licenses/by/3.0/legalcode
6 6
 
7
-Postmortem documentation
8
-========================
7
+Ocata Postmortem documentation
8
+==============================
9 9
 
10 10
 .. contents::
11 11
 

+ 9
- 0
specs/pike/index.rst View File

@@ -0,0 +1,9 @@
1
+====
2
+Pike
3
+====
4
+
5
+.. toctree::
6
+   :glob:
7
+   :maxdepth: 1
8
+
9
+   *

+ 5
- 0
specs/queens/index.rst View File

@@ -0,0 +1,5 @@
1
+======
2
+Queens
3
+======
4
+
5
+No spec document landed.

+ 0
- 31
specs/queens/placeholder.rst View File

@@ -1,31 +0,0 @@
1
-..
2
- This work is licensed under a Creative Commons Attribution 3.0 Unported
3
- License.
4
-
5
- http://creativecommons.org/licenses/by/3.0/legalcode
6
-
7
-==================
8
-(Placeholder Spec)
9
-==================
10
-
11
-This file is just a placeholder for the specs directory.
12
-It will be removed soon after some spec is merged.
13
-
14
-The latest spec template is found at ``specs/template.rst``
15
-in the ``neutron-specs`` repository.
16
-
17
-Problem Description
18
-===================
19
-
20
-Sphinx toctree complains if no file exists in a directory
21
-specified in toctree glob.
22
-
23
-Proposed Change
24
-===============
25
-
26
-Add this file.
27
-
28
-References
29
-==========
30
-
31
-None.

+ 9
- 0
specs/rocky/index.rst View File

@@ -0,0 +1,9 @@
1
+=====
2
+Rocky
3
+=====
4
+
5
+.. toctree::
6
+   :glob:
7
+   :maxdepth: 1
8
+
9
+   *

+ 11
- 0
specs/stadium/index.rst View File

@@ -0,0 +1,11 @@
1
+==============
2
+Stadium Health
3
+==============
4
+
5
+.. toctree::
6
+   :glob:
7
+   :maxdepth: 1
8
+
9
+   Queens <queens/index>
10
+   Pike <pike/index>
11
+   Ocata <ocata/index>

specs/stadium/ocata.rst → specs/stadium/ocata/index.rst View File

@@ -37,14 +37,14 @@ that artifacts in the periodic output shows at least one successful run.
37 37
 Assessment
38 38
 ++++++++++
39 39
 
40
-  * networking-bagpipe: OK.
41
-  * networking-odl: OK.
42
-  * networking-bgpvpn: OK.
43
-  * networking-midonet: OK.
44
-  * neutron-dynamic-routing: OK.
45
-  * neutron-fwaas: OK.
46
-  * networking-ovn: OK.
47
-  * networking-sfc: OK.
40
+* networking-bagpipe: OK.
41
+* networking-odl: OK.
42
+* networking-bgpvpn: OK.
43
+* networking-midonet: OK.
44
+* neutron-dynamic-routing: OK.
45
+* neutron-fwaas: OK.
46
+* networking-ovn: OK.
47
+* networking-sfc: OK.
48 48
 
49 49
 .. _Docs:
50 50
 
@@ -67,14 +67,14 @@ notes for the latest release (Newton). Check for a working link to API reference
67 67
 Assessment
68 68
 ++++++++++
69 69
 
70
-  * networking-bagpipe: OK.
71
-  * networking-odl: OK.
72
-  * networking-bgpvpn: needs API documentation.
73
-  * networking-midonet: needs API documentation.
74
-  * neutron-dynamic-routing: needs API documentation.
75
-  * neutron-fwaas: OK.
76
-  * networking-ovn: OK.
77
-  * networking-sfc: needs API documentation.
70
+* networking-bagpipe: OK.
71
+* networking-odl: OK.
72
+* networking-bgpvpn: needs API documentation.
73
+* networking-midonet: needs API documentation.
74
+* neutron-dynamic-routing: needs API documentation.
75
+* neutron-fwaas: OK.
76
+* networking-ovn: OK.
77
+* networking-sfc: needs API documentation.
78 78
 
79 79
 .. _CI:
80 80
 
@@ -98,14 +98,14 @@ gating tempest tests. Check for scenario tests. Check for DB migration tests.
98 98
 Assessment
99 99
 ++++++++++
100 100
 
101
-  * networking-bagpipe: OK.
102
-  * networking-odl: OK.
103
-  * networking-bgpvpn: OK.
104
-  * networking-midonet: OK.
105
-  * neutron-dynamic-routing: needs scenario tests. Needs DB/sync validation.
106
-  * neutron-fwaas: OK.
107
-  * networking-ovn: OK.
108
-  * networking-sfc: OK.
101
+* networking-bagpipe: OK.
102
+* networking-odl: OK.
103
+* networking-bgpvpn: OK.
104
+* networking-midonet: OK.
105
+* neutron-dynamic-routing: needs scenario tests. Needs DB/sync validation.
106
+* neutron-fwaas: OK.
107
+* networking-ovn: OK.
108
+* networking-sfc: OK.
109 109
 
110 110
 .. _Release:
111 111
 
@@ -131,14 +131,14 @@ upper-constraints.
131 131
 Assessment
132 132
 ++++++++++
133 133
 
134
-  * networking-bagpipe: OK.
135
-  * networking-odl: OK.
136
-  * networking-bgpvpn: OK.
137
-  * networking-midonet: OK.
138
-  * neutron-dynamic-routing: OK.
139
-  * neutron-fwaas: OK.
140
-  * networking-ovn: OK.
141
-  * networking-sfc: OK.
134
+* networking-bagpipe: OK.
135
+* networking-odl: OK.
136
+* networking-bgpvpn: OK.
137
+* networking-midonet: OK.
138
+* neutron-dynamic-routing: OK.
139
+* neutron-fwaas: OK.
140
+* networking-ovn: OK.
141
+* networking-sfc: OK.
142 142
 
143 143
 .. _Maintenance:
144 144
 
@@ -159,14 +159,14 @@ to the right branch.
159 159
 Assessment
160 160
 ++++++++++
161 161
 
162
-  * networking-bagpipe: OK.
163
-  * networking-odl: OK.
164
-  * networking-bgpvpn: OK.
165
-  * networking-midonet: OK.
166
-  * neutron-dynamic-routing: OK.
167
-  * neutron-fwaas: OK.
168
-  * networking-ovn: OK.
169
-  * networking-sfc: OK.
162
+* networking-bagpipe: OK.
163
+* networking-odl: OK.
164
+* networking-bgpvpn: OK.
165
+* networking-midonet: OK.
166
+* neutron-dynamic-routing: OK.
167
+* neutron-fwaas: OK.
168
+* networking-ovn: OK.
169
+* networking-sfc: OK.
170 170
 
171 171
 .. _CLI:
172 172
 
@@ -186,14 +186,14 @@ Check for presence of OSC bindings in python-neutronclient.
186 186
 Assessment
187 187
 ++++++++++
188 188
 
189
-  * networking-bagpipe: N/A.
190
-  * networking-odl: N/A.
191
-  * networking-bgpvpn: needs porting to python-neutronclient.
192
-  * networking-midonet: needs porting to python-neutronclient.
193
-  * neutron-dynamic-routing: needs porting to python-neutronclient.
194
-  * neutron-fwaas: OK.
195
-  * networking-ovn: N/A.
196
-  * networking-sfc: needs porting to python-neutronclient.
189
+* networking-bagpipe: N/A.
190
+* networking-odl: N/A.
191
+* networking-bgpvpn: needs porting to python-neutronclient.
192
+* networking-midonet: needs porting to python-neutronclient.
193
+* neutron-dynamic-routing: needs porting to python-neutronclient.
194
+* neutron-fwaas: OK.
195
+* networking-ovn: N/A.
196
+* networking-sfc: needs porting to python-neutronclient.
197 197
 
198 198
 Summary
199 199
 =======
@@ -228,6 +228,15 @@ Summary
228 228
 
229 229
 (*) To re-apply for inclusion in Pike or future releases.
230 230
 
231
+Scorecards
232
+==========
233
+
234
+.. toctree::
235
+   :glob:
236
+   :maxdepth: 1
237
+
238
+   *
239
+
231 240
 How Reconcile API and client bindings
232 241
 =====================================
233 242
 

specs/stadium/pike.rst → specs/stadium/pike/index.rst View File

@@ -29,3 +29,12 @@ Summary
29 29
 +===================================================================+===============+===============+===============+===============+===============+===============+
30 30
 | `placeholder <./pike/placeholder.html>`_                          | TBD           | TBD           | TBD           | TBD           | TBD           | TBD           |
31 31
 +-------------------------------------------------------------------+---------------+---------------+---------------+---------------+---------------+---------------+
32
+
33
+Scorecards
34
+==========
35
+
36
+.. toctree::
37
+   :glob:
38
+   :maxdepth: 1
39
+
40
+   *

specs/stadium/queens.rst → specs/stadium/queens/index.rst View File

@@ -29,3 +29,12 @@ Summary
29 29
 +===================================================================+===============+===============+===============+===============+===============+===============+
30 30
 | `placeholder <./queens/placeholder.html>`_                        | TBD           | TBD           | TBD           | TBD           | TBD           | TBD           |
31 31
 +-------------------------------------------------------------------+---------------+---------------+---------------+---------------+---------------+---------------+
32
+
33
+Scorecards
34
+==========
35
+
36
+.. toctree::
37
+   :glob:
38
+   :maxdepth: 1
39
+
40
+   *

Loading…
Cancel
Save