Merge pull request openshift#4 from pmorie/doc

Add docs directory and skeleton documents for v1
jpeeler · Sep 19, 2016 · d1b75e3 · d1b75e3
2 parents 4fc388b + f84180f
commit d1b75e3
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,10 @@
+## service-catalog docs
+
+This directory contains documentation for versions of the service-catalog:
+
+1.  Use-cases
+2.  Architecture summary documents
+
+Each version will get its own subdirectory.  Each version's documentation
+should be a complete accounting of supported use-cases, architecture, etc for
+that version.
diff --git a/docs/v1/README.md b/docs/v1/README.md
@@ -0,0 +1,7 @@
+## service-catalog v1 docs
+
+This directory contains design documents for the v1 version of `service-
+catalog`:
+
+- [Use cases](./use-cases.md)
+- [Architecture](./architecture.md)
diff --git a/docs/v1/architecture.md b/docs/v1/architecture.md
diff --git a/docs/v1/use-cases.md b/docs/v1/use-cases.md
@@ -0,0 +1,9 @@
+## service-catalog v1 use cases
+
+This document contains the complete list of accepted use-cases for the v1 version of `service-catalog`.
+
+## Use Cases
+
+The v1 service-catalog supports the following use cases:
+
+1. <TBD>