diff --git a/docs/FAQ.md b/docs/FAQ.md index fefd125f6..b2a1fb5ab 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -64,8 +64,12 @@ The licensed software are not available on the software platform. But users have private workspaces which are based on Linux-based xfce Desktop environment. - Users can install software in their workspaces. The licensed software - installed by one user is not available to another user. + Users can install software in their workspaces. + Please see a + [screencast](FAQ/matlab-simulink.mp4) of using Matlab Simulink + within the DTaaS software. + The licensed software installed by one user is not available + to another user. ## Digital Twin Models diff --git a/docs/FAQ/matlab-simulink.mp4 b/docs/FAQ/matlab-simulink.mp4 new file mode 100755 index 000000000..075dc8173 Binary files /dev/null and b/docs/FAQ/matlab-simulink.mp4 differ diff --git a/docs/admin/servers/lib/LIB-MS.md b/docs/admin/servers/lib/LIB-MS.md index 2c57dbf94..3fa89dcec 100644 --- a/docs/admin/servers/lib/LIB-MS.md +++ b/docs/admin/servers/lib/LIB-MS.md @@ -24,25 +24,12 @@ There is a skeleton file structure in [DTaaS codebase](https://github.com/INTO-CPS-Association/DTaaS/tree/feature/distributed-demo/files). You can copy and create file system for your users. -## Gitlab setup (optional) - -For this microserivce to be functional, -a certain directory or gitlab project structure is expected. -The microservice expects that the gitlab consisting of one group, -DTaaS, and within that group, all of the projects be located, -**user1**, **user2**, ... , as well as a **commons** project. -Each project corresponds to files of one user. -A sample file structure can be seen in [gitlab dtaas group](https://gitlab.com/dtaas). -You can visit the gitlab documentation on [groups](https://docs.gitlab.com/ee/user/group/) -for help on the management of gitlab groups. - -You can clone the git repositories from the `dtaas` group -to get a sample file system structure for the lib microservice. - ## :arrow_down: Install The package is available in Github -[packages registry](https://github.com/orgs/INTO-CPS-Association/packages). +[packages registry](https://github.com/orgs/INTO-CPS-Association/packages) +and on +[npmjs](https://www.npmjs.com/package/@into-cps-association/libms). Set the registry and install the package with the one of the two following commands diff --git a/docs/bugs.md b/docs/bugs.md index 05cf102a9..dfb9be090 100644 --- a/docs/bugs.md +++ b/docs/bugs.md @@ -7,7 +7,7 @@ ### ML Workspace -- the docker container loses network connectivity after three days. +- the docker container slows down a bit after ten days. The only known solution is to restart the docker container. You don't need to restart the complete DTaaS platform, restart of the docker container of ml-workspace is sufficient. diff --git a/docs/developer/system/C4-L1_diagram.png b/docs/developer/system/C4-L1_diagram.png old mode 100644 new mode 100755 index 7191fd342..903ac582b Binary files a/docs/developer/system/C4-L1_diagram.png and b/docs/developer/system/C4-L1_diagram.png differ diff --git a/docs/developer/system/C4-L2_diagram_detailed.png b/docs/developer/system/C4-L2_diagram_detailed.png index 255c27a30..c91c9fd41 100755 Binary files a/docs/developer/system/C4-L2_diagram_detailed.png and b/docs/developer/system/C4-L2_diagram_detailed.png differ diff --git a/docs/developer/system/C4-L2_diagram_simplified.png b/docs/developer/system/C4-L2_diagram_simplified.png old mode 100644 new mode 100755 index 7c08ea9d4..d2ebd6ab5 Binary files a/docs/developer/system/C4-L2_diagram_simplified.png and b/docs/developer/system/C4-L2_diagram_simplified.png differ diff --git a/docs/developer/system/current-status-developer-2.png b/docs/developer/system/current-status-developer-2.png new file mode 100755 index 000000000..70349a7a0 Binary files /dev/null and b/docs/developer/system/current-status-developer-2.png differ diff --git a/docs/developer/system/current-status-developer.png b/docs/developer/system/current-status-developer.png index 199dbcc17..27512c20b 100755 Binary files a/docs/developer/system/current-status-developer.png and b/docs/developer/system/current-status-developer.png differ diff --git a/docs/developer/system/current-status.md b/docs/developer/system/current-status.md index e62059429..7086c9b24 100644 --- a/docs/developer/system/current-status.md +++ b/docs/developer/system/current-status.md @@ -7,6 +7,10 @@ The figure below shows the current status of the development work. ![Current development status](current-status-developer.png) +If you are interested in C4 representation of the same diagram, +please take a look at +the [C4 L2 diagram](current-status-developer-2.png). + ## :lock: User Security There is authentication mechanisms in place for the react website diff --git a/docs/index.md b/docs/index.md index 8b75d5a52..d971bdc57 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,11 +25,6 @@ This software is owned by [The INTO-CPS Association](https://into-cps.org/) and is available under [the INTO-CPS License](LICENSE.md). -The DTaaS software platform uses [Træfik](https://github.com/traefik/traefik), -[ML Workspace](https://github.com/ml-tooling/ml-workspace), -[Grafana](https://github.com/grafana/grafana), -[InfluxDB](https://github.com/influxdata/influxdb), -[MQTT](https://github.com/eclipse/mosquitto) and -[RabbitMQ](https://github.com/rabbitmq/rabbitmq-server) -open-source components. +The DTaaS software platform uses [third-party](./third-party.md) +open-source software. These software components have their own licenses. diff --git a/docs/user/website/digital_twins.png b/docs/user/website/digital_twins.png old mode 100644 new mode 100755 index 4085dde41..264e3c2fc Binary files a/docs/user/website/digital_twins.png and b/docs/user/website/digital_twins.png differ diff --git a/docs/user/website/gitlab-sso-1.png b/docs/user/website/gitlab-sso-1.png old mode 100644 new mode 100755 index 7e2c7790c..9dcc18943 Binary files a/docs/user/website/gitlab-sso-1.png and b/docs/user/website/gitlab-sso-1.png differ diff --git a/docs/user/website/gitlab-sso-2.png b/docs/user/website/gitlab-sso-2.png old mode 100644 new mode 100755 index 6b89c9a3e..8979028ec Binary files a/docs/user/website/gitlab-sso-2.png and b/docs/user/website/gitlab-sso-2.png differ diff --git a/docs/user/website/gitlab-sso-3.png b/docs/user/website/gitlab-sso-3.png old mode 100644 new mode 100755 index ec0338db8..e44dca11a Binary files a/docs/user/website/gitlab-sso-3.png and b/docs/user/website/gitlab-sso-3.png differ diff --git a/docs/user/website/index.md b/docs/user/website/index.md index bbfbf6d49..d3b046127 100644 --- a/docs/user/website/index.md +++ b/docs/user/website/index.md @@ -199,7 +199,8 @@ in new browser are: If you want terminal. Please use the tools dropdown in the Jupyter Notebook. The Terminal hyperlink does not always work reliably. If you want - terminal. Please use the tools dropdown in the Jupyter Notebook. + terminal, please use the tools dropdown in the Jupyter Notebook. + ![Open terminal in user workspace](../../admin/guides/open_terminal_in_workspace.gif) ## Finally logout diff --git a/docs/user/website/library.png b/docs/user/website/library.png old mode 100644 new mode 100755 index ac7b44d12..ff2618a51 Binary files a/docs/user/website/library.png and b/docs/user/website/library.png differ diff --git a/docs/user/website/login.png b/docs/user/website/login.png old mode 100644 new mode 100755 index 80cc54fe0..a7ab03a34 Binary files a/docs/user/website/login.png and b/docs/user/website/login.png differ diff --git a/docs/user/website/menu.png b/docs/user/website/menu.png old mode 100644 new mode 100755 index c13e10935..683c65a4d Binary files a/docs/user/website/menu.png and b/docs/user/website/menu.png differ diff --git a/docs/user/website/workbench.png b/docs/user/website/workbench.png old mode 100644 new mode 100755 index b7b4d53be..6ca739da0 Binary files a/docs/user/website/workbench.png and b/docs/user/website/workbench.png differ