From 2743139a36c6e0b84f5fc2ecff75c675be388811 Mon Sep 17 00:00:00 2001 From: sai-neetha Date: Fri, 12 Nov 2021 16:52:16 +0100 Subject: SDN-R readthedocs convert script and hyperlinks update SDN-R readthedocs convert script and hyperlinks update Issue-ID: CCSDK-3519 Signed-off-by: sai-neetha Change-Id: I34641f8182eec18e2a13865f75c927fad70a27ff --- .../src/main/resources/help/sdnr/connect/README.md | 2 +- .../main/resources/help/sdnr/networkMap/README.md | 2 +- sdnr/wt/readthedocs/convert.sh | 4 +-- sdnr/wt/readthedocs/src/home.rst | 31 ---------------------- sdnr/wt/readthedocs/src/index.rst | 12 --------- 5 files changed, 4 insertions(+), 47 deletions(-) delete mode 100644 sdnr/wt/readthedocs/src/home.rst delete mode 100644 sdnr/wt/readthedocs/src/index.rst (limited to 'sdnr/wt') diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/connect/README.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/connect/README.md index e15be5e5b..ac5bbe4f0 100644 --- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/connect/README.md +++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/connect/README.md @@ -12,7 +12,7 @@ Network Elements are physical network functions (PNFs). A table view shows all c Network Elements can be marked as 'required'. If an element is required, it will stay available even if disconnected. If an element is not required, it will be deleted once disconnected. -By right-clicking on an element, an action menu opens. The menu allows to mount, unmount, view the details, edit and remove the element. Additionally, it links to several applications like [Fault](../pnfFault/README.md) and [Configure](../pnfConfig/README.md), which will be filtered to display information relevant to the selected element. +By right-clicking on an element, an action menu opens. The menu allows to mount, unmount, view the details, edit and remove the element. Additionally, it links to several applications like [Fault](pnfFault.html) and [Configure](pnfConfig.html), which will be filtered to display information relevant to the selected element. ### Connection Status Log diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/networkMap/README.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/networkMap/README.md index 98d413529..b538eb1f6 100644 --- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/networkMap/README.md +++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/networkMap/README.md @@ -31,7 +31,7 @@ The details panel shows information specific to the selected element. Sites offer information about itself, such as name, address and owner, and a short overview of its links and nodes data. The nodes are physical network elements, comparable to the elements of the 'connect' application, and offer an interface to other apps via buttons, such as connect, configure, and fault. Currently, those buttons are disabled. By clicking on a link, the given link is loaded into details. -If a link of type 'microwave' is selected, the 'calculate link' button is available, which opens the [Link Calculator](../linkCalculator/README.md) in a new tab or page. +If a link of type 'microwave' is selected, the 'calculate link' button is available, which opens the [Link Calculator](linkCalculator.html) in a new tab or page. Just like the map, the details panel updates the URL if data is loaded. Once again, the 'Network Map' application will try to load the element specified in the URL, if one is present. diff --git a/sdnr/wt/readthedocs/convert.sh b/sdnr/wt/readthedocs/convert.sh index 435751eb6..f50abf330 100755 --- a/sdnr/wt/readthedocs/convert.sh +++ b/sdnr/wt/readthedocs/convert.sh @@ -23,8 +23,8 @@ for file in ${markdown_files[@]}; do pandoc -s --toc -f markdown -t rst $file > $PATH_DOC_USERDOC_DST"$rstfile" done -cp "$BASEDIR"sdnr/wt/readthedocs/src/home.rst "$PATH_DOC_USERDOC_DST" -cp "$BASEDIR"sdnr/wt/readthedocs/src/index.rst "$PATH_DOC_DST" +#cp "$BASEDIR"sdnr/wt/readthedocs/src/home.rst "$PATH_DOC_USERDOC_DST" +#cp "$BASEDIR"sdnr/wt/readthedocs/src/index.rst "$PATH_DOC_DST" #echo "================Creating html==========================================" #/usr/local/bin/sphinx-build -b html $PATH_DOC_DST /home/jack/public_html/sdnr-trial/ diff --git a/sdnr/wt/readthedocs/src/home.rst b/sdnr/wt/readthedocs/src/home.rst deleted file mode 100644 index 888572188..000000000 --- a/sdnr/wt/readthedocs/src/home.rst +++ /dev/null @@ -1,31 +0,0 @@ - -.. contents:: - :depth: 3 -.. - -SDN controller for 'Radio' (SDN-R) -================================== - -SDN-R adds features and functionality to the OpenDaylight-based ONAP -controller 'SDN-C'. It is built on the Common Controller Framework to -control and manage wireless resources. Wireless resources are virtual -network functions (e.g. vBBU, vEPC) or physical network functions (e.g. -microwave and millimeter wave radios, eNodeB, RRH, DAS equipment). - -| SDN-R is integrated into ONAP. Therefore it is interfacing with PNFs - and VNFs and with other ONAP components, such as A&AI, DCAE and SO. -| `See abbreviations `__ - -.. figure:: ./ONAP-SDN-R.png - :alt: SDN-R in ONAP - - SDN-R in ONAP - - -.. toctree:: - :maxdepth: 1 - - applications - installation - faq - abbreviations diff --git a/sdnr/wt/readthedocs/src/index.rst b/sdnr/wt/readthedocs/src/index.rst deleted file mode 100644 index 1da5c6c03..000000000 --- a/sdnr/wt/readthedocs/src/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -================= -SDN-R Online help -================= - -Below are the references for SDN-R User Documentation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - -.. toctree:: - :maxdepth: 1 - - guides/onap-user/home -- cgit 1.2.3-korg