rally-openstack/doc/specs/template.rst
Boris Pavlovic 0538b6f845 Introduce in-tree Rally specs
Most of OpenStack projects have specs.
Specs are documents in .rst format with fixed structure.
They allow developers to use standard gerrit code review approach
to discuss and align future changes in project.

This patch includes:

- doc/specs directory
- doc/specs readme files
- spec template.rst
- unit tests that checks that specs are regarding template

Change-Id: I31e0dbb8bcbc68ca40c67c643d44b27359906b9c
2015-03-08 02:25:17 +03:00

2.5 KiB

The title of your Spec

Rally Road map:

https://docs.google.com/a/mirantis.com/spreadsheets/d/16DXpfbqvlzMFaqaXAcJsBzzpowb_XpymaK2aFY2gA2g/edit#gid=0

Introduction paragraph -- why are we doing anything?

Problem description

A detailed description of the problem.

Proposed change

Here is where you cover the change you propose to make in detail. How do you propose to solve this problem?

If this is one part of a larger effort make it clear where this piece ends. In other words, what's the scope of this effort?

Include where in the heat tree hierarchy this will reside.

Alternatives

This is an optional section, where it does apply we'd just like a demonstration that some thought has been put into why the proposed approach is the best one.

Implementation

Assignee(s)

Who is leading the writing of the code? Or is this a blueprint where you're throwing it out there to see who picks it up?

If more than one person is working on the implementation, please designate the primary author and contact.

Primary assignee:

<launchpad-id or None>

Can optionally can list additional ids if they intend on doing substantial implementation work on this blueprint.

Milestones

Target Milestone for completion:

Juno-1

Work Items

Work items or tasks -- break the feature up into the things that need to be done to implement it. Those parts might end up being done by different people, but we're mostly trying to understand the timeline for implementation.

Dependencies

  • Include specific references to specs and/or blueprints in heat, or in other projects, that this one either depends on or is related to.
  • Does this feature require any new library dependencies or code otherwise not included in OpenStack? Or does it depend on a specific version of library?