chore(documentation): #915 fix documentation

.github/workflows/publish-documentation.yaml

@@ -79,6 +79,7 @@ jobs:
           locale
           asciidoctor-reducer -o docs/target/adminguide.adoc docs/src/docs/administration/administration-guide.adoc
           asciidoctor-reducer -o docs/target/arc42.adoc docs/src/docs/arc42/full.adoc
+          asciidoctor-reducer -o docs/target/user-manual.adoc docs/src/docs/user/user-manual.adoc
 
       - name: Cache plantuml jar
         uses: actions/cache@v3
@@ -104,7 +105,7 @@ jobs:
         run: |
           npx downdoc -o docs/target/generated-docs/adminguide.md docs/src/diagram-replacer/generated-adocs/adminguide.adoc
           npx downdoc -o docs/target/generated-docs/arc42.md docs/src/diagram-replacer/generated-adocs/arc42.adoc
-          npx downdoc -o docs/target/generated-docs/user-manual.md docs/src/docs/user/user-manual.adoc
+          npx downdoc -o docs/target/generated-docs/user-manual.md docs/src/diagram-replacer/generated-adocs/user-manual.adoc
 
       - name: MD files post-processing
         working-directory: docs/src/post-processing/

docs/src/docs/arc42/trace-x-data-import-interface/data-import-interface.adoc

@@ -3,28 +3,17 @@
 Module 1
 [plantuml, target=modul1-sequence, format=svg]
 ....
-include::../../../uml-diagrams/arc42/trace-x-data-import-interface/trace-x-data-import-interface-modul1-sequence.puml[]
+include::../../../uml-diagrams/arc42/runtime-view/data-provisioning/trace-x-data-import-interface-modul1-sequence.puml[]
 ....
 
 Module 2
 [plantuml, target=modul2-sequence, format=svg]
 ....
-include::../../../uml-diagrams/arc42/trace-x-data-import-interface/trace-x-data-import-interface-modul2-sequence.puml[]
-....
-
-[plantuml, target=modul2-swimlane, format=svg]
-....
-include::../../../uml-diagrams/arc42/trace-x-data-import-interface/trace-x-data-import-interface-modul2-swimlane.puml[]
+include::../../../uml-diagrams/arc42/runtime-view/data-provisioning/trace-x-data-import-interface-modul2-sequence.puml[]
 ....
 
 Module 3
 [plantuml, target=modul3-sequence, format=svg]
 ....
-include::../../../uml-diagrams/arc42/trace-x-data-import-interface/trace-x-data-import-interface-modul3-sequence.puml[]
+include::../../../uml-diagrams/arc42/runtime-view/data-provisioning/trace-x-data-import-interface-modul3-sequence.puml[]
 ....
-
-[plantuml, target=modul3-swimlane, format=svg]
-....
-include::../../../uml-diagrams/arc42/trace-x-data-import-interface/trace-x-data-import-interface-modul3-swimlane.puml[]
-....
-

docs/src/docs/user/user-manual.adoc

@@ -6,12 +6,11 @@ This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LIC
 
 * SPDX-License-Identifier: Apache-2.0
 * Licence Path: https://creativecommons.org/licenses/by/4.0/legalcode
-* Copyright (c) 2021,2022,2023 Contributors to the Eclipse Foundation
+* Copyright (c) 2021, 2022, 2023 Contributors to the Eclipse Foundation
 * Copyright (c) 2022, 2023 ZF Friedrichshafen AG
 * Copyright (c) 2022 ISTOS GmbH
 * Copyright (c) 2022, 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
-* Copyright (c) 2022,2023 BOSCH AG
-
+* Copyright (c) 2022, 2023 BOSCH AG
 * Source URL: https://github.com/eclipse-tractusx/traceability-foss
 
 == General information
@@ -98,13 +97,26 @@ In the BPN-EDC configuration screen an admin user can add URLs for BPNs. Existin
 image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/user-manual/navigation/bpn_edc_configuration.png[]
 
 Any configured BPNs will have their URLs merged in addition to the URLs found by the DiscoveryService.
-The resulting list of URLs will be used whenever a notification is sent to those BPNs. In case an URL returns an error response, the remaining URLs will be used as backup.
+The resulting list of URLs will be used whenever a notification is sent to those BPNs. In case a URL returns an error response, the remaining URLs will be used as backup.
 
 [plantuml, target=bpn-edc-configuration, format=svg]
 ....
 include::../../uml-diagrams/user-manual/bpn-edc-configuration.puml[]
 ....
 
+|===
+|ID |Description
+
+|01
+|Any URLs configured for the selected BPN in the BPN-EDC configuration are requested.
+
+|02
+|Any URLs configured for the selected BPN in the DiscoveryFinder service are requested.
+
+|03
+|All received URLs are merged into one list with identical URLs discarded.
+|===
+
 ==== Contracts - view and export
 
 In the Contracts view an admin user can view contract agreements and sort them by the contract ID.
@@ -470,9 +482,9 @@ image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/
 === Quality notification create/edit view
 
 A quality notification can be started by the following options:
-- Part detail view if a part has child elements an quality notification with type INVESTIGATION can be created.
-- Part table if parts are selected an quality notification with type ALERT can be created.
-- Other parts table if parts are selected an quality notification with type INVESTIGATION can be created.
+- Part detail view if a part has child elements a quality notification with type INVESTIGATION can be created.
+- Part table if parts are selected a quality notification with type ALERT can be created.
+- Other parts table if parts are selected a quality notification with type INVESTIGATION can be created.
 
 A quality notification can be edited by clicking on the context menu on an item within the inbox.
 
@@ -481,7 +493,7 @@ image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/
 
 === Quality notifications context action
 
-Select the three dots icon on the right side of an quality notification entry to open the context menu.
+Select the three dots icon on the right side of a quality notification entry to open the context menu.
 From there it is possible to open the quality notification detailed view or change the status of it.
 Only the possible status transition will show up.
 

docs/src/uml-diagrams/user-manual/bpn-edc-configuration.puml

@@ -2,6 +2,7 @@
 skinparam monochrome true
 skinparam shadowing false
 skinparam defaultFontName "Architects daughter"
+autonumber "<B>[00]"
 
 title Receive EDC URLs
 participant "Trace-X" as TX
@@ -11,12 +12,15 @@ participant "DiscoveryFinder" as DF
 activate TX
 TX -> BEC: Look up URLs for configured BPN
 activate BEC
+autonumber stop
 BEC --> TX: URLs
 deactivate BEC
+autonumber resume
 TX -> DF: Look up URLs for configured BPN
 activate DF
+autonumber stop
 DF --> TX: URLs
 deactivate DF
+autonumber resume
 TX -> TX: Merge URLs into list (no duplicates)
-
 @enduml