From 24d01a135da622a6f3664e68eae56dca6e1bdb6d Mon Sep 17 00:00:00 2001 From: OleksandrZharov Date: Fri, 19 May 2023 18:12:09 +0200 Subject: [PATCH] Rework README to markdown .rst files are not parsed by GitHub thus for correct display of our README we should translate it into .md format. JIRA: NETCONF-1035 Change-Id: I0416dbd4ca22bd66a490a486c48f223cfe499a91 Signed-off-by: OleksandrZharov --- README.md | 21 +++++++++++++++++++++ README.rst | 25 ------------------------- apps/README.md | 10 ++++++++++ apps/README.rst | 13 ------------- 4 files changed, 31 insertions(+), 38 deletions(-) create mode 100644 README.md delete mode 100644 README.rst create mode 100644 apps/README.md delete mode 100644 apps/README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000000..ea85ecd1f3 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# 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 [docs](https://docs.opendaylight.org/projects/netconf/en/latest/index.html) +* Ready-to-applications are in [apps](apps/README.rst) + +Other that that, you may delve into gory details: +* basic project infrastructure, including [the BOM](artifacts/README.rst>), [Karaf features](features/README.rst), +[Dynamic Karaf distribution](karaf/README.rst), [Static Karaf distribution](karaf-static/README.rst) and the [Common Maven Parent](parent/README.rst) +* [YANG models](models/README.rst) relating to this project +* [Transport layer](transport/README.rst) implementation +* [Low-level](protocol/README.rst) protocol implementations +* [High-level](plugins/README.rst) protocol integrations +* [NETCONF Key store](keystore/README.rst) implementation +* [NETCONF Trust store](truststore/READ.rst) implementation +* [applications](apps/README.md) for both end users and integrators diff --git a/README.rst b/README.rst deleted file mode 100644 index 1054851e16..0000000000 --- a/README.rst +++ /dev/null @@ -1,25 +0,0 @@ -============================================ -OpenDaylight NETCONF/RESTCONF implementation -============================================ - -This project hosts implementations of protocols defined by the -`IETF NETCONF Working Group `__ -In particular it implements: -* `Network Configuration Protocol (NETCONF) `__ -* `RESTCONF Protocol `__ - -Your immediate interests may be: -* Documentation is in :doc:`docs ` -* Ready-to-applications are in :doc:`apps ` - -Other that that, you may delve into gory details: -* basic project infrastructure, including :doc:`the BOM `, - :doc:`Karaf features `, :doc:`Dynamic Karaf distribution `, - :doc:`Static Karaf distribution ` and the :doc:`Common Maven Parent ` -* :doc:`YANG models ` relating to this project -* :doc:`Transport layer ` implementation -* :doc:`Low-level ` protocol implementations -* :doc:`High-level ` protocol integrations -* :doc:`NETCONF Key store ` implementation -* :doc:`NETCONF Trust store ` implementation -* :doc:`applications ` for both end users and integrators diff --git a/apps/README.md b/apps/README.md new file mode 100644 index 0000000000..8605bfe3ac --- /dev/null +++ b/apps/README.md @@ -0,0 +1,10 @@ +# NETCONF applications + +This directory hosts the various applications built with NETCONF/RESTCONF [high-level](../plugins/README.rst) integrations. + +This includes: +* [NETCONF Events on top of MD-SAL](netconf-events-mdsal/README.rst) +* [CLI client](netconf-console/README.rst) for NETCONF servers +* [NETCONF ietf-topology.yang](netconf-topology/README.rst) implementations + * for [single-node](netconf-topology-impl/README.rst) deployments + * for [clustenered](netconf-topology-singleton/README.rst) deployments diff --git a/apps/README.rst b/apps/README.rst deleted file mode 100644 index 23186e2909..0000000000 --- a/apps/README.rst +++ /dev/null @@ -1,13 +0,0 @@ -==================== -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 ` -* :doc:`CLI client ` for NETCONF servers -* :doc:`NETCONF ietf-topology.yang ` implementations - * for :doc:`single-node ` deployments - * for :doc:`clustenered ` deployments -- 2.36.6