Add readme.md 56/12956/1
authorJvD_Ericsson <jeff.van.dam@est.tech>
Tue, 11 Jun 2024 15:02:53 +0000 (16:02 +0100)
committerJeff van Dam <jeff.van.dam@est.tech>
Tue, 11 Jun 2024 15:05:24 +0000 (15:05 +0000)
Issue-ID: SMO-150
Change-Id: Ie58e787abf5b2363ac427aa06d7c78222a98185b
Signed-off-by: JvD_Ericsson <jeff.van.dam@est.tech>
README.md

index 738d5e3..447ec6d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,20 @@
-Initial ReadMe.
\ No newline at end of file
+# Topology & Inventory Overview
+
+Topology & Inventory manages the representation of topology and
+inventory resources in a suite of evolving vendor-agnostic data models
+to share and operate on a common view of the topology.
+
+# Introducing topology and inventory data
+
+Topology and inventory data is the information that represents entities
+in a telecommunications network and the relationships between them that
+provide insight into a particular aspect of the network of importance to
+specific use cases. Topology and inventory data can be derived from
+inventory, configuration, or other data. Topology & Inventory is being
+updated autonomously based on changes in the network.
+
+Topology & Inventory supports several topology and inventory domains,
+The understanding of the model is important to enable a user making
+queries on topology and inventory data. The entities are modeled as
+managed objects (found under the schema in the data dictionary) and
+grouped together in modules based on functionality.