Hello Tractus-X Community,
As an IT Operations Manager that is responsible for the EDC and DTR at BMW I am regularly tasked with communicating changes to components that come with new releases to our end-users. When a new
release is out, we also analyze if we need to execute any migration task on our side before we deploy it.
Filtering those tasks and changes out of a changelog is tedious and error prone. Having a migration guide for every version that ships relevant changes helps a lot. The EDC (https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs/migration)
and the Portal (https://github.com/eclipse-tractusx/portal-assets/blob/v2.3.0/docs/admin/) already do that and they make our lives much easier.
I want to propose a TRG “migration guide” (https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/pull/1187)
to the community. I’m convinced that any DevOps Team will benefit from a migration guide for Tractus-X components – be it for core or enablement service providers, for data providers and consumers or for application providers.
A migration guide is not a duplicate of the changelog. The changelog might contain every single merged PR, most of which is irrelevant to the end-user or DevOps teams. It also contains bugfix
releases that don’t introduce change.
I’d appreciate your feedback in the PR if you also see value in migration guides, can present more examples and best practices or have proposals for better wording!
Kind regards
Felix