summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAbraham Arce <abraham.arce.moreno@intel.com>2019-03-05 07:31:45 -0600
committerAbraham Arce <abraham.arce.moreno@intel.com>2019-03-05 07:31:45 -0600
commit12a404135343616138bdb16bdf730f81a070b6e5 (patch)
tree46c1b7339ff96b3360df5c4a607c12a7caa829d0
parent1bd070a63d6963d19d05d0d755db582b651a4cbc (diff)
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>
Notes
Notes (review): Code-Review+2: Ian Jolliffe <ian.jolliffe@windriver.com> Workflow+1: Ian Jolliffe <ian.jolliffe@windriver.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Thu, 14 Mar 2019 14:25:03 +0000 Reviewed-on: https://review.openstack.org/641124 Project: openstack/stx-specs Branch: refs/heads/master
-rw-r--r--specs/2019.03/approved/STX_Example_Spec.rst26
1 files changed, 13 insertions, 13 deletions
diff --git a/specs/2019.03/approved/STX_Example_Spec.rst b/specs/2019.03/approved/STX_Example_Spec.rst
index 2395c19..3b2f7a9 100644
--- a/specs/2019.03/approved/STX_Example_Spec.rst
+++ b/specs/2019.03/approved/STX_Example_Spec.rst
@@ -78,7 +78,7 @@ Problem description
78A detailed description of the problem. What problem is this spec addressing? 78A detailed description of the problem. What problem is this spec addressing?
79 79
80Use Cases 80Use Cases
81========= 81---------
82 82
83What use cases does this address? What impact on actors does this change have? 83What use cases does this address? What impact on actors does this change have?
84Ensure you are clear about the actors/personas in each use case: Developer, End 84Ensure 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
99on the scope of this spec. 99on the scope of this spec.
100 100
101Alternatives 101Alternatives
102============ 102------------
103 103
104What other ways could we do this thing? Why aren't we using those? This doesn't 104What other ways could we do this thing? Why aren't we using those? This doesn't
105have to be a full literature review, but it should demonstrate that thought has 105have to be a full literature review, but it should demonstrate that thought has
106been put into why the proposed solution is an appropriate one. 106been put into why the proposed solution is an appropriate one.
107 107
108Data model impact 108Data model impact
109================= 109-----------------
110 110
111Changes which require modifications to the data model often have a wider impact 111Changes which require modifications to the data model often have a wider impact
112on the system. The community often has strong opinions on how the data model 112on 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* How will the initial set of new data objects be generated. 124* How will the initial set of new data objects be generated.
125 125
126REST API impact 126REST API impact
127=============== 127---------------
128 128
129Each API method which is either added or changed should have the following 129Each 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
148user defined names is highly encouraged. 148user defined names is highly encouraged.
149 149
150Security impact 150Security impact
151=============== 151---------------
152 152
153Describe any potential security impact on the system. Some of the items to 153Describe any potential security impact on the system. Some of the items to
154consider include: 154consider include:
@@ -177,7 +177,7 @@ security best practices. For further information, feel free to reach out to the
177OpenStack Security Group at openstack-security@lists.openstack.org. 177OpenStack Security Group at openstack-security@lists.openstack.org.
178 178
179Other end user impact 179Other end user impact
180===================== 180---------------------
181 181
182Aside from the API, are there other ways a user will interact with this 182Aside from the API, are there other ways a user will interact with this
183feature? 183feature?
@@ -186,7 +186,7 @@ feature?
186 interface there look like? 186 interface there look like?
187 187
188Performance Impact 188Performance Impact
189================== 189------------------
190 190
191Describe any potential performance impact on the system, for example how often 191Describe any potential performance impact on the system, for example how often
192will new code be called, and is there a major change to the calling pattern of 192will 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 on holding the lock? 210 on holding the lock?
211 211
212Other deployer impact 212Other deployer impact
213===================== 213---------------------
214 214
215Discuss things that will affect how you deploy and configure OpenStack that 215Discuss things that will affect how you deploy and configure OpenStack that
216have not already been mentioned, such as: 216have not already been mentioned, such as:
@@ -230,12 +230,12 @@ have not already been mentioned, such as:
230 deployment technologies. 230 deployment technologies.
231 231
232Developer impact 232Developer impact
233================= 233----------------
234 234
235Discuss things that will affect other developers working on StarlingX. 235Discuss things that will affect other developers working on StarlingX.
236 236
237Upgrade impact 237Upgrade impact
238=============== 238--------------
239 239
240Describe any potential upgrade impact on the system, such as: 240Describe any potential upgrade impact on the system, such as:
241 241
@@ -251,7 +251,7 @@ Implementation
251============== 251==============
252 252
253Assignee(s) 253Assignee(s)
254=========== 254-----------
255 255
256Who is leading the writing of the code? Or is this a blueprint where you're 256Who is leading the writing of the code? Or is this a blueprint where you're
257throwing it out there to see who picks it up? 257throwing it out there to see who picks it up?
@@ -266,12 +266,12 @@ Other contributors:
266 <launchpad-id or None> 266 <launchpad-id or None>
267 267
268Repos Impacted 268Repos Impacted
269============== 269--------------
270 270
271List repositories in StarlingX that are impacted by this spec. 271List repositories in StarlingX that are impacted by this spec.
272 272
273Work Items 273Work Items
274=========== 274----------
275 275
276Work items or tasks -- break the feature up into the things that need to be 276Work items or tasks -- break the feature up into the things that need to be
277done to implement it. Those parts might end up being done by different people, 277done to implement it. Those parts might end up being done by different people,