From db0805d7833a27afc9a42edd094209978f43e311 Mon Sep 17 00:00:00 2001 From: Vivek Kumar Dutta <vivek.dutta@iopsys.eu> Date: Tue, 18 Apr 2023 18:24:21 +0530 Subject: [PATCH] Fix ref paths in docs --- README.md | 12 ++++++++---- docs/guide/ubus_methods.md | 4 ++-- mkdocs.yml | 2 +- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 16bf506..ef5674a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ # SWMODD -Software Module(`swmodd`) Daemon manages the lxc and OCI based containers(using liblxc and crun) and provides the Backend for Software Modules as defined in [USP](https://usp.technology/specification/index.pdf) and [CWMP](https://www.broadband-forum.org/technical/download/TR-069.pdf). +Software Module(`swmodd`) Daemon manages the lxc and OCI based containers(using liblxc and crun) and provides the Backend for Software Modules as defined in -TR181 data model parameters for [Device.SoftwareModules.](https://usp-data-models.broadband-forum.org/tr-181-2-15-1-usp.html#D.Device:2.Device.SoftwareModules.) exposed using bbf [DotSO Plugin](https://dev.iopsys.eu/iopsys/bbf/-/blob/devel/README.md). +- [USP](https://usp.technology/specification/index.pdf), and +- [CWMP](https://www.broadband-forum.org/technical/download/TR-069.pdf) + +TR181 data model parameter exposed using bbf [DotSO Plugin](https://dev.iopsys.eu/bbf/bbfdm/-/blob/devel/README.md). + +- [Device.SoftwareModules.](https://usp-data-models.broadband-forum.org/tr-181-2-15-1-usp.html#D.Device:2.Device.SoftwareModules.) It is written in C programming language and depends on a number of libraries of OpenWrt for building and running. @@ -75,9 +80,8 @@ In order to run the `swmodd`, following dependencies are needed to be running/av | Dependency | Link | License | | ---------- | --------------------------------------------- | ---------- | | ubusd | https://git.openwrt.org/project/ubus.git | LGPL 2.1 | -| bbf | https://dev.iopsys.eu/iopsys/bbf.git | LGPL 2.1 | +| bbfdm | https://dev.iopsys.eu/bbf/bbfdm.git | BSD-3 | | opkg | https://git.openwrt.org/project/opkg-lede.git | GPL-2.0 | -| uspd | https://dev.iopsys.eu/iopsys/uspd.git | GPL-2.0 | | libcurl | https://dl.uxnr.de/mirror/curl | MIT | | umoci | https://github.com/opencontainers/umoci.git | Apache-2.0 | | Skopeo | https://github.com/containers/skopeo.git | Apache-2.0 | diff --git a/docs/guide/ubus_methods.md b/docs/guide/ubus_methods.md index 1ad5eb7..dc4d42e 100644 --- a/docs/guide/ubus_methods.md +++ b/docs/guide/ubus_methods.md @@ -1,6 +1,6 @@ # swmodd uBus -`swmodd` must be launched on startup after `uspd`. It exposes the SoftwareModules datamodel objectes over ubus. The `swmodd` registers `swmodules` namespaces with ubus, that has the shown below functionalities: +It exposes the SoftwareModules datamodel objectes over ubus. The `swmodd` registers `swmodules` namespaces with ubus, that has the shown below functionalities: ```bash root@iopsys:~# ubus -v list swmodules @@ -17,7 +17,7 @@ root@iopsys:~# ubus -v list swmodules root@iopsys:~# ``` -For more info on the `swmodules` ubus schema see [link](../api/ubus/swmodules.md) or [raw schema](https://dev.iopsys.eu/iopsys/swmodd/-/tree/devel/schemas/ubus/swmodules.json) +For more info on the `swmodules` ubus schema see [link](../api/ubus/swmodules.md) or [raw schema](../../schemas/ubus/swmodules.json) ## swmodd ubus examples The outputs shown below are just an example, it can vary on each system. Long outputs are truncated to beautify the document. diff --git a/mkdocs.yml b/mkdocs.yml index 772e0ac..40a19ba 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: TR-x69 +site_name: TR-x69 SWMODD site_url: https://docs.iopsys.eu/lcm/swmodd edit_uri: "https://dev.iopsys.eu/lcm/swmodd" -- GitLab