From 8274c829863bf713687d7288bd21fc56ccad434b Mon Sep 17 00:00:00 2001 From: Christian Rehm Date: Wed, 26 Jun 2024 10:41:23 +0200 Subject: [PATCH 1/7] chore(documentation): #915 fix documentation --- .../data-import-interface.adoc | 17 +++-------------- docs/src/docs/user/user-manual.adoc | 15 ++++++++++++++- .../user-manual/bpn-edc-configuration.puml | 6 +++++- 3 files changed, 22 insertions(+), 16 deletions(-) diff --git a/docs/src/docs/arc42/trace-x-data-import-interface/data-import-interface.adoc b/docs/src/docs/arc42/trace-x-data-import-interface/data-import-interface.adoc index 1cd08d0ed0..c190cff68a 100644 --- a/docs/src/docs/arc42/trace-x-data-import-interface/data-import-interface.adoc +++ b/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[] -.... - diff --git a/docs/src/docs/user/user-manual.adoc b/docs/src/docs/user/user-manual.adoc index 00f0240ff8..db7a4bf024 100644 --- a/docs/src/docs/user/user-manual.adoc +++ b/docs/src/docs/user/user-manual.adoc @@ -98,13 +98,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. diff --git a/docs/src/uml-diagrams/user-manual/bpn-edc-configuration.puml b/docs/src/uml-diagrams/user-manual/bpn-edc-configuration.puml index 206fc07f88..d6b20cd37c 100644 --- a/docs/src/uml-diagrams/user-manual/bpn-edc-configuration.puml +++ b/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 "[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 From c0da2e58c56646dfd55d230f1b6b3693d03249e6 Mon Sep 17 00:00:00 2001 From: Christian Rehm Date: Wed, 26 Jun 2024 13:06:33 +0200 Subject: [PATCH 2/7] chore(documentation): #915 fix documentation --- docs/src/docs/user/user-manual.adoc | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/src/docs/user/user-manual.adoc b/docs/src/docs/user/user-manual.adoc index db7a4bf024..7868e8d139 100644 --- a/docs/src/docs/user/user-manual.adoc +++ b/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 @@ -101,9 +100,9 @@ Any configured BPNs will have their URLs merged in addition to the URLs found by 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 From 4b77862ef6f3b04dd80010cf92fea7787f36dc2c Mon Sep 17 00:00:00 2001 From: Christian Rehm Date: Wed, 26 Jun 2024 13:09:59 +0200 Subject: [PATCH 3/7] chore(documentation): #915 fix documentation --- docs/src/docs/user/user-manual.adoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/src/docs/user/user-manual.adoc b/docs/src/docs/user/user-manual.adoc index 7868e8d139..ca8199da1d 100644 --- a/docs/src/docs/user/user-manual.adoc +++ b/docs/src/docs/user/user-manual.adoc @@ -99,10 +99,12 @@ image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main 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 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 From 0d3c04f8ae6ac6506a864929c2ba682c81ccf969 Mon Sep 17 00:00:00 2001 From: Christian Rehm Date: Wed, 26 Jun 2024 13:33:02 +0200 Subject: [PATCH 4/7] chore(documentation): #915 fix documentation --- docs/src/docs/user/user-manual.adoc | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/src/docs/user/user-manual.adoc b/docs/src/docs/user/user-manual.adoc index ca8199da1d..ba4504038c 100644 --- a/docs/src/docs/user/user-manual.adoc +++ b/docs/src/docs/user/user-manual.adoc @@ -99,13 +99,6 @@ image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main 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 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 From 852f07c39b81f8bc6ee22a8ba91a15c70615dd5c Mon Sep 17 00:00:00 2001 From: Christian Rehm Date: Wed, 26 Jun 2024 13:48:21 +0200 Subject: [PATCH 5/7] chore(documentation): #915 fix documentation --- .github/workflows/publish-documentation.yaml | 1 + docs/src/docs/user/user-manual.adoc | 13 +++++++++---- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/workflows/publish-documentation.yaml b/.github/workflows/publish-documentation.yaml index 1416e3302b..63a7936121 100644 --- a/.github/workflows/publish-documentation.yaml +++ b/.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 + cp docs/src/docs/user/user-manual.adoc docs/target/ - name: Cache plantuml jar uses: actions/cache@v3 diff --git a/docs/src/docs/user/user-manual.adoc b/docs/src/docs/user/user-manual.adoc index ba4504038c..742513444b 100644 --- a/docs/src/docs/user/user-manual.adoc +++ b/docs/src/docs/user/user-manual.adoc @@ -99,6 +99,11 @@ image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main 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 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 @@ -477,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. @@ -488,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. From efef3810b08e58b30add9a1c97715eb64299c210 Mon Sep 17 00:00:00 2001 From: Christian Rehm Date: Wed, 26 Jun 2024 13:54:45 +0200 Subject: [PATCH 6/7] chore(documentation): #915 fix documentation --- .github/workflows/publish-documentation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-documentation.yaml b/.github/workflows/publish-documentation.yaml index 63a7936121..c88aa277b2 100644 --- a/.github/workflows/publish-documentation.yaml +++ b/.github/workflows/publish-documentation.yaml @@ -105,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/ From 5ac566975bec57f48f0fd34bbb59df241233959c Mon Sep 17 00:00:00 2001 From: Christian Rehm Date: Wed, 26 Jun 2024 14:47:25 +0200 Subject: [PATCH 7/7] chore(documentation): #915 fix documentation --- .github/workflows/publish-documentation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-documentation.yaml b/.github/workflows/publish-documentation.yaml index c88aa277b2..5970bfe6e0 100644 --- a/.github/workflows/publish-documentation.yaml +++ b/.github/workflows/publish-documentation.yaml @@ -79,7 +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 - cp docs/src/docs/user/user-manual.adoc docs/target/ + asciidoctor-reducer -o docs/target/user-manual.adoc docs/src/docs/user/user-manual.adoc - name: Cache plantuml jar uses: actions/cache@v3