Migrate UMLet to PlantUML

score/mw/com/design/README.md

@@ -150,7 +150,7 @@ design
 are adjusted if source code is changed in the future.
 
 This comes with the drawback that we shall try to not place binary blobs into the repository.
-Thus, we decided to use [UMLet](https://www.umlet.com) for drawing any UML-related diagrams (it can be used on any OS).
+Thus, we decided to use [PlantUML](https://www.plantuml.com) for drawing any UML-related diagrams (it can be used on any OS).
 
 For graphics, we decided to only use SVGs.
 
@@ -182,13 +182,13 @@ visibility, i.e. an API that should be visible to the entire implementation name
 we use a pattern involving a friend class. In these cases, an `Example` class has a public API exposed to the end user,
 and one or both friend classes, named `ExampleView` and `ExampleMutableView`, will provide view or modification access,
 respectively, to the private members of the `ExampleClass`. We then restrict the visibility of these friend classes to
-the implementation namespace through an [AoU](broken_link_c/issue/5835119), which effectively
+the implementation namespace through an [AoU](#assumptions-of-use-aous), which effectively
 provides us with module-level encapsulation.
 Since this use of the `friend` keyword does not break encapsulation but provides us with a new kind of encapsulation
 that we need, we find that in spirit it does not contradict the guideline, and we deem such use as acceptable in
 `com::impl` namespace.
 
-## Assumptions of Use(AoUs)
+## Assumptions of Use (AoUs)
 
 A full list of AoUs can be seen [here](broken_link_c/issue/6221478). The following presents only a
 small selection.

score/mw/com/design/TODO.md

@@ -0,0 +1,7 @@
+TODOs:
+- [ ] Broken Links need to be cleaned up
+- [ ] AoU refers to a small selection in the design readme. But there is no content afterwards.
+- [ ] Configuration: Symphony (a BMW internal tool) is mentioned
+- [ ] ARXML is mentioned, will S-CORE depend on ARXML? I hope not.
+- [ ] Configuration: sequence_startup_view.puml is not referred to in the README.md
+- [ ] ipc_tracing: some links are not working to analysis api

score/mw/com/design/configuration/README.md

@@ -173,7 +173,7 @@ initialization from a default manifest or configuration path, an explicit user p
 a directly handed over JSON.
 The sequence during startup would look like this:
 
-<img src="broken_link_k/swh/ddad_score/mw/com/design/configuration/sequence_startup_view.uxf?ref=18c835c8d7b01056dd48f257c14f435795a48b7d" />
+<img src="https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/eclipse-score/communication/refs/heads/main/score/mw/com/design/configuration/sequence_startup_view.puml">
 
 During this call a singleton instance of `score::mw::com::impl::Runtime` gets created, which gets the parsed/validated
 configuration in the form of `score::mw::com::detail::Configuration`.
@@ -182,7 +182,6 @@ configuration in the form of `score::mw::com::detail::Configuration`.
 * one (`instanceInstances`), which holds the `ServiceInstanceDeployment`s, where the key is the `InstanceSpecifier`. The
   `ServiceInstanceDeployment`s refer to/depend on the `ServiceTypeDeployment`s.
 
-Details can
-be seen in the following class diagram:
+Details can be seen in the following class diagram:
 
-<img src="broken_link_k/swh/ddad_score/mw/com/design/configuration/structural_view.uxf?ref=18c835c8d7b01056dd48f257c14f435795a48b7d" />
+<img src="https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/eclipse-score/communication/refs/heads/main/score/mw/com/design/configuration/structural_view.puml">

score/mw/com/design/configuration/sequence_startup_view.puml

@@ -0,0 +1,61 @@
+@startuml
+'!include ../puml-theme-score.puml
+
+hide footbox
+
+participant "<u>:OS" as OS
+participant "<u>:Process</u>\nara::com User" as Process
+participant "<u>impl::Runtime:static:</u>" as Runtime
+participant "<u>impl::Runtime:SingletonInstance</u>" as RuntimeInstance
+participant "<u>:Configuration</u>" as Configuration
+participant "<u>:ConfigParser</u>" as ConfigParser
+
+activate OS
+create Process
+OS -> Process : create
+
+activate Runtime
+activate ConfigParser
+
+opt user wants to specify non-default manifest path
+    Process -> Runtime : Initialize(int argc, char** argv)
+    activate Process
+    deactivate OS
+
+    group config creation
+        note over Runtime, ConfigParser: sequence see below
+    end group
+
+    Runtime --> Process : return: void
+end opt
+
+Process -> Runtime : getInstance()
+
+opt config creation if singleton instance not yet created
+    Runtime -> Runtime : Initialize() //with default manifest path
+    Runtime -> ConfigParser : parse(path, const serviceTypeRegistry*)
+    create Configuration
+    ConfigParser -> Configuration : create()
+
+    ConfigParser --> Runtime : return: Configuration
+    deactivate ConfigParser
+
+    create RuntimeInstance
+    Runtime -> RuntimeInstance : create(configuration)
+end opt
+
+Runtime --> Process : return: singleton instance
+deactivate Runtime
+
+Process -> RuntimeInstance : resolve(InstanceSpecifier)
+activate RuntimeInstance
+RuntimeInstance -> Configuration : serviceInstances_.find(InstanceSpecifier)
+activate Configuration
+Configuration --> RuntimeInstance : return: Iter
+deactivate Configuration
+
+RuntimeInstance --> Process : return: InstanceIdentifierContainer
+deactivate RuntimeInstance
+deactivate Process
+
+@enduml