docs: Reorganise the documents

This commit is contained in:
Amin Ben Romdhane 2024-01-18 16:08:27 +01:00
parent f571d45304
commit a2ac63ce39
23 changed files with 23 additions and 22 deletions

View file

@ -31,7 +31,7 @@
```
- `bbfdmd` folder which contains the source code of bbfdm deamon.
More explanation on how this daemon works and all supported methods are presented in this file [BBFDMD](./docs/arch/bbfdmd.md)
More explanation on how this daemon works and all supported methods are presented in this file [BBFDMD](./docs/guide/bbfdmd.md)
- `libbbfdm` folder which contains the different data models supported by iopsys
@ -59,22 +59,22 @@ All supported tools are presented in this file[BBFDM Tools](./tools/README.md)
## Design
* [BBFDMD Design](./docs/arch/bbfdmd.md)
* [Datamodel extension using JSON plugin](./docs/guide/json_plugin_v1.md)
* [Datamodel Plugins and Microservice](./docs/guide/datamodel_as_microservice.md)
* [BBFDMD Design](./docs/guide/bbfdmd.md)
* [Datamodel extension using JSON plugin](./docs/guide/libbbfdm-api_json_plugin_v1.md)
* [Datamodel Plugins and Microservice](./docs/guide/libbbfdm-api_datamodel_as_microservice.md)
* [BBFDM Tools](./tools/README.md)
## Important Topics
* [Add support of a new Object/Parameter](./docs/guide/obj_param_extension.md)
* [How to add new vendor](./docs/guide/vendor.md)
* [Dynamic Object/Parameter/Operate/Event](./docs/guide/dynamic_dm.md)
* [Design for firmware activation](./docs/guide/FirmwareImage.md)
* [TR181 Firewall datamodel mappings](./docs/guide/firewall.md)
* [Wireless Configuration handling](./docs/guide/WiFi.DataElements.md)
* [Add support of a new Object/Parameter](./docs/guide/libbbfdm-api_obj_param_extension.md)
* [How to add new vendor](./docs/guide/libbbfdm-api_vendor.md)
* [Dynamic Object/Parameter/Operate/Event](./docs/guide/libbbfdm-api_dynamic_dm.md)
* [Design for firmware activation](./docs/guide/libbbfdm_DeviceInfo_FirmwareImage.md)
* [TR181 Firewall datamodel mappings](./docs/guide/libbbfdm_Firewall.md)
* [Wireless Configuration handling](./docs/guide/libbbfdm_WiFi.md)
* [Explain the different Network Deployment Scenarios](./docs/guide/network_depoyment_scenarios.md)
* [How to Configure MACVLAN](./docs/guide/macvlan_interface.md)
* [Explain Policy Based Routing Management](./docs/guide/policy_based_routing.md)
* [TR181 DNS datamodel](./docs/guide/device_dns.md)
* [How to Configure MACVLAN](./docs/guide/libbbfdm_Ethernet_X_IOPSYS_EU_MACVLAN.md)
* [Explain Policy Based Routing Management](./docs/guide/libbbfdm_Routing.md)
* [TR181 DNS datamodel](./docs/guide/libbbfdm_DNS.md)
## External dependencies for datamodel objects
@ -94,4 +94,6 @@ All supported tools are presented in this file[BBFDM Tools](./tools/README.md)
| Device.Users. | usermngr | https://dev.iopsys.eu/bbf/usermngr.git |
| Device.PeriodicStatistics. | periodicstats | https://dev.iopsys.eu/bbf/periodicstats.git |
| Device.SoftwareModules. | swmodd | https://dev.iopsys.eu/lcm/swmodd.git |
| Device.Time. | timemngr | https://dev.iopsys.eu/bbf/timemngr.git |
| Device.Hosts. | hostmngr | https://dev.iopsys.eu/iopsys/hostmngr.git |
| Device.Services.VoiceService. | tr104 | https://dev.iopsys.eu/voice/tr104.git |

View file

@ -133,7 +133,7 @@ Below is another example of json input file:
> NOTE1: `bbfdmd` CLI mode is an experimentation feature and it can be updated later.
> NOTE2: If `-m` option is not passed when starting `bbfdmd`, so configuration options will be loaded from the default [INPUT.JSON](../../json/input.json) located in '/etc/bbfdm/input.json'.
> NOTE2: If `-m` option is not passed when starting `bbfdmd`, so configuration options will be loaded from the default [INPUT.JSON](../../test/files/tmp/bbfdm/input.json) located in '/tmp/bbfdm/input.json'.
* To see the currently implemented data model use:
@ -164,10 +164,10 @@ $ bbfdmd -c set "parameter" "value"
## Important topics
* [UBUS methods](../guide/bbfdm_ubus_methods.md)
* [UBUS Errors](../guide/bbfdm_ubus_errors.md)
* [Parallel UBUS call](../guide/bbfdm_ubus_parallel_call.md)
* [Third party datamodel integration](../guide/bbfdm_dm_integration.md)
* [UBUS methods](bbfdmd_ubus_methods.md)
* [UBUS Errors](bbfdmd_ubus_errors.md)
* [Parallel UBUS call](bbfdmd_ubus_parallel_call.md)
* [Third party datamodel integration](bbfdmd_dm_integration.md)
## Dependencies

View file

@ -1 +0,0 @@
../../tools/README.md