Add repostory documentation

To ease navigation for users of GitHub, add README.rst to document where
things are in the repository. This includes a ton of stale links, which
will be filled in by future constributions.

Change-Id: I2d8945911aa91008ce4ca45b25dd8004eb6ed2c7
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..1054851
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,25 @@
+============================================
+OpenDaylight NETCONF/RESTCONF implementation
+============================================
+
+This project hosts implementations of protocols defined by the
+`IETF NETCONF Working Group <https://datatracker.ietf.org/wg/netconf/about/>`__
+In particular it implements:
+* `Network Configuration Protocol (NETCONF) <https://www.rfc-editor.org/rfc/rfc6241>`__
+* `RESTCONF Protocol <https://www.rfc-editor.org/rfc/rfc8040>`__
+
+Your immediate interests may be:
+* Documentation is in :doc:`docs <https://docs.opendaylight.org/projects/netconf/en/latest/index.html>`
+* Ready-to-applications are in :doc:`apps <apps/README.rst>`
+
+Other that that, you may delve into gory details:
+* basic project infrastructure, including :doc:`the BOM <artifacts/README.rst>`,
+  :doc:`Karaf features <features/README.rst>`, :doc:`Dynamic Karaf distribution <karaf/README.rst>`,
+  :doc:`Static Karaf distribution <karaf-static/README.rst>` and the :doc:`Common Maven Parent <parent/README.rst>`
+* :doc:`YANG models <models/README.rst>` relating to this project
+* :doc:`Transport layer <transport/README.rst>` implementation
+* :doc:`Low-level <protocol/README.rst>` protocol implementations
+* :doc:`High-level <plugins/README.rst>` protocol integrations
+* :doc:`NETCONF Key store <keystore/README.rst>` implementation
+* :doc:`NETCONF Trust store <truststore/READ.rst>` implementation
+* :doc:`applications <appls/README.rst>` for both end users and integrators

diff --git a/apps/README.rst b/apps/README.rst
new file mode 100644 (file)
index 0000000..23186e2
--- /dev/null
+++ b/apps/README.rst
@@ -0,0 +1,13 @@
+====================
+NETCONF applications
+====================
+
+This directory hosts the various applications built with NETCONF/RESTCONF
+:doc:`high-level <../plugins/README.rst>` integrations.
+
+This includes:
+* :doc:`NETCONF Events on top of MD-SAL <netconf-events-mdsal/README.rst>`
+* :doc:`CLI client <netconf-console/README.rst>` for NETCONF servers
+* :doc:`NETCONF ietf-topology.yang <netconf-topology/README.rst>` implementations
+  * for :doc:`single-node <netconf-topology-impl/README.rst>` deployments
+  * for :doc:`clustenered <netconf-topology-singleton/README.rst>` deployments

diff --git a/docs/index.rst b/docs/index.rst
index 75bfa0e84735a9f65b366866483fb6cf6ef5a134..9a6f60fe8b9f9b231bf560b21a6b82c54245f612 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,7 +1,7 @@
 .. _netconf:
 
 ##############################
-NETCONF/RESTCONF documentation
+NETCONF/RESTCONF Documentation
 ##############################
 
 .. toctree::