Skip to content
This repository has been archived by the owner on May 6, 2022. It is now read-only.

Add docs directory and skeleton documents for v1 #4

Merged
merged 1 commit into from
Sep 19, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions docs/v1/README.md
Original file line number Diff line number Diff line change
@@ -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)
Empty file added docs/v1/architecture.md
Empty file.
9 changes: 9 additions & 0 deletions docs/v1/use-cases.md
Original file line number Diff line number Diff line change
@@ -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>