kelaja commented 1 year ago

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).

[x] Source Code https://github.com/eclipse-tractusx/traceability-foss/issues/343
- 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
[x] 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
[x] 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
[x] 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
[x] 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
[x] 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