eclipse-tractusx/sig-release

Portal Release 23.12 Documentation Acceptance Criteria

Closed this issue · 15 comments

kelaja commented

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 eclipse-tractusx/portal#126
    eclipse-tractusx/portal-iam#33

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

    Artefact Repo:

    Best Practice

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

    Contact:

    • DevSecOps System Team

  • 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
jjeroch commented

UX approved; @kelaja please update the status

jjeroch commented

@vialkoje
Gateway 4 für Release 23.12. steht wieder an.
Kannst du einen Review der Docu machen?

Wichtige Info – final steht die Docu erst mit Q-Gate 5.
Aktueller Content ist zu 90% wie die Docu von 23.09.

Was wir noch vor haben: Doku erweitern und die IAM Docu in das IAM Repo umzuziehen. Gerade ist das etwas falsch geplaced. Das hattest du auch im 23.09. Review angemerkt.

Hier die Main Changes - Docus

vialkoje commented

Hi Julia, habe reingeschaut. Was mich etwas irritiert ist, dass wir die Dokumentationsstruktur bzgl:
Administrator's guide
End-User Manual
Architecture/Entwickler Doku (Arc42 Struktur)
Interface Doku

nicht direkt wiederfinde. Bisher hatte ich bei den reviews zu den geforderten Dokumenten jeweils einen Einstiegslink erhalten und konnte dann über das dokument schauen... blick ich es nicht ?!

evegufy commented

Source code

Latest released versions for 23.12:

Portal

Portal Chart: portal-1.7.0-RC3

Portal Frontend: v1.7.0-RC3

Portal Backend: v1.7.0-RC3

Portal Assets: v1.7.0-RC3

Portal Frontend Registration: v1.5.2

IAM

CentralIdP: centralidp-2.0.0-alpha

SharedIdP: sharedidp-2.0.0-alpha

Versions still expected as part of the testing phase (not yet released)

Portal

Portal Chart: portal-1.7.0-RC4

Portal Frontend: v1.7.0-RC4

Portal Backend: v1.7.0-RC4

Portal Assets: v1.7.0-RC4

Portal Frontend Registration: v1.5.3

Final 23.12 versions (not yet released)

Portal

Portal Chart: portal-1.7.0

Portal Frontend: v1.7.0

Portal Backend: v1.7.0

Portal Assets: v1.7.0

Portal Frontend Registration: v1.5.3

IAM

CentralIdP: centralidp-2.0.0

SharedIdP: sharedidp-2.0.0

vialkoje commented

Documentation for Architecture, Interface, User and Admin Doku approved

  • 👍1
carslen commented

When will final releases be available? Will start QG checks after release of final version to avoid double work.

Will do my QG checks in these issues:

carslen commented

When will the final version be released, @jjeroch ?

msinamci commented

Hi @carslen next week - I will give an update here

carslen commented

I thought due date for QG4 was yesterday, or at least today?! Waiting for final version to be released.

kelaja commented

@evegufy kindly see comments from @carslen

evegufy commented

@carslen our Q4 was already last week, so too early to even have the last release candidate version ready and the testing phase has even been prolonged to next week, so no chance to have the final version ready.
Also, I want to avoid patch versions for the input which is potentially coming from you, as your check is part of the QG process as well.
As per release schedule, the final versions will be available by Dec 8, 2023, including potential changes coming from your comments.
Please check the latest available versions here: #106 (comment)

  • 👍1
carslen commented

Source Code approved.

There are a few left over tickets in repositories with docker images as build artefacts regarding proper image tagging, which are agreed to be implemented until next release.

kelaja commented

all Done! Thanks guys! Congratulations for QG-Approval 🎉

  • 👍1
evegufy commented

@Siegfriedk for writing the changelog: those are the final released versions for 23.12:

Final 23.12 versions

Portal

Portal Chart: portal-1.7.0

Portal Frontend: v1.7.0

Portal Backend: v1.7.0

Portal Assets: v1.7.0

Portal Frontend Registration: v1.5.4

IAM

CentralIdP: centralidp-2.0.0

SharedIdP: sharedidp-2.0.0