2020-11-05: TR-106 Amendment 10

CHANGELOG.md

@@ -0,0 +1,58 @@
+# TR-106 Change Log
+
+*The latest TR-106 specification can be found at https://data-model-template.broadband-forum.org.*
+
+## 2020-11-05: [TR-106 Amendment 10](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.10.0)
+
+* Converted document to markdown
+* Various editorial improvements
+
+## 2019-09-04: [TR-106 Amendment 9](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.9.0)
+
+* Schema updates; document not updated
+
+## 2018-05-10: [TR-106 Amendment 8](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.8.0)
+
+* Added support of USP (mountable objects)
+* Removed references to obsolete data models
+* Moved device requirements to TR-069
+
+## 2014-09-17: [TR-106 Amendment 7+](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.7.0+)
+
+* Support file updates; document not updated
+
+## 2013-10-07: [TR-106 Amendment 7](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.7.0)
+
+* Added descriptions of new features in DM Schema (v1.4 & v1.5) and DT Schema (v1.2 & v1.3)
+* Added Annex defining additional requirements for BBF standard data models
+
+## 2011-07-01: [TR-106 Amendment 6](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.6.0)
+
+* Removed definition of proxying, now defined in TR-069
+* Removed Common objects
+* Alias Parameter Requirements added
+
+## 2010-11-01: [TR-106 Amendment 5](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.5.0)
+
+* Replaced definitions of named data types such as IPAddress with references to normative XML
+* Minor changes to DM Schema (v1.3) and DT Schema (v1.1)
+
+## 2010-11-01: [TR-106 Amendment 4](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.4.0)
+
+* Moved data model definitions to TR-181 Issue 1
+
+## 2010-02-01: [TR-106 Amendment 3](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.3.0)
+
+* Addition of device type XML Schema
+
+## 2008-11-01: [TR-106 Amendment 2](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.2.0)
+
+* Addition of data model definition XML Schema and normative XML common object and component definitions
+
+## 2006-11-01: [TR-106 Amendment 1](https://www.broadband-forum.org/technical/download/TR-106_Amendment-1.pdf)
+
+* Clarification of original document (link is to PDF)
+
+## 2005-09-01: TR-106 Amendment 0
+
+* Original (PDF no longer available)

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing to the TR-106 project
+
+Only [Broadband Forum](https://www.broadband-forum.org) members can contribute directly to this project. However, everyone is welcome to report bugs or add comments and suggestions by creating an issue or by emailing [email protected].

LICENSE

@@ -0,0 +1,40 @@
+Copyright (c) 2008-2020, Broadband Forum
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or
+without modification, are permitted provided that the following
+conditions are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above
+   copyright notice, this list of conditions and the following
+   disclaimer in the documentation and/or other materials
+   provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products
+   derived from this software without specific prior written
+   permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The above license is used as a license under copyright only.
+Please reference the Forum IPR Policy for patent licensing terms
+<https://www.broadband-forum.org/ipr-policy>.
+
+Any moral rights which are necessary to exercise under the above
+license grant are also deemed granted under this license.

README.md

@@ -1,6 +1,19 @@
-# WT-106
-Data Model Template for TR-069-Enabled Devices
+# TR-106 -- Data Model Template for CWMP Endpoints and USP Agents
 
-This repository contains WT-106 schemas, i.e. the DM (cwmp-datamodel)
-and DT (cwmp-devicetype) schemas, and their DMR (cwmp-datamodel-report)
-and DTF (cwmp-devicetype-features) friends.
+*The latest TR-106 specification can be found at https://data-model-template.broadband-forum.org.*
+
+TR-106 defines the [Broadband Forum](https://www.broadband-forum.org)'s [CWMP](https://www.broadband-forum.org/technical/download/TR-069.pdf) (TR-069) and [USP](https://usp.technology) (TR-369) data modeling framework, including:
+
+* Structural requirements for the data hierarchy
+* Requirements for versioning of data models
+* Requirements for defining profiles
+
+As part of this data modeling framework, TR-106 defines two XML Schemas:
+
+* The *Data Modeling (DM) Schema*, which is used for defining all CWMP and USP data models. This makes data model definitions rigorous, and helps to reduce the danger that different implementations will interpret data model definitions in different ways
+
+* The *Device Type (DT) Schema*, that allows a device to describe its supported CWMP data models. Note that USP uses a different mechanism (the `GetSupportedDM` message) for this purpose
+
+This repository contains [the above schemas](schemas), [support files](support) (e.g., common bibliographic references and data types), and the [TR-106 specification source](specification). The rendered GitHub Pages documentation can be found at https://data-model-template.broadband-forum.org.
+
+The TR-106 schemas and support files are also available at the [CWMP data models](https://cwmp-data-models.broadband-forum.org) and [USP data models](https://usp-data-models.broadband-forum.org). These sites present integrated views of the CWMP and USP versions of the standard data models, and provide a convenient way of viewing current and past versions of the schemas and support files in context.