diff --git a/index.md b/index.md index c846c91b..c56a5261 100644 --- a/index.md +++ b/index.md @@ -1 +1,2 @@ -Index +# ONLP +[ONLP Documentation] {{ site.baseurl }}{% link onlp/index.md %} diff --git a/onlp/applications.md b/onlp/applications.md new file mode 100644 index 00000000..1f560992 --- /dev/null +++ b/onlp/applications.md @@ -0,0 +1 @@ +Applications diff --git a/onlp/implementors.md b/onlp/implementors.md new file mode 100644 index 00000000..865f2b93 --- /dev/null +++ b/onlp/implementors.md @@ -0,0 +1 @@ +Implementors diff --git a/onlp/index.md b/onlp/index.md new file mode 100644 index 00000000..17910306 --- /dev/null +++ b/onlp/index.md @@ -0,0 +1,12 @@ +# ONLP Overview + +The Open Network Linux Platform APIs provide a common, consistent abstraction interface for accessing important platform assets such as SFPs, PSUs, Fans, Thermals, LEDs, and ONIE TLV storage devices. + +All Open Networking platforms contain some subset of these objects but the programming requirements to access them are highly dependent upon the hardware design and knowledge thereof. +The goal of the ONLP APIs is to both standardize access to these objects at a functional level for system applications and provide a common implementation framework for hardware developers. + +## ONLP APIs For Applications + +The ONLP API documentation for Application, System, and Dataplane developers is available [here]({{ site.baseurl }}{% link onlp/applications.md %} + +The ONLP API documentation for Platform developers who which to implement support for their platform is available [here]({{ site.baseurl }}{% link onlp/implementors.md %}