From b6bf1f1ff7680e89b5dd696de25b21a03fa06362 Mon Sep 17 00:00:00 2001 From: Colin Dixon Date: Fri, 20 Mar 2015 10:39:51 -0500 Subject: [PATCH] Documentation outline for NIC This assumes there is one feature in NIC and it is a developer-facing (not user-facing) YANG model. Change-Id: Iad5ee99550b7c9c9815b2733b099e495dca1d35a Signed-off-by: Colin Dixon --- .../main/asciidoc/bk-developers-guide.adoc | 2 ++ .../src/main/asciidoc/nic/nic-model-dev.adoc | 20 +++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 manuals/developer-guide/src/main/asciidoc/nic/nic-model-dev.adoc 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 e59ca6e79..3eb79798a 100644 --- a/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc +++ b/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc @@ -62,6 +62,8 @@ include::l2switch.adoc[] include::lispflow.adoc[] +include::nic/nic-model-dev.adoc[] + include::odlsdni.adoc[] include::openflowlibrary.adoc[] diff --git a/manuals/developer-guide/src/main/asciidoc/nic/nic-model-dev.adoc b/manuals/developer-guide/src/main/asciidoc/nic/nic-model-dev.adoc new file mode 100644 index 000000000..1abec09a1 --- /dev/null +++ b/manuals/developer-guide/src/main/asciidoc/nic/nic-model-dev.adoc @@ -0,0 +1,20 @@ +== NIC Model Developer Guide + +=== Overview +The NIC Model provides an abstract model for expressing the desired +state and operation of the network. + +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. + +=== NIC Model Architecture +TODO: provide NIC architecture when we have a better idea what the +final (at least for Lithium) model will look like. + +=== NIC Model API +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. -- 2.36.6