Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update documentation for R24.08 #518

Merged
merged 11 commits into from
Jul 25, 2024

Conversation

tom-rm-meyer-ISST
Copy link
Contributor

@tom-rm-meyer-ISST tom-rm-meyer-ISST commented Jul 24, 2024

Description

Prepare release:

  • Ensures next versions for frontend, backend, chart are set accordingly
  • Created Changelog
  • Added listing of supported standards in README.md
  • Update of Postman collection regarding jsonLd compaction in catalog requests (missed with TX EDC >= 0.7.2)

Updates following documentation:

  • Architecture Documentation updates of business related chapters
  • Notifications (Building Block View, Runtime View, User Guide)
  • Days of Supply (Building Block View)
  • ERP Adapter (Building Block View, Concepts)
  • Export of Swagger Documentation (erp adapter, days of supply, notifications, fixes)

Please note:

  • PR > 1kloc, but created by committer and mainly due to swagger docs
  • helm chart fails because helm version is already same version on main branch but unreleased.
  • kics found a lot smaller things in the swagger. Scanned that and going to dismiss it later in the security tab.

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

  • DEPENDENCIES are up-to-date. Dash license tool. Committers can open IP issues for restricted libs.
  • Copyright and license header are present on all affected files
  • If helm chart has been changed, the chart version has been bumped to either next major, minor or patch level (compared to released chart).

Copy link

@github-advanced-security github-advanced-security bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

KICS found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

@tom-rm-meyer-ISST tom-rm-meyer-ISST marked this pull request as ready for review July 25, 2024 12:57
Copy link
Member

@mhellmeier mhellmeier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. The failed pipelines are argued in the PR description.

@tom-rm-meyer-ISST tom-rm-meyer-ISST merged commit 8a8d518 into eclipse-tractusx:main Jul 25, 2024
12 of 13 checks passed
@tom-rm-meyer-ISST tom-rm-meyer-ISST deleted the docs/R24.08 branch July 25, 2024 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants