Reservation Developer's Guide Outline

This patch provides initial outline for the reservation project documentation.
Reservation provides augmentation for scheduling functionality that will be
usable by other projects.

Change-Id: I0a56d031a427a9d0d4e70bec986aeb5f0cc468e3
Signed-off-by: Mathieu Lemay <mlemay@inocybe.com>

diff --git a/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc b/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc
index cce45a0ce999f592ef635d8c78be432a5c4a7e9b..e7e84506c9bf30b2f490b666040042575b298a0a 100644 (file)
--- a/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc
+++ b/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc
@@ -78,6 +78,8 @@ include::pcmm.adoc[]
 
 include::plugin2oc.adoc[]
 
+include::reservation/reservation-dev.adoc[]
+
 include::sfc.adoc[]
 
 include::snbi.adoc[]

diff --git a/manuals/developer-guide/src/main/asciidoc/reservation/reservation-dev.adoc b/manuals/developer-guide/src/main/asciidoc/reservation/reservation-dev.adoc
new file mode 100644 (file)
index 0000000..060bdd2
--- /dev/null
+++ b/manuals/developer-guide/src/main/asciidoc/reservation/reservation-dev.adoc
@@ -0,0 +1,20 @@
+== Reservation Developer Guide
+
+=== Overview
+The Reservation Project provides a model extension that allows for realisation of 
+time based constraints in Intents or Policy work.
+
+NOTE: To be clear the target audience for this guide is a developer who
+will be _using_ the feature to build something separate, but _not_
+somebody who will be developing code for this feature itself.
+
+=== Reservation Project Architecture
+TODO: provide Reservation architecture when we have a better idea what the
+final (at least for Lithium) model will look like.
+
+=== Reservation Model
+TODO: Describe the agreed-upon model and the thus the generated APIs.
+
+=== API Reference Documentation
+TODO: Provide links to to how to get to the RESTCONF APIdoc and to the
+generated Javadoc from the YANG generated Java code.