Updates documentation to include correct C4 diagrams.

Adds screenshots of the new website. Minor updates to other parts of the documentation.
INTO-CPS-Association · Jan 16, 2024 · 5bb15df · 5bb15df
1 parent 4d70329
commit 5bb15df
Show file tree

Hide file tree

Showing 20 changed files with 18 additions and 27 deletions.
diff --git 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
diff --git 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
@@ -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
diff --git a/docs/developer/system/C4-L2_diagram_detailed.png b/docs/developer/system/C4-L2_diagram_detailed.png
diff --git a/docs/developer/system/C4-L2_diagram_simplified.png b/docs/developer/system/C4-L2_diagram_simplified.png
diff --git a/docs/developer/system/current-status-developer-2.png b/docs/developer/system/current-status-developer-2.png
diff --git a/docs/developer/system/current-status-developer.png b/docs/developer/system/current-status-developer.png
diff --git 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
@@ -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
diff --git a/docs/user/website/gitlab-sso-1.png b/docs/user/website/gitlab-sso-1.png
diff --git a/docs/user/website/gitlab-sso-2.png b/docs/user/website/gitlab-sso-2.png
diff --git a/docs/user/website/gitlab-sso-3.png b/docs/user/website/gitlab-sso-3.png
diff --git 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
diff --git a/docs/user/website/login.png b/docs/user/website/login.png
diff --git a/docs/user/website/menu.png b/docs/user/website/menu.png
diff --git a/docs/user/website/workbench.png b/docs/user/website/workbench.png