Discovery Service (BPN Finder) Release 23.12 Documentation Acceptance Criteria

[kelaja]

Release Documentation 23.12

Source in Catena-X Confluence and Expert Contacts here (Source only accessible for Catena-X Consortia members in current transition phase).

• Source Code QG checks (Release 23.12) sldt-bpn-discovery#53

  • Code is centrally managed in Eclipse Tractus-X repository.
  • All active and relevant Release Guidelines are fulfilled (with confirmation by DevSecOps SystemTeam).

  Artefact Repo:

  • Eclipse Tractus-X
  • FOSS Infopage(Source only accessible for Catena-X Consortia members in current transition phase)

  Best Practice

  • Consult the regular office hours as early as possible; expect optimization loops based on feedback.

  Contact:

  • DevSecOps System Team - @FaGru3n

• Architecture Documents

  • Arc42 documentation completed for relevant product version.
  • In MarkDown format. Link to document available. Must point to leading repository within Tractus-X. Process the JIRA ticket and schedule an appointment with Expert to obtain approval prior to Gate review.
  • Provide link to documentation as early as possible and mark changes to previous version (if applicable); expect optimization loops based on feedback.

  Artefact Repo:

  • GitHub Readme how-to (Source only accessible for Catena-X Consortia members in current transition phase)

  Contact:

  • SYSTEM ARCHITECT

• Administrator`s Guide (User assistance)

  • Admin Guide is available with the software at the same time
  • Admin Guide is correct and up to date; english is a must
  • The documentation is of appropriate maturity for any Operating Company with global business practice intentions.
  • In MarkDown format. Link to document available. Must point to leading repository within Tractus-X.

  Best Practice:

  • Process the issue and schedule an appointment with SYSTEM ARCHITECT to obtain approval prior to Gate review.
  • Provide link to documentation as early as possible and mark changes to previous version (if applicable); expect optimization loops based on feedback.
  • User assistance ensures that for example administrators get all the information they need to accomplish their tasks with the software. Refer to a administration guide, which covers "install/deploy, configure the software" – as appropriate for the type of software and the information needs of the target group(s)
  • UI text and embedded help complete the User assistance.

  Contact:

  • SYSTEM ARCHITECT

• End-User Manual (User assistance)

  • End-User Manual is available with the software at the same time
  • End-User Manual is correct and up to date; english is a must
  • The documentation is of appropriate maturity to be handed over from the CX Consortia to any Operations Company with global business practice intentions.

  Best Practice:

  • Process the issue and schedule an appointment with SYSTEM ARCHITECT to obtain approval prior to Gate review.
  • Provide link to documentation as early as possible and mark changes to previous version (if applicable); expect optimization loops based on feedback.
  • User assistance ensures that end users and others get all the information they need to accomplish their tasks with the software. Refer to a user guide, which covers "install/deploy, configure, and use the software" – as appropriate for the type of software and the information needs of the target group(s)
  • UI text and embedded help complete the User assistance.

  Contact:

  • SYSTEM ARCHITECT

• Interfaces Documentation

  • API documentation contains all relevant interfaces for integration testing and is completed for relevant product version.
  • Link to document available.
  • Interface contract signed by all involved parties.

  Best Practice:

  • Process the issue and schedule an appointment with SYSTEM ARCHITECT to obtain approval prior to Gate review.
  • Provide link to documentation as early as possible and mark changes to previous version (if applicable); expect optimization loops based on feedback.
  • see Open APIs

  Contact:

  • SYSTEM ARCHITECT

• UX consistency Style Guideline for User Interfaces

  • Mandatory for FrontEnd modules where the IP is Open Source or owned by Catena-X.
  • User Interfaces are in line with the Catena-X Style Guidelines
    • user interface style review has been executed (review owner: SYSTEM ARCHITECT5 UX)
    • review feedback (if existing) got incorporated
    • all findings are assessed
    • all findings (high/very high) are fixed or cleaned up (evidence by re-review)
    • approval of the application CX Style conformity is available (given by the review owner)

  Best Practice:

  • Obtain approval from Style Guideline Owner, prior to Gate review
  • use issue, include app URL & TestUser, assign to SYSTEM ARCHITECT5, expect review loop
  • Style Components
  • LINK to Style Guideline (Source only accessible for Catena-X Consortia members in current transition phase)
  • LINK to FrontEnd validations (will be added asap)
  • Please note, you can use the official public available CX shared component library (react supported) to easily develop applications that are in-line with the CX style guidelines

[bs-sili]

SYSTEM ARCHITECT

• Architecture Documents:
  No changes since Release 23.09.
  MD files for arc42-documentation in Tractus-X repo:
  https://github.com/eclipse-tractusx/sldt-bpn-discovery/tree/main/docs

[bs-sili]

SYSTEM ARCHITECT

• Administrator`s Guide (User assistance):
  No changes since Release 23.09.
  MD files in Tractus-X repo:
  https://github.com/eclipse-tractusx/sldt-bpn-discovery/blob/main/README.md

[bs-sili]

SYSTEM ARCHITECT

• End-User Manual (User assistance):
  No changes since Release 23.09.
  End-user of the services is the developer who uses the API endpoints. Hence the swagger-ui of the service serves as the documentation.
  https://semantics.int.demo.catena-x.net/bpndiscovery/swagger-ui/index.html
  Also there is a detailed documentation available: https://github.com/eclipse-tractusx/sldt-bpn-discovery/tree/main/docs

[bs-sili]

SYSTEM ARCHITECT

• Interfaces Documentation:
  No changes since Release 23.09.
  Link to swagger UI documentation:
  https://semantics.int.demo.catena-x.net/bpndiscovery/swagger-ui/index.htm

[bs-sili]

• UX consistency:
  No changes since Release 23.09.
  N/A → no User Interface / no Frontend for this Service.

[jjeroch]

"UX consistency Style Guideline for User Interfaces" - n/a for the Discovery Service
@kelaja please update the status to "done" thanks!

[vialkoje]

documentation existing. expert approval granted.

[FaGru3n]

Hi all,

hi @kelaja try to open our QG-Gate Checklist for this product.

Could you be so kind to give us the following infromation? If someone in this round can also give a hint your welcome.

Product Owner:
Dev SPOC:
Repo within Eclipse Tractus-X:
Helm Chart Version:
App Version:

repo i guess: https://github.com/eclipse-tractusx/sldt-bpn-discovery

Thank you very much.

[FaGru3n]

hi all, QG Issue was updated some remaining PR's to approve/merge but on a good way 🏅 to the team.
eclipse-tractusx/sldt-bpn-discovery#53

[FaGru3n]

Source Code eclipse-tractusx/sldt-bpn-discovery#53 done and marked it as ready