Browse Source

STX Example Spec: Sections

Reformat sections to comply with other existing specification
templates (e.g. OpenStack Nova [0]).

[0] https://specs.openstack.org/openstack/nova-specs/specs/train/template.html

Change-Id: I170244cc519a0573bf51c0ae06abdf65ac20aaf9
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
changes/24/641124/1
Abraham Arce 2 months ago
parent
commit
12a4041353
1 changed files with 13 additions and 13 deletions
  1. 13
    13
      specs/2019.03/approved/STX_Example_Spec.rst

+ 13
- 13
specs/2019.03/approved/STX_Example_Spec.rst View File

@@ -78,7 +78,7 @@ Problem description
78 78
 A detailed description of the problem. What problem is this spec addressing?
79 79
 
80 80
 Use Cases
81
-=========
81
+---------
82 82
 
83 83
 What use cases does this address? What impact on actors does this change have?
84 84
 Ensure you are clear about the actors/personas in each use case: Developer, End
@@ -99,14 +99,14 @@ get preliminary feedback. If so please say: Posting to get preliminary feedback
99 99
 on the scope of this spec.
100 100
 
101 101
 Alternatives
102
-============
102
+------------
103 103
 
104 104
 What other ways could we do this thing? Why aren't we using those? This doesn't
105 105
 have to be a full literature review, but it should demonstrate that thought has
106 106
 been put into why the proposed solution is an appropriate one.
107 107
 
108 108
 Data model impact
109
-=================
109
+-----------------
110 110
 
111 111
 Changes which require modifications to the data model often have a wider impact
112 112
 on the system. The community often has strong opinions on how the data model
@@ -124,7 +124,7 @@ Questions which need to be addressed by this section should include:
124 124
 * How will the initial set of new data objects be generated.
125 125
 
126 126
 REST API impact
127
-===============
127
+---------------
128 128
 
129 129
 Each API method which is either added or changed should have the following
130 130
 
@@ -148,7 +148,7 @@ Reuse of existing predefined parameter types such as regexps for passwords and
148 148
 user defined names is highly encouraged.
149 149
 
150 150
 Security impact
151
-===============
151
+---------------
152 152
 
153 153
 Describe any potential security impact on the system. Some of the items to
154 154
 consider include:
@@ -177,7 +177,7 @@ security best practices. For further information, feel free to reach out to the
177 177
 OpenStack Security Group at openstack-security@lists.openstack.org.
178 178
 
179 179
 Other end user impact
180
-=====================
180
+---------------------
181 181
 
182 182
 Aside from the API, are there other ways a user will interact with this
183 183
 feature?
@@ -186,7 +186,7 @@ feature?
186 186
   interface there look like?
187 187
 
188 188
 Performance Impact
189
-==================
189
+------------------
190 190
 
191 191
 Describe any potential performance impact on the system, for example how often
192 192
 will new code be called, and is there a major change to the calling pattern of
@@ -210,7 +210,7 @@ Examples of things to consider here include:
210 210
   on holding the lock?
211 211
 
212 212
 Other deployer impact
213
-=====================
213
+---------------------
214 214
 
215 215
 Discuss things that will affect how you deploy and configure OpenStack that
216 216
 have not already been mentioned, such as:
@@ -230,12 +230,12 @@ have not already been mentioned, such as:
230 230
   deployment technologies.
231 231
 
232 232
 Developer impact
233
-=================
233
+----------------
234 234
 
235 235
 Discuss things that will affect other developers working on StarlingX.
236 236
 
237 237
 Upgrade impact
238
-===============
238
+--------------
239 239
 
240 240
 Describe any potential upgrade impact on the system, such as:
241 241
 
@@ -251,7 +251,7 @@ Implementation
251 251
 ==============
252 252
 
253 253
 Assignee(s)
254
-===========
254
+-----------
255 255
 
256 256
 Who is leading the writing of the code? Or is this a blueprint where you're
257 257
 throwing it out there to see who picks it up?
@@ -266,12 +266,12 @@ Other contributors:
266 266
   <launchpad-id or None>
267 267
 
268 268
 Repos Impacted
269
-==============
269
+--------------
270 270
 
271 271
 List repositories in StarlingX that are impacted by this spec.
272 272
 
273 273
 Work Items
274
-===========
274
+----------
275 275
 
276 276
 Work items or tasks -- break the feature up into the things that need to be
277 277
 done to implement it. Those parts might end up being done by different people,

Loading…
Cancel
Save