Commit Graph

12 Commits

Author SHA1 Message Date
Adam Spiers a7d0871356 Remove spurious blank lines from templates
Clearly it doesn't make sense to have a blank line in the middle of a
paragraph.

Change-Id: I962c8abdd8a3e73291c5863bb2b4b96d458c58d0
Signed-off-by: Adam Spiers <aspiers@suse.com>
2016-06-28 12:08:02 +01:00
Sean Dague 4294a7b81d Update the testing part of the Template
Because of the way the testing part of the specs template is written
you basically get one of 3 throw away answers in the spec.

1) we'll have unit tests
2) we'll add tempest tests
3) we'll have 3rd party testing

However, the specs *rarely* actually talk about what's actually
important to test in the feature. Which means those are all kind of
throw away statements.

A much more useful piece of information is to ask what are the
critical scenarios to test for a feature. What's really important that
works. What's really important that it doesn't break something
else. What are some interesting edge cases we should be careful about.

This is an initial stab at that paragraph change. We should probably
wordsmith on it though.

Change-Id: I83a146a4561fac50fdd3bd961d16ff32cccbf4b9
2014-12-12 08:01:48 -05:00
Jenkins 6a4a1cf9ef Merge "Add notes on the level of detail required" 2014-11-12 19:03:30 +00:00
Jenkins a5f0deecfc Merge "Add note in template about asking for preliminary feedback" 2014-11-12 17:56:57 +00:00
John Garbutt 899947dda2 Add notes on the level of detail required
As discussed at the summit, we want to be clear on the level of detail
required in nova-specs.

Previously we had required so much detail that you ended up having to
write all the code upfront, defeating some of the original aims of
getting people to think about their designs upfront.

Change-Id: I03b32b4a98a0d5764ed3f3e8c80236e5dcc61055
2014-11-12 11:39:47 +00:00
Joe Gordon 4faa1fd656 Add note in template about asking for preliminary feedback
Allow people to post the first half of a spec to get feedback on the
problem statement and outline of the solution. If we don't think the
problem should be fixed in nova, then no point in making the author fill
out all the details about the fix.

Change-Id: Ic0aa4d870d8ab8c8c8b13246dba991a733ac21bd
2014-11-07 10:59:51 +01:00
Chris Yeoh 4f1fd861b0 Adds Kilo template back into toctree
We have previously published the kilo template here:
http://specs.openstack.org/openstack/nova-specs/specs/kilo-template.html
and have since updated it. But because we removed it from the toctree
it is not being updated on the website.

This change adds just the kilo template back into the toctree.

Change-Id: I8bdaef79439bf2f49a979c16de22c7aa6d7e2fcb
2014-10-30 16:15:13 +10:30
Chris Yeoh aa6c9541f3 Add requirement for APIImpact flag
Adds a requirement for an APIImpact flag in
the commit message for a proposed spec if it proposes
changes to the Nova REST API

Change-Id: Iab6df6bc2ba2505df981a6ce31ba5fac9737ad70
2014-10-22 09:53:11 +10:30
Joe Gordon 7fc42f2290 Add in concept of project priorities
* Add section in kilo-template about project priorities (with a link to
  the kilo priorities document)
* Add in kilo priorities page. Currently this list is empty and we hope
  to fill it out at the summit
* Add the yaml file of priority blueprints that are ready for review.
  This is where we will track which priority blueprints need review.

Change-Id: I339e88f8055a63a9a9423d997da6581f977428c9
2014-09-30 17:21:09 -07:00
Joe Gordon de3f7d6836 Explicitly require a Use Cases section for Kilo
We should put more stress on making it easy to figure out what the use
case is for every blueprint.  All blueprints should have a use case for
someone.

Related to: I7075a130c01be22f3ee5315d4a65b8e524b5a1ad

Change-Id: I7f378054b52488e6347304d3894868caa234b4fd
2014-09-30 13:47:16 -07:00
Joe Gordon ab6357a40b Add note in kilo-template about when a spec isn't required
Change-Id: I665021fd02ae978f055a0a36e893cf8a7b761f21
2014-09-30 11:50:42 -07:00
Joe Gordon cccb6a8dd3 Use Juno template as base for kilo template
Copy juno-template as kilo-template.rst  so we can iterate on the kilo
template.

Change-Id: Ia6d98c59db259949ff02a77c16e7c0ffb0096cb4
2014-09-30 11:43:19 -07:00