chore(documentation): #915 fix documentation

eclipse-tractusx · Jun 26, 2024 · 852f07c · 852f07c
1 parent 0d3c04f
commit 852f07c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git 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
@@ -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.