summaryrefslogtreecommitdiffstats
path: root/docs/specs/README.rst
diff options
context:
space:
mode:
authorLi Xinhui <lxinhui@vmware.com>2018-01-22 13:38:40 +0800
committerLi Xinhui <lxinhui@vmware.com>2018-01-22 13:49:47 +0800
commit4afc7d3f14f44d3c4fa846883444b93fca86b8bd (patch)
tree39c76a1f0f282dcd7e7ee1756a6c11faec120357 /docs/specs/README.rst
parent2906f8863e3af3559a5ba288cbc2363f31c9f507 (diff)
Add specs directory for design discussion/review
This change is to add a new directory under docs to contain all design drafts. Issue-ID: MULTICLOUD-159 Signed-off-by: Xinhui Li <lxinhui@vmware.com> Change-Id: I91092f34c53579ea3752eb6150c1dbb6e5e117f7
Diffstat (limited to 'docs/specs/README.rst')
-rw-r--r--docs/specs/README.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/specs/README.rst b/docs/specs/README.rst
new file mode 100644
index 0000000..6429d1f
--- /dev/null
+++ b/docs/specs/README.rst
@@ -0,0 +1,28 @@
+INTRO
+=====
+
+This directory holds the proposals of non-trivial changes to multicloud. We host
+them here to avoid the potential headaches in managing yet another project,
+say `multicloud-specs`. When the needs rise up for a dedicated project for
+proposals, we can create such a project and migrate things here.
+
+
+DIRECTORY LAYOUT
+================
+
+Proposals will be put into this directory during review. After being reviewed,
+it will be migrated into the `rejected` subdirectory or the `approved`
+subdirectory respectively.
+
+
+rejected
+--------
+
+A subdirectory for proposals that were rejected.
+
+
+approved
+--------
+
+A subdirectory for proposals that were approved.
+