Browse Source

Merge "Update spec template"

Zuul 2 months ago
parent
commit
110ec01268
1 changed files with 25 additions and 20 deletions
  1. 25
    20
      template.rst

+ 25
- 20
template.rst View File

@@ -4,13 +4,13 @@
4 4
 
5 5
  http://creativecommons.org/licenses/by/3.0/legalcode
6 6
 
7
-=============================
8
- The title of your blueprint
9
-=============================
7
+==================
8
+Title of your Spec
9
+==================
10 10
 
11
-Include the URL of your launchpad RFE bug:
11
+Include the URL of your StoryBoard story (which should have an `rfe`` tag):
12 12
 
13
-https://bugs.launchpad.net/ironic-inspector/+bug/example-id
13
+https://storyboard.openstack.org/#!/story/XXXXXXX
14 14
 
15 15
 Introduction paragraph -- why are we doing anything?
16 16
 
@@ -20,24 +20,19 @@ Some notes about using this template:
20 20
 
21 21
 * Please wrap text at 79 columns.
22 22
 
23
-* The filename in the git repository must match the launchpad URL, for
24
-  example a URL of:
25
-  https://blueprints.launchpad.net/ironic-inspector/+spec/awesome-thing
26
-  must be named awesome-thing.rst
27
-
28
-* Please do not delete any of the sections in this template.  If you have
23
+* Please do not delete any of the sections in this template. If you have
29 24
   nothing to say for a whole section, just write: None
30 25
 
31
-* For help with syntax, see http://sphinx-doc.org/rest.html
26
+* For help with syntax, see http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
32 27
 
33 28
 * To test out your formatting, build the docs using tox, or see:
34 29
   http://rst.ninjs.org
35 30
 
36 31
 * If you would like to provide a diagram with your spec, ascii diagrams are
37
-  required.  http://asciiflow.com/ is a very nice tool to assist with making
38
-  ascii diagrams.  The reason for this is that the tool used to review specs is
39
-  based purely on plain text.  Plain text will allow review to proceed without
40
-  having to look at additional files which can not be viewed in gerrit.  It
32
+  required. http://asciiflow.com/ is a very nice tool to assist with making
33
+  ascii diagrams. The reason for this is that the tool used to review specs is
34
+  based purely on plain text. Plain text will allow review to proceed without
35
+  having to look at additional files which can not be viewed in gerrit. It
41 36
   will also allow inline feedback on the diagram itself.
42 37
 
43 38
 Problem description
@@ -73,7 +68,7 @@ Data model impact
73 68
 -----------------
74 69
 
75 70
 Changes which require modifications to the data model often have a wider impact
76
-on the system.  The community often has strong opinions on how the data model
71
+on the system. The community often has strong opinions on how the data model
77 72
 should be evolved, from both a functional and performance perspective. It is
78 73
 therefore important to capture and gain agreement as early as possible on any
79 74
 proposed changes to the data model.
@@ -158,6 +153,16 @@ Questions which need to be addressed in this section include:
158 153
 * If the change affects existing functionality, how will an upgrade be
159 154
   performed? How will it be tested?
160 155
 
156
+Ironic impact
157
+-------------
158
+
159
+If this change affects the ironic, please describe related changes here.
160
+
161
+Questions which need to be addressed in this section include:
162
+
163
+* What is the impact on the ironic, or the inspector inspect interface.
164
+
165
+
161 166
 Performance and scalability impact
162 167
 ----------------------------------
163 168
 
@@ -254,10 +259,10 @@ If more than one person is working on the implementation, please designate the
254 259
 primary author and contact.
255 260
 
256 261
 Primary assignee:
257
-  <launchpad-id or None>
262
+  <IRC handle, email address, or None>
258 263
 
259
-Can optionally can list additional ids if they intend on doing
260
-substantial implementation work on this blueprint.
264
+Other contributors:
265
+  <IRC handle, email address, None>
261 266
 
262 267
 Work Items
263 268
 ----------

Loading…
Cancel
Save