openstack/nova-specs
Code Issues Proposed changes
Files
f1f7a9a154f0eb7f28c07ed51eaef702574ae030
nova-specs/specs/abandoned/index.rst
Eric Fried f1f7a9a154 Tools & docs for backlog & abandoned spec process 
Adds tooling and enhances README documentation around the backlog specs
process.

- To move a spec from the backlog to the current release, we can now use
  the ``move-spec`` tox target, e.g.

 tox -e move-spec -- [-n] [-v] specs/backlog/approved/great-idea.rst specs/train/approved

- To abandon a backlog spec - i.e. move it from specs/backlog/approved
  to the (new) specs/abandoned directory, we can now use the
  ``abandon-spec`` tox target, e.g.

 tox -e abandon-spec -- [-n] [-v] specs/backlog/it-was-a-great-idea.rst

These utilities will move the specified spec into the target directory
and create an appropriate redirect for it.

To make it so, this commit factors out a helper method that a) moves a
spec from one subdirectory to another and b) adds a redirect for it.
This is used by the existing ``move-implemented-specs`` utility as well
as the new ``move-spec`` and ``abandon-spec``.

While I was in here, I spruced up the verbose output (including for
move-implemented-specs) to be a bit more readable.

Change-Id: I322eecbacd5dc52accf6ac69c9fe1116be8c216f
2019-04-09 15:23:16 +00:00

864 B
Raw Blame History

Abandoned Specifications

This folder is for specs that were at some point approved, but we have since determined, for whatever reason, shall not be implemented.

For the time being, let's only use this for backlog specs, and leave unchanged the existing process for unimplemented specs in a real release (i.e. leave them there in the 'approved' directory).

To move a spec to this folder, use the abandon-spec tox target. In addition to moving the file, this ensures the proper redirect is created so any existing links in the wild are not broken.

For example, first do a dry run (-n) with verbose output (-v) to see what is going to happen:

tox -e abandon-spec -- -n -v specs/backlog/approved/it-was-a-great-idea.rst

When you are satisfied, remove the -n option to make it happen for real.