Commit Graph

9 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
Gábor Antal bc26fef9f6 Blueprints and specs link has been replaced
In mitaka-template.rst file, there is a link which forwards to
a slightly deprecated site about blueprints and specs.

In the current template [1] under
"Some notes about the nova-spec and blueprint process:"

there are several points, the first one is:
 * Not all blueprints need a spec. For more information see
   http://docs.openstack.org/developer/nova/devref/kilo.blueprints.html#when-is-a-blueprint-needed

This link refers to documentation of Kilo release, and
there is information about Juno and Kilo release, which may be misleading.

This link is being replaced with [2] which is
the current version of the blueprint document.

[1] https://github.com/openstack/nova-specs/blob/master/specs/mitaka-template.rst
[2] http://docs.openstack.org/developer/nova/blueprints.html

Change-Id: I2a178966b65f628d5752c5327aeda8b625f190ba
Closes-Bug: #1582783
2016-05-18 11:54:28 +02:00
Jenkins f63573f987 Merge "Fix path of jsonschema definitions" 2015-12-22 02:05:28 +00:00
Ken'ichi Ohmichi 28cfef8a9d Fix path of jsonschema definitions
The path of the jsonschema definitions has been changed already,
so this patch applies the change to the template file.

Change-Id: I2d9f0de3eb1506c70e57a8f094d9bb94cffd8954
2015-12-03 02:02:11 +00:00
Ken'ichi Ohmichi 254110bc67 Add a part of api-wg guideline
During nova-specs reviews, it is difficult to check all API changes
for following api-wg guideline because there is a lot of nova-specs
patches. There are some common mistakes against following guideline[1],
then this patch adds a part of the guideline to the template file for
avoiding these mistakes.

  REST API resource names
    * Resource names may include hyphens.
    * Resource names should not include underscores or other punctuation
      (sole exception is the hyphen).
  Fields in an API request or response body
    * Field names should use snake_case style, not CamelCase or MixedCase
      style.

[1]: https://github.com/openstack/api-wg/blob/master/guidelines/naming.rst

Change-Id: I20039ad1f7882cd5341431690b82dadab3cd1588
2015-12-03 01:59:02 +00:00
Sergey Nikitin cb97ec4871 Removed extra '-' from Mitaka spec template
TrivialFix
DocImpact

Change-Id: Ic75fa929b7cdc4c060525fe4929d8027fcdbf34a
2015-10-23 16:38:06 +03:00
Daniel P. Berrange d123172f6d template: remove "Project priority" section of spec
The "Project priority" section in the spec template is a source
of persistent confusion and mis-use. A large portion of spec
authors believe that it is a section to fill with their own
opinions on why their spec is important. In fact, pretty much
all specs should put the words "None" in this section. This is
particularly true earlier in the cycle, since the actual project
priorities do not get finalized / agreed on until the design
summit. Even once the priorities are agreed, this section of
the spec is still fairly pointless, since we've moved to tracking
priority specs in a separate etherpad. eg

  https://etherpad.openstack.org/p/mitaka-nova-priorities-tracking

Just remove this source of confusion since it doesn't serve any
particularly useful purpose anymore, given the external tracking
done.

Change-Id: I808227fe71210abc64270f53ef3d3d62f176ff24
2015-10-05 10:20:16 +01:00
Anne Gentle 4e66c184e3 Revises Documentation impact section in mitaka template
- Need to decouple "doc team" impact from doc impact.

Change-Id: I7c4cf6262270c1bac605fcad787b5de86a5c7c19
2015-09-17 11:08:27 +10:00
Matt Riedemann fb186d1038 Open specs for Mitaka
As discussed at the Liberty mid-cycle, we should open the Mitaka specs so
that people can start targeting changes, either new or deferrals from
Liberty.

Change-Id: I6fe26e5665dcfd4e1a7fc6c0f7b7a9532e825640
2015-07-23 13:42:01 -07:00